엔드포인트
배송 견적 요청
POST | https://api.iglobalstores.com/2.0/shipping-quotes - 수입 세금 및 세금과 항목 제한 사항 검사 정보를 포함하는 장바구니의 항목에 대한 배송 견적 요청을 새로 생성합니다.
HTTPS 요청
| 필드 | 비고 |
|---|---|
| HTTP 메서드 | POST |
| 엔드포인트 URL | https://api.iglobalstores.com/2.0/shipping-quotes |
| 프로토콜 | HTTPS |
| 메시지 형식 | JSON |
| 수신 HTTP 헤더 | Accept: application/json |
| 보안 토큰 HTTP 헤더 | serviceToken: your-test-token-valueHTTPS 요청에 serviceToken이라는 이름의 헤더를 추가하고, 값으로 테스트 보안 API 토큰을 입력하세요. (이 토큰은 귀하의 계정 관리자에게 문의하세요) |
| 콘텐츠 유형 HTTP 헤더 | Content-Type: application/json서비스에 JSON 데이터를 게시할 것이므로, HTTPS 요청에 Content-Type이라는 이름의 헤더를 추가하고, 값으로 application/json을 입력하세요 |
요청 본문의 JSON KEY/VALUE 쌍
메시지 형식: JSON
예시 요청
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"boxCount": null,
"items": [
{
"cartItemId": 1,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675234",
"sku": "oakley-123",
"unitPrice": 199.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
},
{
"cartItemId": 2,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675235",
"sku": "oakley-125",
"unitPrice": 179.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
}
],
"shippingAmountOverride": null,
"shipFromAddress": null,
"shipToAddress": {
"name": "John Doe",
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"state": "Alberta",
"stateCode": "AB",
"postalCode": "T2P 5G8",
"countryCode": "CA"
}
}
Request JSON 정의
| 필드 | 설명 |
|---|---|
boxCount | 이 필드는 주문을 배송하는 데 사용될 상자를 설명합니다. 상인의 경우 주문 시점에 이를 알 필요는 없지만, 알고 있다면 다음과 같은 특정 형식으로 전달할 수 있습니다.예시 값: 22x15x15(1),8x8x4(2),32x22x14(1)형식: 상자 크기와 개수를 쉼표로 구분한 목록. 위 예시에서는 총 4개의 상자가 있습니다. 목록의 첫 번째 상자는 길이 22인치, 너비 15인치, 높이 15인치입니다. 해당 크기의 상자는 하나만 사용됩니다. 크기 8x8x4인치의 상자는 두 개가 있습니다. 동일한 상자 크기를 여러 번 전달하는 것도 가능합니다. 예를 들어, “22x15x15(1),22x15x15(1)”는 크기 22x15x15인치의 상자 두 개를 의미합니다. |
items REQUIRED | 아이템 맵의 목록 |
items[index].brandName | 특정 아이템의 브랜드 이름은 규칙 엔진이 해당 아이템이 목적지 국가에 대한 제한이 있는지 가장 잘 판단할 수 있도록 도와줍니다. 아이템의 브랜드 이름이 특정 제한과 문자적으로 일치하든 일치하지 않든, 규칙 엔진은 아이템의 SKU 및/또는 productId를 사용하여 해당 아이템이 실제로 목적지 국가에 제한되는지 더 잘 결정할 수 있습니다. 가능하다면 브랜드 이름을 보내주세요.예시 값: “Oakley” 또는 “Nike” 또는 null |
items[index].cartItemId REQUIRED | 이 필드는 아이템을 목록 내에서 구체적으로 식별하기 위해 필요합니다. 인덱스 값처럼 간단할 수 있습니다. 우리는 이 cartItemId를 사용하여 JSON 응답에서 아이템이 제한되는지 식별할 것입니다. 따라서 이 cartItemId를 통해 장바구니에서 동일한 아이템을 식별할 수 있도록 하세요.예시 값: 1 또는 2 또는 3 |
items[index].category | 제품 카테고리 - 특정 제품이 속한 카테고리입니다. 카테고리는 규칙 엔진이 해당 아이템이 목적지 국가에 대한 제한이 있는지 가장 잘 판단할 수 있도록 도와줍니다. 아이템의 카테고리가 특정 제한과 문자적으로 일치하든 일치하지 않든, 규칙 엔진은 아이템의 SKU 및/또는 productId를 사용하여 해당 아이템이 실제로 목적지 국가에 제한되는지 더 잘 결정할 수 있습니다.형식: 카테고리 이름을 파이프로 구분한 목록. 각 카테고리 이름은 하나 이상의 단어일 수 있습니다. 아이템이 둘 이상의 카테고리에 속하는 경우, 파이프 “” 문자로 구분하여 모두 나열하세요.예시 값: “Sunglasses” 또는 “Evening AccessoriesHandbags” |
items[index].countryOfOrigin | 원산지는 품목이 제조되었거나 원래 온 국가입니다. 원산지는 규칙 엔진이 목적지 국가에 대해 품목에 제한이 적용되는지 여부를 가장 잘 판단하는 데 도움이 됩니다. 일부 국가는 특정 국가에서 특정 종류의 상품을 허용하지 않습니다. 예시 값: “CN”은 중국, “US”는 미국 또는 null |
items[index].detailedDescription 필수 | 이 필드는 단순한 텍스트이지만, 구매하는 품목에 대한 가능한 한 많은 정보를 포함해야 합니다. 예를 들어, 전체 이름과 품목 코드(해당되는 경우), 선택한 색상 또는 기타 옵션, 재료 내용 및 품목에 대한 설명 텍스트가 포함됩니다. 외국으로의 수입 제한에는 이탈리아로의 가죽 신발과 같은 다양한 유형이 있습니다. 때때로, 이러한 제한 품목을 포착하는 유일한 방법은 detailedDescription을 통해서입니다. 참고: 품목의 detailedDescription이 특정 제한과 텍스트적으로 일치하든지 않든지 간에, 규칙 엔진은 품목의 SKU 및/또는 productId를 사용하여 품목이 실제로 목적지 국가에 제한되는지 여부를 더 잘 판단합니다. 최상의 결과를 위해 detailedDescription 필드에 가능한 한 많은 정보를 제공해 주십시오. 예시 값: “Tory Burch, Robinson – Double Zip’ Tote, 색상: New Carnival, 재료 내용: 가죽, 색상이 풍부한 가죽이 깔끔하게 구조화된 토트백에 눈길을 끄는 매력을 더하며, 로고 하드웨어와 롤 핸들이 완전히 세련된 모습을 제공합니다. 이중 지퍼가 있는 자석 스냅 잠금 장치. 내부 지퍼, 벽 및 휴대폰 주머니. 보호 금속 발. 가죽. Tory Burch 제작; 수입.” |
items[index].height | 이것은 품목의 높이입니다. 이 측정을 위해 인치 또는 센티미터를 지정하는 dimensionalUnits라는 다른 필드가 있습니다. 쉼표 없이 제공하고 소수점 이하 두 자리까지 입력해 주십시오. 예시 값: 25.5 이 필드를 제공하면 배송 요금이 가장 정확해집니다. |
items[index].hsCode | 이것은 외국에서 품목을 식별하는 HS 코드입니다. hsCode를 전달하면 특정 품목에 대한 올바른 수입 세금 rate을 적절히 식별하는 데 도움이 됩니다. 사용 불가능한 경우 필수는 아니며, 없으시면 저희가 처리하겠습니다. 형식: 10자리 또는 6자리 코드; 구분 “.” 문자를 포함할 수도 있고 포함하지 않을 수도 있습니다. 예시 값: “20.4560.0000” 또는 “20.4560” 또는 “204560” (10자리 또는 6자리 코드 모두 허용됨) |
items[index].length | 이것은 품목의 길이입니다. 이 측정을 위해 인치 또는 센티미터를 지정하는 dimensionalUnits라는 다른 필드가 있습니다. 쉼표 없이 제공하고 소수점 이하 두 자리까지 입력해 주십시오. 예시 값: 25.5 이 필드를 제공하면 배송 요금이 가장 정확해집니다. |
items[index].productId | 이것은 특정 품목에 대한 제품 ID입니다. 규칙 엔진은 이 값을 ID로 사용하여 학습된 품목 정보를 귀하의 품목에 연결합니다. 예시 값: “17898-675235” 최소한 productID 또는 SKU를 전달해 주십시오. 두 가지 모두 전달하는 것이 바람직합니다. |
items[index].quantity 필수 | 이것은 특정 품목에 대해 구매하는 수량입니다. 쉼표 없이 양의 정수로 제공해 주십시오. 소수점 자리는 필요하지 않습니다. 예시 값: 1 또는 9999 (더 많은 품목을 판매하는 것을 선호합니다!) |
items[index].sku | 이것은 특정 품목에 대한 SKU입니다. 규칙 엔진은 이 값을 ID로 사용하여 학습된 품목 정보를 귀하의 품목에 연결합니다. 예시 값: “oakley-125” 최소한 productId 또는 SKU를 전달해 주십시오. 두 가지 모두 전달하는 것이 바람직합니다. |
items[index].unitPrice 필수 | 이것은 귀하의 품목의 단가입니다(USD, 미국 달러). 쉼표 없이, 달러 기호 “$” 없이, 소수점 이하 두 자리로 제공해 주십시오. 예시 값: 2102.99 |
items[index].weight | 이것은 귀하의 아이템 무게입니다. 이 측정을 위해 파운드, 온스, 그램 또는 킬로그램을 지정하는 weightUnits라는 다른 필드가 있습니다. 쉼표 없이 제공하고 소수점 이하 두 자리로 제한해 주십시오. 예시 값: 4.2 이 필드를 전달하면 배송 요금이 가장 정확해집니다. |
items[index].weightUnits | 기본값은 파운드에 대해 “LB”입니다. 무게 값의 측정 단위입니다. null로 설정하면 “LB” (파운드)로 간주됩니다. 예시 값: 파운드에 대해 “LB” 또는 온스에 대해 “OZ” 또는 그램에 대해 “G” 또는 킬로그램에 대해 “KG” 또는 null |
items[index].width | 이것은 귀하의 아이템 너비입니다. 이 측정을 위해 인치 또는 센티미터를 지정하는 dimensionalUnits라는 다른 필드가 있습니다. 쉼표 없이 제공하고 소수점 이하 두 자리로 제한해 주십시오. 예시 값: 25.5 이 필드를 전달하면 배송 요금이 가장 정확해집니다. |
shipFromAddress | null로 전달되면 귀하의 상인 계정과 연결된 기본 shipFromAddress를 사용합니다. 이것은 주문이 발송될 주소로, 즉 귀하의 창고입니다. 이 맵은 다음 주소 필드를 포함합니다: address1, address2, address3, city, state, stateCode, postalCode, countryCode. 이 포함된 필드는 국가에 따라 필수 또는 비필수입니다. 지역화 엔드포인트는 각 국가에 대해 어떤 특정 주소 필드가 필수인지 반환합니다. 참고: stateCode는 항상 필수가 아니며 지역화 엔드포인트에 선언되지 않습니다. 가능하다면 stateCode를 전달할 수 있습니다. |
shippingAmountOverride | API를 호출하기 전에 배송 비용을 알고 있는 경우에만 사용됩니다. 이는 USD (미국 달러)입니다. 쉼표 없이, 달러 기호 “$” 없이, 소수점 두 자리로 제공해 주십시오. 이 기능은 Zonos 담당자와 설정하지 않으면 작동하지 않습니다. 예시 값: 212.99 |
shipToAddress 필수 | 이것은 주문이 발송될 주소입니다. 이 맵은 다음 주소 필드를 포함합니다: name, address1, address2, address3, city, state, stateCode, postalCode, countryCode. 이 포함된 필드는 국가에 따라 필수 또는 비필수입니다. 지역화 엔드포인트는 각 국가에 대해 어떤 특정 주소 필드가 필수인지 반환합니다. 참고: name과 stateCode는 항상 필수가 아니며 지역화 엔드포인트에 선언되지 않습니다. 가능하다면 name 및/또는 stateCode를 전달할 수 있습니다. |
HTTPS 응답
메시지 형식: JSON
캐나다 및 호주에 대한 예시 응답
참고: 실제 응답은 모든 지원되는 국가를 포함합니다.
예시 요청
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
"shippingQuotes": [
{
"id": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"carrier": "UPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Express Air 2-4 Day Delivery",
"duty": 10.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 29.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 23.62,
"taxOrVat": 9.18
},
{
"id": "80c57724-ab4e-4997-8477-08b668fef103",
"carrier": "USPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Post 5-10 Day Delivery",
"duty": 9.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 27.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 13.62,
"taxOrVat": 8.18
}
]
}
응답 JSON 정의
| 필드 | 노트 |
|---|---|
shippingQuotes | 이는 배송 견적 맵의 목록입니다. |
shippingQuotes[index].carrier | 배송 견적이 특정한 운송업체입니다. 상점 주인이 일반 배송 프로필을 설정하도록 요청한 경우에만 null로 설정됩니다. 배송 견적은 특정 운송업체에 국한되지 않을 수 있지만, 특정할 수도 있습니다. 배송 프로필 설정에 대한 도움은 계정 관리자에게 문의하십시오.예시 값: UPS 또는 FEDEX 또는 DHL 또는 USPS 또는 CAPOST 또는 null |
shippingQuotes[index].displayName | 쇼핑객에게 표시하기에 적합한 배송 옵션의 표시 이름입니다. 이러한 값은 상점 주인이 사용자 정의할 수 있습니다. 이를 위해 계정 관리자에게 문의하십시오.예시 값: “익스프레스 항공 2-4일 배송” |
shippingQuotes[index].duty | dutyTaxTotal에 포함된 수입세 금액입니다. 이 금액은 USD로, 쉼표가 포함되지 않으며, 소수점 두 자리로 표시됩니다.예시 값: 8.29 |
shippingQuotes[index] .dutyTaxBrokerageFee | 외국 수입 중개인이 수입세 및 세금을 처리하는 데 청구하는 금액입니다. 이 금액은 dutyTaxTotal에 포함됩니다. 이 금액은 USD로, 쉼표가 포함되지 않으며, 소수점 두 자리로 표시됩니다.예시 값: 5.00 |
shippingQuotes[index] .duyTaxCarrierPrepaymentFee | 운송업체가 수입국에 대한 세금 및 세금을 prepay하기 위해 청구하는 금액입니다. 이 금액은 dutyTaxTotal에 포함됩니다. 이 금액은 USD로, 쉼표가 포함되지 않으며, 소수점 두 자리로 표시됩니다.예시 값: 5.00 |
shippingQuotes[index] .duyTaxEnabled | 이 배송 견적이 쇼핑객이 수입세 및 세금을 prepay할 수 있도록 하는지 여부입니다. false로 설정된 경우, dutyTaxTotal은 무시해야 합니다.예시 값: true 또는 false |
shippingQuotes[index] .duyTaxForced | 이 배송 견적이 쇼핑객에게 수입세 및 세금을 prepay하도록 강제하는지 여부입니다. true로 설정된 경우, 특정 배송 옵션에 대해 필수임을 설명하며 주문에 dutyTaxTotal을 포함해야 합니다. false로 설정된 경우, 쇼핑객이 수입세 및 세금을 prepay할지 선택할 수 있도록 허용할 수 있습니다.예시 값: true 또는 false |
shippingQuotes[index].dutyTaxTotal | 주어진 배송 견적에 대한 세금 및 세금의 총 비용입니다. 세금 및 세금은 주어진 배송 견적에 대해 선택 사항일 수 있으며, 사용 불가능하거나 강제될 수 있습니다. 이 금액은 shippingTotal에 포함되지 않습니다. 이 금액은 USD로, 쉼표가 포함되지 않으며, 소수점 두 자리로 표시됩니다.예시 값: 19.55 |
shippingQuotes[index] .dutyTaxUnderDeMinimis | 이 특정 배송 옵션을 사용하여 주문의 총액이 세금/VAT 최소 금액 및 세금 최소 금액 모두를 초과하지 않는지 여부입니다. true로 설정된 경우, dutyTaxTotal은 0.00으로 설정되며, 고객에게 주문에 대한 수입세 또는 세금이 없음을 알리는 메시지를 전송해야 합니다. 또한, 비용이 0.00이므로 세금 및 세금을 선불로 강제해야 합니다. |
shippingQuotes[index].id | 특정 배송 견적에 대한 식별자; 36자 UUID예시 값: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | 이것은 특정 배송 견적을 사용하여 제한된 장바구니의 항목에 대한 세부 정보를 포함하는 맵의 목록입니다. 각 제한된 항목에는 reasonCode가 있습니다. 이유는 배송 옵션에 따라 다를 수 있습니다. 항목 제한의 몇 가지 이유는 국가 수입 법률, 브랜드 제한 또는 상인이 만든 규칙 때문입니다. 쇼핑객이 배송 옵션을 선택할 때마다 장바구니 항목은 배송 견적의 restrictedItems 목록과 교차 참조되어야 합니다. 장바구니 항목 중 제한된 항목이 있는 경우 쇼핑객에게 메시지가 표시되어야 하며, 제한된 항목은 주문 총액에서 제거되어야 합니다. |
shippingQuotes[index] .restrictedItems[index].cartItemId | 이것은 제한된 장바구니 항목의 요청 JSON에서 가져온 cartItemId입니다. 이 cartItemId를 쇼핑객의 장바구니의 특정 항목에 연결할 수 있어야 합니다. 예시 값: 1 또는 2 또는 3 |
shippingQuotes[index] .restrictedItems[index].message | 이것은 항목이 제한된 이유에 대해 쇼핑객에게 표시될 수 있는 메시지입니다. 이러한 메시지는 상인이 사용자 정의할 수 있습니다. 자세한 내용은 귀하의 Zonos 담당자에게 문의하십시오. 예시 값: “우리는 귀하의 국가에 Oakley 제품을 판매할 수 없습니다.” |
shippingQuotes[index] .restrictedItems[index].reasonCode | 이것은 항목이 제한된 이유 코드입니다. 제한은 항상 국가별이며, 우리의 이유 코드는 이를 명확하게 나타냅니다. 예시 값: BRAND_COUNTRY 또는 IMPORT_COUNTRY 또는 EXPORT_COUNTRY 또는 CARRIER_COUNTRY 또는 MERCHANT_COUNTRY BRAND_COUNTRY는 특정 국가 집합에 브랜드를 판매할 수 없음을 지정한 것입니다. IMPORT_COUNTRY는 수입 국가가 해당 항목의 수입을 허용하지 않음을 의미합니다. EXPORT_COUNTRY는 수출 국가(일반적으로 미국)가 해당 항목의 수출을 허용하지 않음을 의미합니다. CARRIER_COUNTRY는 특정 운송업체가 해당 항목을 운송하지 않음을 의미합니다. MERCHANT_COUNTRY는 해당 항목이 트리거한 사용자 정의 제한 규칙을 설정했음을 의미합니다. |
shippingQuotes[index] .shippingTotal | 주어진 배송 견적에 대한 총 배송 비용입니다. 배송 견적에는 이 shippingTotal에 포함되지 않는 dutyTaxTotal 금액이 있을 수 있습니다. 이 금액은 USD로, 쉼표가 포함되지 않으며 소수점 두 자리로 표시됩니다. 예시 값: 25.82 |
shippingQuotes[index].taxOrVat | dutyTaxTotal에 포함된 세금 또는 VAT 금액입니다. 일부 국가에서는 이것이 세금이고, 다른 국가에서는 VAT입니다. 이 금액은 USD로, 쉼표가 포함되지 않으며 소수점 두 자리로 표시됩니다. 예시 값: 4.35 |
Landed Cost API 레거시
레거시 Landed Cost API의 작동 방식을 알아보세요.아래 정보는 우리의 레거시 Landed Cost API에 대한 것입니다. 최신 버전은 Landed Cost API를 참조하세요.
배송 견적 엔드포인트는 쇼핑객의 장바구니에 대한 세부정보를 수락하고, 수입 세금 및 세금 견적이 포함된 배송 견적을 반환하며, 제한 사항에 대한 항목을 검사합니다. 반환된 배송 견적은 이 API 엔드포인트 사용 전에 설정된 배송 프로필을 기반으로 합니다.
테스트 목적으로 기본 배송 프로필이 있지만, 귀사는 실제 배송 프로필 및 설정을 설정하기 위해 귀하의 계정 관리자와 협력해야 합니다.