Endpoints
Begär fraktpriser
POST | https://api.iglobalstores.com/2.0/shipping-quotes - Skapa en ny begäran om fraktpriser på varor i varukorgen som inkluderar importavgifter och skatter samt information om screening av varurestriktioner.
HTTPS-begäran
| Fält | Anteckningar |
|---|---|
| HTTP-metod | POST |
| Endpoint-URL | https://api.iglobalstores.com/2.0/shipping-quotes |
| Protokoll | HTTPS |
| Meddelandeformat | JSON |
| Accept HTTP-header | Accept: application/json |
| Säkerhetstoken HTTP-header | serviceToken: your-test-token-valueLägg till en header till din HTTPS-begäran med namnet serviceToken med värdet av din Test Security API Token. (Kontakta din Account Manager för denna token) |
| Content-Type HTTP-header | Content-Type: application/jsonEftersom du kommer att posta JSON-data till tjänsten, lägg till en header till din HTTPS-begäran med namnet Content-Type med värdet application/json |
JSON NYCKEL/VÄRDE PAR i begärans kropp
Meddelandeformat: JSON
Exempelbegäran
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"
}
}
Begär JSON-definitioner
| Fält | Anteckningar |
|---|---|
boxCount | Detta fält beskriver de lådor som kommer att användas för att skicka beställningen. Det förväntas inte att en handlare vet detta vid tidpunkten för beställningen; men om det är känt kan det skickas i följande specifika format. Exempelvärde: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Kommaseparerad lista över låddimensioner och antal. I exemplet ovan finns det totalt 4 lådor. Den första lådan i listan kommer att vara 22 tum lång, 15 tum bred och 15 tum hög. Det kommer bara att användas en låda för den storleken. Det kommer att finnas två lådor av storlek 8x8x4 tum. Det är acceptabelt att skicka samma låddimension flera gånger om det är enkelt för dig, som så här: "22x15x15(1),22x15x15(1)", vilket betyder 2 lådor av storlek 22x15x15 tum. |
items REQUIRED | En lista över artikelkartor |
items[index].brandName | Varumärket för den specifika artikeln kommer att hjälpa vår regelmotor att bäst avgöra om en begränsning gäller för artikeln för destinationslandet. Även om en artikels varumärke textuellt matchar eller inte matchar en specifik begränsning, kommer vår regelmotor att använda artikelns SKU och/eller productId för att bättre avgöra om artikeln faktiskt är begränsad till destinationslandet. Vänligen skicka varumärket om det är tillgängligt. Exempelvärden: "Oakley" eller "Nike" eller null |
items[index].cartItemId REQUIRED | Detta fält krävs för att identifiera artikeln, specifikt inom listan över artiklar. Det kan vara så enkelt som ett indexvärde. Vi kommer att använda denna cartItemId för att identifiera en artikel om den är begränsad i JSON-svaret. Så se till att du kan identifiera samma artikel i din kundvagn med denna cartItemId som du skickar till oss. Exempelvärden: 1 eller 2 eller 3 |
items[index].category | Produktkategorierna - den specifika produkt den är en del av. Kategorin kommer att hjälpa vår regelmotor att bäst avgöra om en begränsning gäller för artikeln för destinationslandet. Även om en artikels kategori textuellt matchar eller inte matchar en specifik begränsning, kommer vår regelmotor att använda artikelns SKU och/eller productId för att bättre avgöra om artikeln faktiskt är begränsad till destinationslandet. Format: En rörseparerad lista över kategorinamn. Varje kategorinamn kan vara ett eller flera ord. Om en artikel finns i mer än en kategori, vänligen lista dem båda separerade med ett rörtecken "". Exempel: värden "Solglasögon" eller "KvällstillbehörHandväskor" |
items[index].countryOfOrigin | Ursprungslandet är det land där varan tillverkades eller ursprungligen kom ifrån. Ursprungslandet hjälper vår regleringsmotor att bäst avgöra om en restriktion gäller för varan för destinationslandet. Vissa länder tillåter inte specifika typer av varor från andra specifika länder. Exempelvärden: “CN” för Kina eller “US” för USA eller null |
items[index].detailedDescription REQUIRED | Detta fält är helt enkelt text, men bör inkludera så mycket information som möjligt om varan som köps. Till exempel, det fullständiga namnet och artikelnumret om tillämpligt, färgen eller andra valda alternativ, materialinnehåll och eventuell beskrivningstext du har för varan. Det finns många olika typer av importrestriktioner till utländska länder, såsom läderskor till Italien. Ibland är det enda sättet att fånga dessa begränsade varor genom detailedDescription. Observera: Även om en varas detailedDescription textuellt matchar eller inte matchar en specifik restriktion, kommer vår regleringsmotor att använda varans SKU och/eller productId för att bättre avgöra om varan faktiskt är begränsad till destinationslandet. För bästa resultat, vänligen skicka så mycket information som möjligt i fältet detailedDescription. Exempelvärde: “Tory Burch, Robinson – Double Zip’ Tote, färg: New Carnival, materialinnehåll: läder, Färggrikt läder ger en iögonfallande attraktion till en välstrukturerad tote, prydd med logohårdvara och rullade handtag för en helt sofistikerad look. Magnetisk knappstängning med dubbla zip-fack. Inre zip, vägg- och mobilfickor. Skyddande metallfötter. Läder. Av Tory Burch; importerad.” |
items[index].height | Detta är varans höjd. Det finns ett annat fält som heter dimensionalUnits, där du specificerar tum eller centimeter för denna mätning. Vänligen ange utan kommatecken och med högst två decimaler. Exempelvärde: 25.5 Dina fraktkostnader kommer att vara mest exakta om du anger detta fält. |
items[index].hsCode | Detta är HS-koden som identifierar varan för utländska länder. Att ange hsCode hjälper till att korrekt identifiera rätt importtull rate för den specifika varan. Inte nödvändigt om den inte är tillgänglig – vi tar hand om det om du inte har det. Format: Antingen en 10-siffrig eller 6-siffrig kod; kan inkludera de separerande “.” tecknen eller inte. Exempelvärden: “20.4560.0000” eller “20.4560” eller “204560” (antingen 10 eller 6 siffror är acceptabla) |
items[index].length | Detta är varans längd. Det finns ett annat fält som heter dimensionalUnits, där du specificerar tum eller centimeter för denna mätning. Vänligen ange utan kommatecken och med högst två decimaler. Exempelvärde: 25.5 Dina fraktkostnader kommer att vara mest exakta om du anger detta fält. |
items[index].productId | Detta är ditt produkt-ID för den specifika varan. Vår regleringsmotor kommer att använda detta värde som ett ID för att koppla inlärd varuinformation till din vara. Exempelvärde: “17898-675235” Vänligen ange åtminstone productID eller SKU. Att ange båda föredras. |
items[index].quantity REQUIRED | Detta är kvantiteten som köps av den specifika varan. Vänligen ange som ett positivt heltal, utan kommatecken och utan decimaler. Exempelvärden: 1 eller 9999 (vi föredrar att du säljer fler varor än färre!) |
items[index].sku | Detta är din SKU för den specifika varan. Vår regleringsmotor kommer att använda detta värde som ett ID för att koppla inlärd varuinformation till din vara. Exempelvärde: “oakley-125” Vänligen ange åtminstone productId eller SKU. Att ange båda föredras. |
items[index].unitPrice REQUIRED | Detta är varans enhetspris i USD (amerikanska dollar). Vänligen ange utan kommatecken, utan dollartecken “$”, och med två decimaler. Exempelvärde: 2102.99 |
items[index].weight | Detta är vikten på din vara. Det finns ett annat fält som heter weightUnits, där du anger pund, uns, gram eller kilogram för denna mätning. Vänligen ange utan kommatecken och med högst två decimaler.Exempelvärde: 4.2Dina fraktkostnader kommer att vara mest exakta om du anger detta fält. |
items[index].weightUnits | Standardvärdet är “LB” för pund. Måttenheten för viktvärdet. Om det sätts till null, kommer “LB” (pund) att antas.Exempelvärden: “LB” för pund eller “OZ” för uns eller “G” för gram eller “KG” för kilogram eller null |
items[index].width | Detta är bredden på din vara. Det finns ett annat fält som heter dimensionalUnits, där du anger tum eller centimeter för denna mätning. Vänligen ange utan kommatecken och med högst två decimaler.Exempelvärde: 25.5Dina fraktkostnader kommer att vara mest exakta om du anger detta fält. |
shipFromAddress | Om det anges som null, kommer vi att använda en standard shipFromAddress kopplad till ditt säljarkonto. Detta är adressen som beställningen kommer att skickas från, dvs. ditt lager. Detta är en karta som innehåller följande adressfält: address1, address2, address3, city, state, stateCode, postalCode, countryCode. Dessa fält är obligatoriska eller inte obligatoriska, beroende på landet. Lokaliseringens slutpunkt returnerar vilka specifika adressfält som är obligatoriska för varje land.Obs: stateCode är alltid inte obligatoriskt och inte deklarerat i lokaliseringens slutpunkt. Du kan ange stateCode, om det finns tillgängligt. |
shippingAmountOverride | Detta används endast om du känner till fraktkostnaden innan du anropar API:et. Det är i USD (amerikanska dollar).Vänligen ange utan kommatecken, utan dollartecken “$”, och med två decimaler. Denna funktion kommer inte att fungera utan att ställa in den med en Zonos representant. Exempelvärde: 212.99 |
shipToAddress REQUIRED | Detta är adressen som beställningen kommer att skickas till. Detta är en karta som innehåller följande adressfält: name, address1, address2, address3, city, state, stateCode, postalCode, countryCode. Dessa fält är obligatoriska eller inte beroende på landet. Lokaliseringens slutpunkt returnerar vilka specifika adressfält som är obligatoriska för varje land.Obs: name och stateCode är alltid inte obligatoriska och inte deklarerade i lokaliseringens slutpunkt. Du kan ange name och/eller stateCode, om det finns tillgängligt. |
HTTPS-svar
Meddelandets format: JSON
Exempel på svar för endast Kanada och Australien
Obs: Faktiska svar kommer att innehålla alla stödda länder.
Exempel på begäran
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
}
]
}
Svar JSON-definitioner
| Fält | Anteckningar |
|---|---|
shippingQuotes | Detta är en lista över fraktpris kartor. |
shippingQuotes[index].carrier | Den transportör som fraktpriset är specifikt för. Sätts endast till null om handlaren har bett om att få generiska fraktprofiler inställda, inte specifika för en transportör. Fraktpriser behöver inte vara specifika för en transportör; men kan vara det. Kontakta din kontoansvarig för hjälp med att ställa in dina fraktprofiler. Exempelvärden: UPS eller FEDEX eller DHL eller USPS eller CAPOST eller null |
shippingQuotes[index].displayName | Visningsnamn för fraktalternativet, lämpligt att visas för köparen. Dessa värden är anpassningsbara för handlaren. Kontakta din kontoansvarig för att göra det. Exempelvärde: “Express Air 2-4 Dag Leverans” |
shippingQuotes[index].duty | Importavgiftsbeloppet som ingår i dutyTaxTotal. Detta belopp är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 8.29 |
shippingQuotes[index] .dutyTaxBrokerageFee | Detta är vad den utländska importören kommer att ta betalt för att behandla dina importavgifter och skatter. Detta belopp ingår i dutyTaxTotal. Beloppet är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 5.00 |
shippingQuotes[index] .duyTaxCarrierPrepaymentFee | Detta är vad transportören kommer att ta betalt för att prepay avgifterna och skatterna till importlandet. Detta belopp ingår i dutyTaxTotal. Detta belopp är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 5.00 |
shippingQuotes[index] .duyTaxEnabled | Om detta fraktpris gör det möjligt för köparen att prepay sina importavgifter och skatter. Om det är inställt på false, bör dutyTaxTotal ignoreras. Exempelvärden: true eller false |
shippingQuotes[index] .duyTaxForced | Om detta fraktpris tvingar köparen att prepay sina importavgifter och skatter. Om det är inställt på true, bör du inkludera dutyTaxTotal i beställningen och förklara för köparen att det är nödvändigt med detta specifika fraktalternativ. Om det är inställt på false, kan du låta köparen välja om de vill prepay sina importavgifter och skatter. Exempelvärden: true eller false |
shippingQuotes[index].dutyTaxTotal | Den totala kostnaden för avgift och skatt för det angivna fraktpriset. Avgift och skatt kan vara valfria, inte tillgängliga eller tvingade för det angivna fraktpriset. Detta belopp ingår inte i shippingTotal. Detta belopp är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 19.55 |
shippingQuotes[index] .dutyTaxUnderDeMinimis | Om beställningens totala belopp, med detta specifika fraktalternativ, är under både skatte/VAT de minimis belopp och avgifts de minimis belopp. Om det är inställt på true, kommer dutyTaxTotal att sättas till 0.00, och du bör meddela kunden att det inte kommer att finnas några importavgifter eller skatter att betala på deras beställning. Dessutom, tvinga förbetalning av avgifter och skatter, eftersom kostnaden är 0.00. |
shippingQuotes[index].id | En identifierare för det specifika fraktpriset; en 36-tecken UUID. Exempelvärde: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | Detta är en lista med kartor som innehåller detaljer om eventuella artiklar i kundvagnen som är begränsade med hjälp av detta specifika fraktpris. Varje begränsad artikel har en reasonCode. Anledningen kan vara specifik för fraktalternativet eller inte. Vissa anledningar till artikelbegränsningar beror på importlagar i landet, varumärkesbegränsningar eller till och med regler skapade av handlaren. Varje gång ett fraktalternativ väljs av köparen bör varorna i kundvagnen korsrefereras mot fraktpriset restrictedItems-lista. Om någon av varorna i kundvagnen är begränsad bör ett meddelande visas för köparen, och den begränsade artikeln/artiklarna bör tas bort från orderns total, etc. |
shippingQuotes[index] .restrictedItems[index].cartItemId | Detta är cartItemId från begäran JSON för en begränsad kundvagnsartikel. Du bör kunna koppla detta cartItemId tillbaka till en specifik artikel i din köpares kundvagn. Exempelvärden: 1 eller 2 eller 3 |
shippingQuotes[index] .restrictedItems[index].message | Detta är ett meddelande som kan visas för köparen om varför artikeln är begränsad. Dessa meddelanden kan anpassas av handlaren. Vänligen kontakta din Zonos representant för detaljer. Exempelvärde: “Vi kan inte sälja Oakley-produkter till ditt land.” |
shippingQuotes[index] .restrictedItems[index].reasonCode | Detta är anledningen till att artikeln är begränsad. Begränsningar är alltid landspecifika och våra anledningkoder gör det uppenbart. Exempelvärden: BRAND_COUNTRY eller IMPORT_COUNTRY eller EXPORT_COUNTRY eller CARRIER_COUNTRY eller MERCHANT_COUNTRY. BRAND_COUNTRY betyder att du har specificerat att du inte kan sälja ett varumärke till en specifik uppsättning länder. IMPORT_COUNTRY betyder att importlandet inte tillåter att artikeln importeras. EXPORT_COUNTRY betyder att exportlandet (vanligtvis USA) inte tillåter att artikeln exporteras. CARRIER_COUNTRY betyder att den specifika transportören inte kommer att transportera artikeln. MERCHANT_COUNTRY betyder att du har ställt in en anpassad begränsningsregel som artikeln har utlösts av. |
shippingQuotes[index] .shippingTotal | Den totala kostnaden för frakt för det givna fraktpriset. Fraktpriser kan också ha ett dutyTaxTotal belopp, som inte ingår i detta shippingTotal. Detta belopp är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 25.82 |
shippingQuotes[index].taxOrVat | Skatte- eller momsbeloppet som ingår i dutyTaxTotal. För vissa länder är detta en skatt; för andra är det en moms. Detta belopp är i USD, kommer inte att innehålla kommatecken och kommer att innehålla två decimaler. Exempelvärde: 4.35 |
Landed Cost API Legacy
Lär dig hur Legacy Landed Cost API fungerar.Informationen nedan gäller vår legacy Landed Cost API. Se vår Landed Cost API för den senaste versionen.
Shipping-quotes endpointen accepterar detaljer om din kunds varukorg, returnerar fraktpriser inklusive importavgifter och skatter, och kontrollerar varorna för restriktioner. Dessa returnerade fraktpriser baseras på fraktprofiler som är inställda innan användningen av denna API-endpoint.
Vi har standardfraktprofiler för teständamål, men du kommer att behöva samarbeta med din Account Manager för att ställa in de faktiska fraktprofiler och inställningar som ditt företag vill använda.