Endpoints
Request shipping quotes
POST | https://api.iglobalstores.com/2.0/shipping-quotes
- Opret en ny anmodning om fragtpriser på varer i indkøbskurven, der inkluderer importafgifter og skatter samt screeninginformation om varebegrænsninger.
HTTPS request
Field | Notes |
---|---|
HTTP method | POST |
Endpoint URL | https://api.iglobalstores.com/2.0/shipping-quotes |
Protocol | HTTPS |
Message format | JSON |
Accept HTTP header | Accept: application/json |
Security Token HTTP Header | serviceToken: your-test-token-valueTilføj en header til din HTTPS-anmodning med navnet serviceToken med en værdi af din Test Security API Token. (Kontakt din Account Manager for denne token) |
Content-Type HTTP Header | Content-Type: application/jsonFordi du vil sende JSON-data til tjenesten, skal du tilføje en header til din HTTPS-anmodning med navnet Content-Type med en værdi af application/json |
JSON KEY/VALUE PAIRS in the request body
Message Format: JSON
Eksempel på anmodning
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"
}
}
Anmod JSON-definitioner
Felt | Noter |
---|---|
boxCount | Dette felt beskriver de kasser, der vil blive brugt til at sende ordren. Det forventes ikke, at en forhandler kender dette på ordretidspunktet; dog, hvis det er kendt, kan det videregives i følgende specifikke format. Eksempelværdi: 22x15x15(1),8x8x4(2),32x22x14(1)Format: Komma-separeret liste over kassedimensioner og antal. I eksemplet ovenfor er der i alt 4 kasser. Den første kasse på listen vil være 22 tommer lang, 15 tommer bred og 15 tommer høj. Der vil kun blive brugt en kasse af den størrelse. Der vil være to kasser af størrelse 8x8x4 tommer. Det er acceptabelt at videregive den samme kassedimension flere gange, hvis det er nemt for dig, som dette: "22x15x15(1),22x15x15(1)", hvilket betyder 2 kasser af størrelse 22x15x15 tommer. |
items PÅKRÆVET | En liste over varekort |
items[index].brandName | Mærkenavnet på den specifikke vare vil hjælpe vores regelmotor med bedst at afgøre, om der gælder en begrænsning for varen til destinationslandet. Selvom et varemærkes navn gør eller ikke gør tekstligt matcher en specifik begrænsning, vil vores regelmotor bruge varens SKU og/eller productId til bedre at beslutte, om varen faktisk er begrænset til destinationslandet. Send venligst mærkenavnet, hvis det er tilgængeligt. Eksempelværdier: "Oakley" eller "Nike" eller null |
items[index].cartItemId PÅKRÆVET | Dette felt er påkrævet for at identificere varen, specifikt inden for listen over varer. Det kan være så simpelt som en indeksværdi. Vi vil bruge dette cartItemId til at identificere en vare, hvis den er begrænset i JSON-svaret. Sørg derfor for, at du kan identificere den samme vare i din indkøbskurv ved dette cartItemId , du videregiver til os. Eksempelværdier: 1 eller 2 eller 3 |
items[index].category | Produktkategorierne - den specifikke produktkategori, den er en del af. Kategorien vil hjælpe vores regelmotor med bedst at afgøre, om der gælder en begrænsning for varen til destinationslandet. Selvom en vares kategori gør eller ikke gør tekstligt matcher en specifik begrænsning, vil vores regelmotor bruge varens SKU og/eller productId til bedre at beslutte, om varen faktisk er begrænset til destinationslandet. Format: En rør-separeret liste over kategorinavne. Hvert kategorinavn kan være ét eller flere ord. Hvis en vare findes i mere end én kategori, skal du liste dem begge adskilt af et rør "" tegn. Eksempelværdier: "Solbriller" eller "Aften AccessoriesHåndtasker" |
items[index].countryOfOrigin | Oprindelseslandet er det land, hvor varen blev fremstillet eller oprindeligt stammer fra. Oprindelseslandet vil hjælpe vores regelsystem med bedst at afgøre, om en restriktion gælder for varen til destinationslandet. Nogle lande tillader ikke specifikke typer varer fra andre specifikke lande. Eksempelværdier: “CN” for Kina eller “US” for USA eller null |
items[index].detailedDescription REQUIRED | Dette felt er blot tekst, men bør indeholde så mange oplysninger som muligt om den købte vare. For eksempel det fulde navn og varekode, hvis relevant, farven eller andre valgte muligheder, materialeindhold og enhver beskrivelsestekst, du har for varen. Der er mange forskellige typer importrestriktioner til fremmede lande, såsom lædersko til Italien. Nogle gange er den eneste måde at fange disse begrænsede varer på gennem detailedDescription . Bemærk: Selv hvis en vares detailedDescription matcher eller ikke matcher en specifik restriktion, vil vores regelsystem bruge varens SKU og/eller productId til bedre at afgøre, om varen faktisk er begrænset til destinationslandet. For de bedste resultater, send venligst så mange oplysninger som muligt i detailedDescription feltet. Eksempelværdi: “Tory Burch, Robinson – Double Zip’ Tote, farve: New Carnival, materialeindhold: læder, Farverigt læder giver en iøjnefaldende appel til en pænt struktureret tote, toppet med logo hardware og rullede håndtag for et helt sofistikeret look. Magnetisk snaplukning med dobbelte lynlåslommer. Indvendige lynlåse, væg- og mobiltelefonlommer. Beskyttende metalfødder. Læder. Af Tory Burch; importeret.” |
items[index].height | Dette er din vares højde. Der er et andet felt kaldet dimensionalUnits , hvor du angiver tommer eller centimeter for denne måling. Angiv venligst uden kommaer og med højst to decimaler. Eksempelværdi: 25.5 Dine forsendelsespriser vil være de mest nøjagtige, hvis du angiver dette felt. |
items[index].hsCode | Dette er HS-koden, der identificerer varen over for fremmede lande. At angive hsCode vil hjælpe med korrekt at identificere den rette importafgift rate for den specifikke vare. Ikke påkrævet, hvis den ikke er tilgængelig – vi vil tage os af det, hvis du ikke har det. Format: Enten en 10-cifret eller 6-cifret kode; kan inkludere de adskillede “.” tegn eller ej. Eksempelværdier: “20.4560.0000” eller “20.4560” eller “204560” (enten 10 eller 6 cifrede koder er acceptable) |
items[index].length | Dette er din vares længde. Der er et andet felt kaldet dimensionalUnits , hvor du angiver tommer eller centimeter for denne måling. Angiv venligst uden kommaer og med højst to decimaler. Eksempelværdi: 25.5 Dine forsendelsespriser vil være de mest nøjagtige, hvis du angiver dette felt. |
items[index].productId | Dette er dit produkt-id for den specifikke vare. Vores regelsystem vil bruge denne værdi som et ID til at knytte lærte vareoplysninger til din vare. Eksempelværdi: “17898-675235” Angiv venligst mindst productID eller SKU. At angive begge er at foretrække. |
items[index].quantity REQUIRED | Dette er mængden, der købes af den specifikke vare. Angiv venligst som et positivt heltal, uden kommaer og uden decimaler. Eksempelværdier: 1 eller 9999 (vi foretrækker, at du sælger flere varer end færre!) |
items[index].sku | Dette er din SKU for den specifikke vare. Vores regelsystem vil bruge denne værdi som et ID til at knytte lærte vareoplysninger til din vare. Eksempelværdi: “oakley-125” Angiv venligst mindst productId eller SKU. At angive begge er at foretrække. |
items[index].unitPrice REQUIRED | Dette er din vares enhedspris i USD (amerikanske dollars). Angiv venligst uden kommaer, uden dollartegn “$”, og med to decimaler. Eksempelværdi: 2102.99 |
items[index].weight | Dette er vægten af din vare. Der er et andet felt kaldet weightUnits , hvor du angiver pund, ounce, gram eller kilogram for denne måling. Angiv venligst uden kommaer og med højst to decimaler. Eksempelværdi: 4.2 Dine forsendelsespriser vil være mest nøjagtige, hvis du angiver dette felt. |
items[index].weightUnits | Standardindstillingen er “LB” for pund. Måleenheden for vægtværdien. Hvis den er sat til null, antages “LB” (pund). Eksempelværdier: “LB” for pund eller “OZ” for ounce eller “G” for gram eller “KG” for kilogram eller null |
items[index].width | Dette er bredden af din vare. Der er et andet felt kaldet dimensionalUnits , hvor du angiver tommer eller centimeter for denne måling. Angiv venligst uden kommaer og med højst to decimaler. Eksempelværdi: 25.5 Dine forsendelsespriser vil være mest nøjagtige, hvis du angiver dette felt. |
shipFromAddress | Hvis det angives som null, vil vi bruge en standard shipFromAddress , der er knyttet til din forhandlerkonto. Dette er adressen, som ordren vil blive sendt fra, dvs. dit lager. Dette er et kort, der indeholder følgende adressefelter: address1 , address2 , address3 , city , state , stateCode , postalCode , countryCode . Disse indeholdte felter er påkrævet eller ikke påkrævet, afhængigt af landet. Lokaliseringsendepunktet returnerer, hvilke specifikke adressefelter der er påkrævet for hvert land. Bemærk: stateCode er altid ikke påkrævet og ikke erklæret i lokaliseringsendepunktet. Du kan angive stateCode , hvis det er tilgængeligt. |
shippingAmountOverride | Dette bruges kun, hvis du kender forsendelsesomkostningerne, før du kalder API'en. Det er i USD (amerikanske dollars). Angiv venligst uden kommaer, uden dollartegn “$” og med to decimaler. Denne funktion vil ikke fungere uden at blive opsat med en Zonos repræsentant. Eksempelværdi: 212.99 |
shipToAddress PÅKRÆVET | Dette er adressen, som ordren vil blive sendt til. Dette er et kort, der indeholder følgende adressefelter: name , address1 , address2 , address3 , city , state , stateCode , postalCode , countryCode . Disse indeholdte felter er påkrævet eller ikke baseret på landet. Lokaliseringsendepunktet returnerer, hvilke specifikke adressefelter der er påkrævet for hvert land. Bemærk: name og stateCode er altid ikke påkrævet og ikke erklæret i lokaliseringsendepunktet. Du kan angive name og/eller stateCode , hvis det er tilgængeligt. |
HTTPS svar
Beskedformat: JSON
Eksempel på svar for kun Canada & Australien
Bemærk: Faktiske svar vil indeholde alle understøttede lande.
Eksempelanmodning
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
Felt | Noter |
---|---|
shippingQuotes | Dette er en liste over fragtpriskort. |
shippingQuotes[index].carrier | Den transportør, som fragtprisen er specifik for. Sættes kun til null, hvis forhandleren har bedt om at få generiske fragtprofiler oprettet, ikke specifikt for en transportør. Fragtpriser behøver ikke at være specifikke for en transportør; men kan være det. Kontakt din kontoansvarlige for hjælp til at oprette dine fragtprofiler. Eksempelværdier: UPS eller FEDEX eller DHL eller USPS eller CAPOST eller null |
shippingQuotes[index].displayName | Visningsnavn for fragtmuligheden, egnet til at blive vist for køberen. Disse værdier kan tilpasses for forhandleren. Kontakt din kontoansvarlige for at gøre dette. Eksempelværdi: “Express Air 2-4 Dages Levering” |
shippingQuotes[index].duty | Importafgift beløbet inkluderet i dutyTaxTotal . Dette beløb er i USD, vil ikke indeholde kommaer, og vil indeholde to decimaler. Eksempelværdi: 8.29 |
shippingQuotes[index] .dutyTaxBrokerageFee | Dette er, hvad den udenlandske importmægler vil opkræve dig for at behandle dine importafgifter og skatter. Dette beløb er inkluderet i dutyTaxTotal . Beløbet er i USD, vil ikke indeholde kommaer, og vil indeholde to decimaler. Eksempelværdi: 5.00 |
shippingQuotes[index] .duyTaxCarrierPrepaymentFee | Dette er, hvad transportøren vil opkræve dig for at prepay afgifterne og skatterne til det importerede land. Dette beløb er inkluderet i dutyTaxTotal . Dette beløb er i USD, vil ikke indeholde kommaer, og vil indeholde to decimaler. Eksempelværdi: 5.00 |
shippingQuotes[index] .duyTaxEnabled | Om denne fragtpris giver køberen mulighed for at prepay deres importafgifter og skatter. Hvis det er sat til false, skal dutyTaxTotal ignoreres. Eksempelværdier: true eller false |
shippingQuotes[index] .duyTaxForced | Om denne fragtpris tvinger køberen til at prepay deres importafgifter og skatter. Hvis det er sat til true, skal du inkludere dutyTaxTotal i ordren og forklare køberen, at det er påkrævet med denne specifikke fragtmulighed. Hvis det er sat til false, kan du tillade køberen at vælge, om de vil prepay deres importafgifter og skatter. Eksempelværdier: true eller false |
shippingQuotes[index].dutyTaxTotal | Den samlede omkostning for afgift og skat for den givne fragtpris. Afgift og skat kan være valgfrie, ikke tilgængelige eller tvungne for den givne fragtpris. Dette beløb er ikke inkluderet i shippingTotal . Dette beløb er i USD, vil ikke indeholde kommaer, og vil indeholde to decimaler. Eksempelværdi: 19.55 |
shippingQuotes[index] .dutyTaxUnderDeMinimis | Om ordren samlet set, ved brug af denne specifikke fragtmulighed, er under både skatte/VAT de minimis beløbet og afgift de minimis beløbet. Hvis det er sat til true, vil dutyTaxTotal blive sat til 0.00, og du skal informere kunden om, at der ikke vil være nogen importafgifter eller skatter for deres ordre. Derudover skal du tvinge forudbetaling af afgifter og skatter, fordi omkostningen er 0.00. |
shippingQuotes[index].id | En identifikator for den specifikke fragtpris; en 36-tegns UUID. Eksempelværdi: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | Dette er en liste over kort, der indeholder oplysninger om eventuelle varer i indkøbskurven, der er begrænsede ved hjælp af dette specifikke forsendelsestilbud. Hver begrænset vare har en reasonCode . Årsagen kan være specifik for forsendelsesmuligheden eller ej. Nogle grunde til varebegrænsninger skyldes landets importlove, brandbegrænsninger eller endda regler oprettet af forhandleren. Hver gang en forsendelsesmulighed vælges af køberen, skal indkøbskurvsvarerne krydsrefereres med forsendelsestilbudets restrictedItems liste. Hvis nogen af indkøbskurvsvarerne er begrænsede, skal der vises en besked til køberen, og de begrænsede vare(r) skal fjernes fra ordrenes total osv. |
shippingQuotes[index] .restrictedItems[index].cartItemId | Dette er cartItemId fra anmodningens JSON for en begrænset indkøbskurvsvare. Du skal kunne knytte dette cartItemId tilbage til en specifik vare i din købers indkøbskurv. Eksempelværdier: 1 eller 2 eller 3 |
shippingQuotes[index] .restrictedItems[index].message | Dette er en besked, der kan vises til køberen om, hvorfor varen er begrænset. Disse beskeder kan tilpasses af forhandleren. Kontakt venligst din Zonos repræsentant for detaljer. Eksempelværdi: “Vi kan ikke sælge Oakley-produkter til dit land.” |
shippingQuotes[index] .restrictedItems[index].reasonCode | Dette er årsagskoden for, at varen er begrænset. Begrænsninger er altid landespecifikke, og vores årsagskoder gør det tydeligt. Eksempelværdier: BRAND_COUNTRY eller IMPORT_COUNTRY eller EXPORT_COUNTRY eller CARRIER_COUNTRY eller MERCHANT_COUNTRY . BRAND_COUNTRY betyder, at du har angivet, at du ikke kan sælge et brand til et specifikt sæt af lande. IMPORT_COUNTRY betyder, at det importerede land ikke vil tillade varen at blive importeret. EXPORT_COUNTRY betyder, at det eksporterende land (normalt USA) ikke vil tillade varen at blive eksporteret. CARRIER_COUNTRY betyder, at den specifikke transportør ikke vil transportere varen. MERCHANT_COUNTRY betyder, at du har oprettet en brugerdefineret begrænsningsregel, som varen har udløst. |
shippingQuotes[index] .shippingTotal | Den samlede omkostning ved forsendelse for det givne forsendelsestilbud. Forsendelsestilbud kan også have et dutyTaxTotal beløb, som ikke er inkluderet i denne shippingTotal . Dette beløb er i USD, vil ikke indeholde kommaer og vil indeholde to decimaler. Eksempelværdi: 25.82 |
shippingQuotes[index].taxOrVat | Skatte- eller momsbeløbet inkluderet i dutyTaxTotal . For nogle lande er dette en skat; for andre er det en moms. Dette beløb er i USD, vil ikke indeholde kommaer og vil indeholde to decimaler. Eksempelværdi: 4.35 |
Landed Cost API Legacy
Learn how the Legacy Landed Cost API works.Oplysningerne nedenfor er for vores legacy Landed Cost API. Se vores Landed Cost API for den nyeste version.
Shipping-quotes endpointet accepterer oplysninger om din shoppers kurv, returnerer fragtpriser inklusive importafgifter og skatter, og screener varerne for restriktioner. Disse returnerede fragtpriser er baseret på fragtprofiler, der er oprettet før brugen af dette API-endpoint.
Vi har standard fragtprofiler til testformål, men du skal arbejde sammen med din Account Manager for at oprette de faktiske fragtprofiler og indstillinger, som din virksomhed ønsker at bruge.