Endpoints
Verzendoffertes aanvragen
POST | https://api.iglobalstores.com/2.0/shipping-quotes - Maak een nieuwe aanvraag voor verzendoffertes voor artikelen in het winkelwagentje die invoerrechten en belastingen plus informatie over de screening van artikelbeperkingen omvat.
HTTPS-aanroep
| Veld | Opmerkingen |
|---|---|
| HTTP-methode | POST |
| Endpoint-URL | https://api.iglobalstores.com/2.0/shipping-quotes |
| Protocol | HTTPS |
| Berichtformaat | JSON |
| Accept HTTP-header | Accept: application/json |
| Beveiligingstoken HTTP-header | serviceToken: your-test-token-valueVoeg een header toe aan uw HTTPS-aanroep met de naam serviceToken met een waarde van uw Test Security API Token. (Neem contact op met uw Account Manager voor deze token) |
| Content-Type HTTP-header | Content-Type: application/jsonOmdat u JSON-gegevens naar de service plaatst, voegt u een header toe aan uw HTTPS-aanroep met de naam Content-Type met een waarde van application/json |
JSON KEY/VALUE PAIRS in de aanvraagbody
Berichtformaat: JSON
Voorbeeldaanvraag
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"
}
}
JSON-verzoekdefinities
| Veld | Opmerkingen |
|---|---|
boxCount | Dit veld beschrijft de dozen die zullen worden gebruikt om de bestelling te verzenden. Het wordt niet verwacht dat een handelaar dit weet op het moment van de bestelling; echter, als het bekend is, kan het worden doorgegeven in het volgende specifieke formaat. Voorbeeldwaarde: 22x15x15(1),8x8x4(2),32x22x14(1) Formaat: Komma-gescheiden lijst van doosafmetingen en aantal. In het bovenstaande voorbeeld zijn er in totaal 4 dozen. De eerste doos in de lijst zal 22 inch lang zijn, 15 inch breed en 15 inch hoog. Er zal slechts één doos van die grootte worden gebruikt. Er zullen twee dozen van 8x8x4 inch zijn. Het is acceptabel om dezelfde doosafmeting meerdere keren door te geven als dat voor u gemakkelijk is, zoals dit: “22x15x15(1),22x15x15(1)”, wat betekent 2 dozen van 22x15x15 inch. |
items VEREIST | Een lijst van itemkaarten |
items[index].brandName | De merknaam van het specifieke item zal onze regelengine helpen het beste te bepalen of er een beperking van toepassing is op het item voor het bestemmingsland. Zelfs als de merknaam van een item wel of niet tekstueel overeenkomt met een specifieke beperking, zal onze regelengine de SKU van het item en/of productId gebruiken om beter te beslissen of het item daadwerkelijk beperkt is in het bestemmingsland. Stuur de merknaam indien beschikbaar. Voorbeeldwaarden: “Oakley” of “Nike” of null |
items[index].cartItemId VEREIST | Dit veld is vereist om het item te identificeren, specifiek binnen de lijst van items. Het kan zo eenvoudig zijn als een indexwaarde. We zullen deze cartItemId gebruiken om een item te identificeren als het beperkt is in de JSON-respons. Zorg er dus voor dat u hetzelfde item in uw winkelwagen kunt identificeren met deze cartItemId die u aan ons doorgeeft. Voorbeeldwaarden: 1 of 2 of 3 |
items[index].category | De productcategorieën - het specifieke product waarvan het deel uitmaakt. De categorie zal onze regelengine helpen het beste te bepalen of er een beperking van toepassing is op het item voor het bestemmingsland. Zelfs als de categorie van een item wel of niet tekstueel overeenkomt met een specifieke beperking, zal onze regelengine de SKU van het item en/of productId gebruiken om beter te beslissen of het item daadwerkelijk beperkt is in het bestemmingsland. Formaat: Een met pijp gescheiden lijst van categorienamen. Elke categorienaam kan een of meer woorden zijn. Als een item in meer dan één categorie bestaat, vermeld ze dan beide gescheiden door een pijp “” karakter. Voorbeeld: waarden “Zonnebrillen” of “AvondaccessoiresHandtassen” |
items[index].countryOfOrigin | Het land van herkomst is het land waar het item is gemaakt of oorspronkelijk vandaan komt. Het land van herkomst helpt onze regelsengine om te bepalen of er een beperking van toepassing is op het item voor het bestemmingsland. Sommige landen staan specifieke soorten goederen uit andere specifieke landen niet toe. Voorbeeldwaarden: “CN” voor China of “US” voor de Verenigde Staten of null |
items[index].detailedDescription VERPLICHT | Dit veld is simpelweg tekst, maar moet zoveel mogelijk informatie bevatten over het item dat wordt aangeschaft. Bijvoorbeeld, de volledige naam en artikelcode indien van toepassing, de kleur of andere geselecteerde opties, materiaalsamenstelling en eventuele beschrijvingstekst die je voor het item hebt. Er zijn veel verschillende soorten invoerbeperkingen in buitenlandse landen, zoals leren schoenen in Italië. Soms is de enige manier om deze beperkte items te vangen via de detailedDescription. Opmerking: Zelfs als de detailedDescription van een item tekstueel overeenkomt met een specifieke beperking of niet, zal onze regelsengine de SKU van het item en/of productId gebruiken om beter te beslissen of het item inderdaad beperkt is in het bestemmingsland. Voor de beste resultaten, stuur zoveel mogelijk informatie in het detailedDescription-veld. Voorbeeldwaarde: “Tory Burch, Robinson – Double Zip’ Tote, kleur: New Carnival, materiaalsamenstelling: leer, Kleurrijk leer geeft een opvallende uitstraling aan een net gestructureerde tote, afgewerkt met logo hardware en gerolde handvatten voor een volledig verfijnde look. Magnetische sluiting met dubbele ritscompartimenten. Interne rits-, wand- en mobiele telefoon pockets. Beschermende metalen voeten. Leer. Door Tory Burch; geïmporteerd.” |
items[index].height | Dit is de hoogte van je item. Er is een ander veld genaamd dimensionalUnits, waar je inches of centimeters voor deze meting opgeeft. Gelieve zonder komma's en met niet meer dan twee decimalen te verstrekken. Voorbeeldwaarde: 25.5 Je verzendtarieven zullen het meest nauwkeurig zijn als je dit veld doorgeeft. |
items[index].hsCode | Dit is de HS-code die het item identificeert voor buitenlandse landen. Het doorgeven van de hsCode helpt bij het correct identificeren van het juiste invoerrecht rate voor het specifieke item. Niet vereist als deze niet beschikbaar is – wij zorgen ervoor als je deze niet hebt. Formaat: Ofwel een 10-cijferige of 6-cijferige code; kan de scheidende “.”-tekens bevatten of niet. Voorbeeldwaarden: “20.4560.0000” of “20.4560” of “204560” (zowel 10- als 6-cijferige codes zijn acceptabel) |
items[index].length | Dit is de lengte van je item. Er is een ander veld genaamd dimensionalUnits, waar je inches of centimeters voor deze meting opgeeft. Gelieve zonder komma's en met niet meer dan twee decimalen te verstrekken. Voorbeeldwaarde: 25.5 Je verzendtarieven zullen het meest nauwkeurig zijn als je dit veld doorgeeft. |
items[index].productId | Dit is je product-id voor het specifieke item. Onze regelsengine zal deze waarde gebruiken als een ID om geleerde iteminformatie aan je item te koppelen. Voorbeeldwaarde: “17898-675235” Gelieve ten minste de productID of de SKU door te geven. Het doorgeven van beide heeft de voorkeur. |
items[index].quantity VERPLICHT | Dit is de hoeveelheid die wordt aangeschaft van het specifieke item. Gelieve als een positief geheel getal door te geven, zonder komma's en zonder decimalen. Voorbeeldwaarden: 1 of 9999 (we geven de voorkeur dat je meer items verkoopt dan minder!) |
items[index].sku | Dit is je SKU voor het specifieke item. Onze regelsengine zal deze waarde gebruiken als een ID om geleerde iteminformatie aan je item te koppelen. Voorbeeldwaarde: “oakley-125” Gelieve ten minste de productId of de SKU door te geven. Het doorgeven van beide heeft de voorkeur. |
items[index].unitPrice VERPLICHT | Dit is de eenheidsprijs van je item in USD (Amerikaanse dollars). Gelieve zonder komma's, zonder een dollarteken “$”, en met twee decimalen door te geven. Voorbeeldwaarde: 2102.99 |
items[index].weight | Dit is het gewicht van uw item. Er is een ander veld genaamd weightUnits, waar u ponden, ounces, grammen of kilogrammen voor deze meting opgeeft. Gelieve zonder komma's en met niet meer dan twee decimalen te verstrekken. Voorbeeldwaarde: 4.2 Uw verzendtarieven zullen het meest nauwkeurig zijn als u dit veld doorgeeft. |
items[index].weightUnits | Standaard op “LB” voor ponden. De eenheid van maat voor de gewichtwaarde. Als ingesteld op null, wordt “LB” (ponden) aangenomen. Voorbeeldwaarden: “LB” voor ponden of “OZ” voor ounces of “G” voor grammen of “KG” voor kilogrammen of null |
items[index].width | Dit is de breedte van uw item. Er is een ander veld genaamd dimensionalUnits, waar u inches of centimeters voor deze meting opgeeft. Gelieve zonder komma's en met niet meer dan twee decimalen te verstrekken. Voorbeeldwaarde: 25.5 Uw verzendtarieven zullen het meest nauwkeurig zijn als u dit veld doorgeeft. |
shipFromAddress | Als doorgegeven als null, gebruiken we een standaard shipFromAddress dat is gekoppeld aan uw verkopersaccount. Dit is het adres waar de bestelling vandaan wordt verzonden, d.w.z. uw magazijn. Dit is een kaart met de volgende adresvelden: address1, address2, address3, city, state, stateCode, postalCode, countryCode. Deze velden zijn vereist of niet vereist, afhankelijk van het land. Het lokalisatie-eindpunt retourneert welke specifieke adresvelden vereist zijn voor elk land. Opmerking: stateCode is altijd niet vereist en niet verklaard in het lokalisatie-eindpunt. U kunt stateCode doorgeven, indien beschikbaar. |
shippingAmountOverride | Dit wordt alleen gebruikt als u de verzendkosten kent voordat u de API aanroept. Het is in USD (Amerikaanse dollars). Gelieve zonder komma's, zonder dollarteken “$”, en met twee decimalen te verstrekken. Deze functie werkt niet zonder deze in te stellen met een Zonos vertegenwoordiger. Voorbeeldwaarde: 212.99 |
shipToAddress VERPLICHT | Dit is het adres waar de bestelling naartoe wordt verzonden. Dit is een kaart met de volgende adresvelden: name, address1, address2, address3, city, state, stateCode, postalCode, countryCode. Deze velden zijn vereist of niet, afhankelijk van het land. Het lokalisatie-eindpunt retourneert welke specifieke adresvelden vereist zijn voor elk land. Opmerking: name en stateCode zijn altijd niet vereist en niet verklaard in het lokalisatie-eindpunt. U kunt name en/of stateCode doorgeven, indien beschikbaar. |
HTTPS-respons
Berichtformaat: JSON
Voorbeeldrespons voor alleen Canada en Australië
Opmerking: Werkelijke reacties bevatten alle ondersteunde landen.
Voorbeeldverzoek
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
}
]
}
Antwoorden JSON-definities
| Veld | Opmerkingen |
|---|---|
shippingQuotes | Dit is een lijst van verzendoffertes. |
shippingQuotes[index].carrier | De vervoerder waarvoor de verzendofferte specifiek is. Alleen ingesteld op null als de verkoper heeft gevraagd om generieke verzendprofielen in te stellen, niet specifiek voor een vervoerder. Verzendoffertes hoeven niet specifiek voor een vervoerder te zijn; maar kunnen dat wel zijn. Neem contact op met uw Accountmanager voor hulp bij het instellen van uw verzendprofielen. Voorbeeldwaarden: UPS of FEDEX of DHL of USPS of CAPOST of null |
shippingQuotes[index].displayName | Weergavenaam voor de verzendoptie, geschikt om aan de koper te tonen. Deze waarden zijn aanpasbaar voor de verkoper. Neem contact op met uw Accountmanager om dit te doen. Voorbeeldwaarde: “Express Lucht 2-4 Dagen Levering” |
shippingQuotes[index].duty | Het bedrag van de invoerrechten dat is inbegrepen in de dutyTaxTotal. Dit bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 8.29 |
shippingQuotes[index] .dutyTaxBrokerageFee | Dit is wat de buitenlandse importmakelaar u in rekening brengt om uw invoerrechten en belastingen te verwerken. Dit bedrag is inbegrepen in de dutyTaxTotal. Het bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 5.00 |
shippingQuotes[index] .duyTaxCarrierPrepaymentFee | Dit is wat de vervoerder u in rekening brengt om prepay de invoerrechten en belastingen aan het importland te betalen. Dit bedrag is inbegrepen in de dutyTaxTotal. Dit bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 5.00 |
shippingQuotes[index] .duyTaxEnabled | Of deze verzendofferte de koper in staat stelt om prepay hun invoerrechten en belastingen. Als dit op false is ingesteld, moet de dutyTaxTotal worden genegeerd. Voorbeeldwaarden: true of false |
shippingQuotes[index] .duyTaxForced | Of deze verzendofferte de koper dwingt om prepay hun invoerrechten en belastingen. Als dit op true is ingesteld, moet u de dutyTaxTotal in de bestelling opnemen, en de koper uitleggen dat dit vereist is met deze specifieke verzendoptie. Als dit op false is ingesteld, kunt u de koper toestaan om te kiezen of ze hun invoerrechten en belastingen willen prepay. Voorbeeldwaarden: true of false |
shippingQuotes[index].dutyTaxTotal | De totale kosten van invoerrechten en belastingen voor de gegeven verzendofferte. Invoerrechten en belastingen kunnen optioneel, niet beschikbaar of verplicht zijn voor de gegeven verzendofferte. Dit bedrag is niet inbegrepen in de shippingTotal. Dit bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 19.55 |
shippingQuotes[index] .dutyTaxUnderDeMinimis | Of het totale bedrag van de bestelling, met gebruik van deze specifieke verzendoptie, onder zowel het belasting/VAT de minimis bedrag als het invoerrechten de minimis bedrag ligt. Als dit op true is ingesteld, wordt de dutyTaxTotal ingesteld op 0.00, en moet u de klant berichten dat er geen invoerrechten of belastingen verschuldigd zijn op hun bestelling. Bovendien moet u de betaling van invoerrechten en belastingen afdwingen, omdat de kosten 0.00 zijn. |
shippingQuotes[index].id | Een identificatie voor de specifieke verzendofferte; een 36-teken UUID. Voorbeeldwaarde: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | Dit is een lijst van kaarten, die details bevat over eventuele artikelen in de winkelwagentje die zijn beperkt met behulp van deze specifieke verzendquote. Elk beperkt item heeft een reasonCode. De reden kan al dan niet specifiek zijn voor de verzendoptie. Enkele redenen voor artikelbeperkingen zijn vanwege de invoerwetten van het land, merbeperkingen of zelfs door de handelaar gemaakte regels. Elke keer dat een verzendoptie door de koper wordt gekozen, moeten de winkelwagentje-items worden vergeleken met de restrictedItems-lijst van de verzendquote. Als een van de winkelwagentje-items beperkt is, moet er een bericht aan de koper worden weergegeven en moeten de beperkte item(s) van het totaal van de bestelling worden verwijderd, enz. |
shippingQuotes[index] .restrictedItems[index].cartItemId | Dit is de cartItemId uit de aanvraag JSON van een beperkt winkelwagentje-item. Je zou deze cartItemId moeten kunnen koppelen aan een specifiek item in het winkelwagentje van je koper. Voorbeeldwaarden: 1 of 2 of 3 |
shippingQuotes[index] .restrictedItems[index].message | Dit is een bericht dat aan de koper kan worden weergegeven over waarom het item is beperkt. Deze berichten zijn aanpasbaar door de handelaar. Neem contact op met je Zonos vertegenwoordiger voor details. Voorbeeldwaarde: “We kunnen Oakley-producten niet naar jouw land verkopen.” |
shippingQuotes[index] .restrictedItems[index].reasonCode | Dit is de reden code voor het item dat beperkt is. Beperkingen zijn altijd land-specifiek en onze reden codes maken dat duidelijk. Voorbeeldwaarden: BRAND_COUNTRY of IMPORT_COUNTRY of EXPORT_COUNTRY of CARRIER_COUNTRY of MERCHANT_COUNTRY. BRAND_COUNTRY betekent dat je hebt opgegeven dat je een merk niet kunt verkopen aan een specifieke set landen. IMPORT_COUNTRY betekent dat het invoerende land het item niet zal toestaan om geïmporteerd te worden. EXPORT_COUNTRY betekent dat het uitvoerende land (meestal de Verenigde Staten) het item niet zal toestaan om geëxporteerd te worden. CARRIER_COUNTRY betekent dat de specifieke vervoerder het item niet zal vervoeren. MERCHANT_COUNTRY betekent dat je een aangepaste beperkingregel hebt ingesteld die door het item is geactiveerd. |
shippingQuotes[index] .shippingTotal | De totale verzendkosten voor de gegeven verzendquote. Verzendquotes kunnen ook een dutyTaxTotal bedrag hebben, dat niet is inbegrepen in deze shippingTotal. Dit bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 25.82 |
shippingQuotes[index].taxOrVat | Het belasting- of BTW-bedrag dat is inbegrepen in de dutyTaxTotal. Voor sommige landen is dit een belasting; voor andere is het een BTW. Dit bedrag is in USD, bevat geen komma's en heeft twee decimalen. Voorbeeldwaarde: 4.35 |
Landed Cost API Legacy
Leer hoe de Legacy Landed Cost API werkt.De onderstaande informatie is voor onze legacy Landed Cost API. Zie onze Landed Cost API voor de nieuwste versie.
De shipping-quotes endpoint accepteert details over de winkelwagentje van uw koper, retourneert verzendoffertes inclusief invoerrechten en belastingoffertes, en controleert de artikelen op beperkingen. Deze geretourneerde verzendoffertes zijn gebaseerd op verzendprofielen die zijn ingesteld voordat deze API-endpoint wordt gebruikt.
We hebben standaard verzendprofielen voor testdoeleinden, maar u moet samenwerken met uw Account Manager om de werkelijke verzendprofielen en instellingen in te stellen die uw bedrijf wil gebruiken.