개런티 발급 신청

주문정보와 고객정보를 기준으로 디지털 개런티 발급을 요청합니다.

POST https://api.vircle.co.kr/v1/partner/:partnerId/guarantee

Path Parameters

Name	Type	Description
partnerId*	String	파트너 ID

Headers

Name	Type	Description
X-Vircle-API-Key*	String	파트너 API Key
Authorization*	String	파트너 API Secret

Request Body

Name	Type	Description
categoryCode	String	카테고리 (1: 가방, 2: 지갑, 3: 시계, 4: 의류, 5: 신발, 6: 액세서리, 7: 기타)
brandIdx	Number	브랜드 일련번호 (명품 브랜드 idx)
refOrderDetailId	String(50)	판매몰 참조 주문상세 일련번호
refOrderId*	String(50)	판매몰 참조 주문 일련번호
refUserId*	String(50)	판매몰 참조 사용자 일련번호 (또는 ID)
warrantyDate	String(500)	보증 기간
sellerAuthInfo	String(500)	판매자 검증 정보 (소개)
sellerName	String(250)	판매자명
ordererTel*	String(16)	주문자 휴대폰번호
ordererName*	String(30)	주문자명
productImages	String[]	상품 이미지 URL
modelNumber	String(250)	상품 모델번호
customFields	Object	추가필드 { "필드명1": "데이터", "필드명2": "데이터" }
size	String(100)	사이즈
weight	String(100)	중량
material	String(100)	소재
price*	Number	상품 금액
productName*	String(250)	상품명
inspectionIdx	Number	감정신청 일련번호 (선감정 신청 완료 후 수동발급 시)
refBrandCode	String(50)	판매몰 참조 브랜드 일련번호 (브랜드 코드 맵핑 필요)
refCategoryCode	String(50)	판매몰 참조 카테고리 일련번호 (카테고리 코드 맵핑 필요)
refProductCode	String(50)	판매몰 참조 상품 일련번호

200: OK 성공

{
  "idx": 6928,
  "status": "발급완료",
  "productName": "프라다 가죽 핸드백1",
  "refUserId": "woody",
  "refOrderId": "202301111550-1",
  "refOrderDetailId": "202301111550-1-2",
  "refProductCode": "P0001",
  "refCategoryCode": "C01",
  "refBrandCode": "B001",
  "registeredAt": "2023-01-16 19:53:02",
  "modifiedAt": null,
  "categoryCode": "1",
  "brandName": "프라다",
  "brandNameEn": "Prada",
  "price": 1250000,
  "modelNumber": "AAA12345",
  "productImages": [
    "https://static.vircle.co.kr/files/product/3888/68257436-b13d-46b9-9f1a-1b5e62db9a9d.jpg"
  ],
  "ordererName": "홍길동",
  "ordererTel": "01000000000",
  "sellerName": "판매자",
  "sellerAuthInfo": "본 판매자는 검증된 업체입니다.",
  "warrantyDate": "보증기간 5년, 가품 판정시 200% 보상",
  "guaranteeToken": "6adbc970ecf40baaa44d4e16b385b737e08f0aed8417e36c5c59e8252df33bd1",
  "nft": {
    "tokenId": 6928,
    "nftCardImg": "https://static.vircle.co.kr/files/nft/card/5105714f-f860-45d3-8846-3a461827876c.png",
    "externalLink": "https://app.vircle.co.kr/card/3888",
    "transactionHash": "0x46410186da41a0e7a9d8efad0d0d3656401cef9f85dbe55c4235af7c003b6cc7",
    "issuedAt": "2023-01-16 19:53:06"
  },
  "inspections": null
}

400: Bad Request 필수값 누락

{
    "code": "BAD_REQUEST_ERROR",
    "message": "요청 파라미터가 유효하지 않습니다. 세부 에러항목을 확인해주세요.",
    "errors": [
        {
            "value": "",
            "property": "productName",
            "children": [],
            "constraints": {
                "isNotEmpty": "productName should not be empty"
            }
        }
    ]
}

Request Example

Javascript

var myHeaders = new Headers();
myHeaders.append("X-Vircle-API-Key", {PARTNER-API-KEY});
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer {PARTNER-API-SECRET}");

var raw = JSON.stringify({
  "categoryCode": "1",
  "brandIdx": 699,
  "productName": "보증서 발급 테스트",
  "price": 1250000,
  "material": "가죽",
  "weight": "100g",
  "size": "Free",
  "customFields": {
    "추가필드1": "aaaaa",
    "추가필드2": "bbbbb"
  },
  "modelNumber": "AAA12345",
  "warrantyDate": "보증기간 5년, 가품 판정시 200% 보상",
  "productImages": [
    "https://static.vircle.co.kr/files/prod/8989510f-d14c-40ae-8ef7-1f0c7b05c972.jpg"
  ],
  "ordererName": "홍길동",
  "ordererTel": "01000000000",
  "sellerName": "매스어답션",
  "sellerAuthInfo": "검증된 업체입니다.",
  "refUserId": "woody",
  "refOrderId": "202301111550-1",
  "refOrderDetailId": "001",
  "refProductCode": "P0001",
  "refCategoryCode": "C01",
  "refBrandCode": "B001",
  "refEtcData1": "기타 상세 내용1",
  "refEtcData2": "기타 상세 내용2",
  "refEtcData3": "기타 상세 내용3"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.vircle.co.kr/v1/partner/{PARTNER-ID}/guarantee", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

cURL

curl --location 'http://api.vircle.co.kr/v1/partner/{PARTNER-ID}/guarantee' \
--header 'X-Vircle-API-Key: {PARTNER-API-KEY}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {PARTNER-API-SECRET}' \
--data '{
  "categoryCode": "1",
  "brandIdx": 699,
  "productName": "보증서 발급 테스트",
  "price": 1250000,
  "material": "가죽",
  "weight": "100g",
  "size": "Free",
  "customFields": {
    "추가필드1": "aaaaa",
    "추가필드2": "bbbbb"
  },
  "modelNumber": "AAA12345",
  "warrantyDate": "보증기간 5년, 가품 판정시 200% 보상",
  "productImages": [
    "https://static.vircle.co.kr/files/prod/8989510f-d14c-40ae-8ef7-1f0c7b05c972.jpg"
  ],
  "ordererName": "홍길동",
  "ordererTel": "01000000000",
  "sellerName": "매스어답션",
  "sellerAuthInfo": "검증된 업체입니다.",
  "refUserId": "woody",
  "refOrderId": "202301111550-1",
  "refOrderDetailId": "001",
  "refProductCode": "P0001",
  "refCategoryCode": "C01",
  "refBrandCode": "B001",
  "refEtcData1": "기타 상세 내용1",
  "refEtcData2": "기타 상세 내용2",
  "refEtcData3": "기타 상세 내용3"
}'