Landed Cost API Legacy

Lær hvordan Legacy Landed Cost API fungerer.

Informasjonen nedenfor gjelder vår legacy Landed Cost API. Se vår Landed Cost API for den nyeste versjonen.

Shipping-quotes-endepunktet aksepterer detaljer om shopperens handlekurv, returnerer fraktpriser med importavgifter og skatter, og sjekker varene for restriksjoner. Disse returnerte fraktprisene er basert på fraktprofiler som er satt opp før bruken av dette API-endepunktet.

Vi har standard fraktprofiler for testformål, men du må samarbeide med din kontoansvarlige for å sette opp de faktiske fraktprofilene og innstillingene som selskapet ditt ønsker å bruke.

Endepunkter

Be om fraktpriser

POST | https://api.iglobalstores.com/2.0/shipping-quotes - Opprett en ny forespørsel om fraktpriser på varer i handlekurven som inkluderer importavgifter og skatter pluss informasjon om screening av varebegrensninger.

HTTPS-forespørsel

Felt	Notater
HTTP-metode	POST
Endepunkt-URL	`https://api.iglobalstores.com/2.0/shipping-quotes`
Protokoll	HTTPS
Meldingsformat	JSON
Aksepter HTTP-header	Accept: application/json
Sikkerhetstoken HTTP-header	serviceToken: your-test-token-valueLegg til en header til din HTTPS-forespørsel med navnet serviceToken med en verdi av din Test Security API Token. (Kontakt din kontoansvarlige for denne token)
Content-Type HTTP-header	Content-Type: application/jsonFordi du vil sende JSON-data til tjenesten, legg til en header til din HTTPS-forespørsel med navnet Content-Type med en verdi av application/json

JSON NØKKEL/VERDI PAR i forespørselens kropp

Meldingsformat: JSON

Eksempel på forespørsel

{
  "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"
  }
}

Definisjoner av forespørsel JSON

Felt	Merknader
`boxCount`	Dette feltet beskriver boksene som vil bli brukt til å sende bestillingen. Det forventes ikke at en selger vet dette ved bestillingstidspunktet; men hvis det er kjent, kan det sendes i følgende spesifikke format.Eksempelverdi: 22x15x15(1),8x8x4(2),32x22x14(1)Format: Komma-separert liste over boksdimensjoner og antall. I eksempelet ovenfor er det totalt 4 bokser. Den første boksen i listen vil være 22 tommer lang, 15 tommer bred og 15 tommer høy. Det vil bare bli brukt en boks av den størrelsen. Det vil være to bokser av størrelse 8x8x4 tommer. Det er akseptabelt å sende den samme boksdimensjonen flere ganger hvis det er enkelt for deg, som dette: "22x15x15(1),22x15x15(1)", som betyr 2 bokser av størrelse 22x15x15 tommer.
`items` OBLIGATORISK	En liste over varekart
`items[index].brandName`	Merkenavnet på den spesifikke varen vil hjelpe vår regelmotor med å bestemme om det gjelder en begrensning for varen til destinasjonslandet.Selv om et varemerkes navn samsvarer eller ikke samsvarer tekstlig med en spesifikk begrensning, vil vår regelmotor bruke varens SKU og/eller `productId` for å bedre avgjøre om varen faktisk er begrenset til destinasjonslandet. Vennligst send merkenavnet hvis tilgjengelig.Eksempelverdier: "Oakley" eller "Nike" eller null
`items[index].cartItemId` OBLIGATORISK	Dette feltet er nødvendig for å identifisere varen, spesifikt innen listen over varer. Det kan være så enkelt som en indeksverdi. Vi vil bruke dette `cartItemId` for å identifisere en vare hvis den er begrenset i JSON-responsen. Sørg for at du kan identifisere den samme varen i handlekurven din ved hjelp av dette `cartItemId` du sender til oss.Eksempelverdier: 1 eller 2 eller 3
`items[index].category`	Produktkategoriene - det spesifikke produktet det er en del av. Kategorien vil hjelpe vår regelmotor med å bestemme om det gjelder en begrensning for varen til destinasjonslandet.Selv om en vares kategori samsvarer eller ikke samsvarer tekstlig med en spesifikk begrensning, vil vår regelmotor bruke varens SKU og/eller `productId` for å bedre avgjøre om varen faktisk er begrenset til destinasjonslandet.Format: En pipe-separert liste over kategorinavn. Hvert kategorinavn kan være ett eller flere ord. Hvis en vare eksisterer i mer enn én kategori, vennligst oppgi begge separert med en pipe "" tegn.Eksempelverdier: "Sunglasses" eller "Evening AccessoriesHandbags"
`items[index].countryOfOrigin`	Opprinnelseslandet er landet varen ble laget i eller opprinnelig kom fra. Opprinnelseslandet vil hjelpe vår regelmotor med å bestemme om en restriksjon gjelder for varen for destinasjonslandet. Noen land tillater ikke spesifikke typer varer fra andre spesifikke land. Eksempelverdier: “CN” for Kina eller “US” for USA eller null
`items[index].detailedDescription` REQUIRED	Dette feltet er rett og slett tekst, men bør inkludere så mye informasjon som mulig om varen som kjøpes. For eksempel, fullt navn og varekode hvis aktuelt, farge eller andre valgte alternativer, materialinnhold, og eventuell beskrivelsestekst du har for varen. Det finnes mange forskjellige typer importrestriksjoner til utenlandske land, som lær sko til Italia. Noen ganger er den eneste måten å fange opp disse begrensede varene på gjennom `detailedDescription`. Merk: Selv om en vares `detailedDescription` tekstuelt matcher eller ikke matcher en spesifikk restriksjon, vil vår regelmotor bruke varens SKU og/eller `productId` for bedre å avgjøre om varen faktisk er begrenset til destinasjonslandet. For best resultat, vennligst send så mye informasjon som mulig i `detailedDescription`-feltet. Eksempelverdi: “Tory Burch, Robinson – Double Zip’ Tote, farge: New Carnival, materialinnhold: lær, Farge-rik lær gir iøynefallende appell til en pent strukturert tote, toppet med logo hardware og rullede håndtak for et helt sofistikert utseende. Magnetisk-lukking med doble glidelåslommer. Innvendig glidelås, vegg- og mobiltelefonlommer. Beskyttende metallføtter. Lær. Av Tory Burch; importert.”
`items[index].height`	Dette er høyden på varen din. Det finnes et annet felt som heter `dimensionalUnits`, hvor du spesifiserer tommer eller centimeter for denne målingen. Vennligst oppgi uten komma og med ikke mer enn to desimaler. Eksempelverdi: 25.5 Dine fraktpriser vil være mest nøyaktige hvis du oppgir dette feltet.
`items[index].hsCode`	Dette er HS-koden som identifiserer varen for utenlandske land. Å sende `hsCode` vil hjelpe med å identifisere riktig importavgift rate for den spesifikke varen. Ikke nødvendig hvis ikke tilgjengelig – vi tar oss av det hvis du ikke har det. Format: Enten en 10-sifret eller 6-sifret kode; kan inkludere de separerende “.” tegnene eller ikke. Eksempelverdier: “20.4560.0000” eller “20.4560” eller “204560” (både 10- eller 6-sifrede koder er akseptable)
`items[index].length`	Dette er lengden på varen din. Det finnes et annet felt som heter `dimensionalUnits`, hvor du spesifiserer tommer eller centimeter for denne målingen. Vennligst oppgi uten komma og med ikke mer enn to desimaler. Eksempelverdi: 25.5 Dine fraktpriser vil være mest nøyaktige hvis du oppgir dette feltet.
`items[index].productId`	Dette er produkt-ID-en for den spesifikke varen. Vår regelmotor vil bruke denne verdien som en ID for å knytte lærte vareinformasjon til varen din. Eksempelverdi: “17898-675235” Vennligst oppgi minst `productID` eller SKU. Å sende begge er foretrukket.
`items[index].quantity` REQUIRED	Dette er antallet som kjøpes av den spesifikke varen. Vennligst oppgi som et positivt heltall, uten komma og uten desimaler. Eksempelverdier: 1 eller 9999 (vi foretrekker at du selger flere varer enn færre!)
`items[index].sku`	Dette er din SKU for den spesifikke varen. Vår regelmotor vil bruke denne verdien som en ID for å knytte lærte vareinformasjon til varen din. Eksempelverdi: “oakley-125” Vennligst oppgi minst `productId` eller SKU. Å sende begge er foretrukket.
`items[index].unitPrice` REQUIRED	Dette er enhetsprisen for varen din i USD (amerikanske dollar). Vennligst oppgi uten komma, uten dollartegn “$”, og med to desimaler. Eksempelverdi: 2102.99
`items[index].weight`	Dette er vekten på varen din. Det er et annet felt som heter `weightUnits`, hvor du spesifiserer pund, unser, gram eller kilogram for denne målingen. Vennligst oppgi uten komma og med ikke mer enn to desimaler.Eksempelverdi: 4.2Dine fraktpriser vil være mest nøyaktige hvis du oppgir dette feltet.
`items[index].weightUnits`	Standardverdi er “LB” for pundEnheten for vekten. Hvis den settes til null, vil “LB” (pund) bli antatt.Eksempelverdier: “LB” for pund eller “OZ” for unser eller “G” for gram eller “KG” for kilogram eller null
`items[index].width`	Dette er bredden på varen din. Det er et annet felt som heter `dimensionalUnits`, hvor du spesifiserer tommer eller centimeter for denne målingen. Vennligst oppgi uten komma og med ikke mer enn to desimaler.Eksempelverdi: 25.5Dine fraktpriser vil være mest nøyaktige hvis du oppgir dette feltet.
`shipFromAddress`	Hvis det sendes som null, vil vi bruke en standard `shipFromAddress` knyttet til din selgerkonto. Dette er adressen varen vil bli sendt fra, dvs. ditt lager.Dette er et kart som inneholder følgende adressefelt: `address1`, `address2`, `address3`, `city`, `state`, `stateCode`, `postalCode`, `countryCode`. Disse feltene er påkrevd eller ikke påkrevd, avhengig av landet. Lokaliseringsepunktet returnerer hvilke spesifikke adressefelt som er påkrevd for hvert land.Merk: `stateCode` er alltid ikke påkrevd og ikke deklarert i lokaliseringsepunktet. Du kan sende `stateCode`, hvis tilgjengelig.
`shippingAmountOverride`	Dette brukes kun hvis du kjenner fraktkostnaden før du kaller API-en. Det er i USD (amerikanske dollar).Vennligst oppgi uten komma, uten dollartegn “$”, og med to desimaler. Denne funksjonen vil ikke fungere uten å sette den opp med en Zonos representant. Eksempelverdi: 212.99
`shipToAddress` PÅKREVD	Dette er adressen varen vil bli sendt til. Dette er et kart som inneholder følgende adressefelt: `name`, `address1`, `address2`, `address3`, `city`, `state`, `stateCode`, `postalCode`, `countryCode`. Disse feltene er påkrevd eller ikke, avhengig av landet. Lokaliseringsepunktet returnerer hvilke spesifikke adressefelt som er påkrevd for hvert land.Merk: `name` og `stateCode` er alltid ikke påkrevd og ikke deklarert i lokaliseringsepunktet. Du kan sende `name` og/eller `stateCode`, hvis tilgjengelig.

HTTPS-respons

Meldingsformat: JSON

Eksempelrespons for kun Canada & Australia

Merk: Faktiske svar vil inneholde alle støttede land.

Eksempel på forespørsel

{
  "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
    }
  ]
}

Respons JSON-definisjoner

Felt	Notater
`shippingQuotes`	Dette er en liste over fraktpris kart.
`shippingQuotes[index].carrier`	Fraktselskapet som fraktprisen er spesifikk for. Settes kun til null hvis selgeren har bedt om å få opprettet generiske fraktprofiler, ikke spesifikke for et fraktselskap. Fraktpriser trenger ikke å være spesifikke for et fraktselskap; men kan være det. Kontakt din kontoansvarlig for hjelp med å sette opp fraktprofilene dine. Eksempelverdier: `UPS` eller `FEDEX` eller `DHL` eller `USPS` eller `CAPOST` eller null
`shippingQuotes[index].displayName`	Vist navn for fraktalternativet, egnet for å vises til kunden. Disse verdiene kan tilpasses for selgeren. Kontakt din kontoansvarlig for å gjøre det. Eksempelverdi: “Express Air 2-4 Dagers Levering”
`shippingQuotes[index].duty`	Importavgiftsbeløpet inkludert i `dutyTaxTotal`. Dette beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 8.29
`shippingQuotes[index]` `.dutyTaxBrokerageFee`	Dette er hva den utenlandske importøren vil kreve for å behandle importavgifter og skatter. Dette beløpet er inkludert i `dutyTaxTotal`. Beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 5.00
`shippingQuotes[index]` `.duyTaxCarrierPrepaymentFee`	Dette er hva fraktselskapet vil kreve for å prepay avgiftene og skattene til importlandet. Dette beløpet er inkludert i `dutyTaxTotal`. Dette beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 5.00
`shippingQuotes[index]` `.duyTaxEnabled`	Om denne fraktprisen gjør det mulig for kunden å prepay importavgiftene og skattene. Hvis satt til false, bør `dutyTaxTotal` ignoreres. Eksempelverdier: true eller false
`shippingQuotes[index]` `.duyTaxForced`	Om denne fraktprisen tvinger kunden til å prepay importavgiftene og skattene. Hvis satt til true, bør du inkludere `dutyTaxTotal` i bestillingen, og forklare for kunden at det er nødvendig med dette spesifikke fraktalternativet. Hvis satt til false, kan du la kunden velge om de vil prepay importavgiftene og skattene. Eksempelverdier: true eller false
`shippingQuotes[index].dutyTaxTotal`	Den totale kostnaden for avgift og skatt for den gitte fraktprisen. Avgift og skatt kan være valgfrie, ikke tilgjengelige, eller tvungne for den gitte fraktprisen. Dette beløpet er ikke inkludert i `shippingTotal`. Dette beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 19.55
`shippingQuotes[index]` `.dutyTaxUnderDeMinimis`	Om totalen for bestillingen, ved bruk av dette spesifikke fraktalternativet, er under både avgifts/VAT de minimis beløpet og avgifts de minimis beløpet. Hvis satt til true, vil `dutyTaxTotal` settes til 0.00, og du bør informere kunden om at det ikke vil være noen importavgifter eller skatter på deres bestilling. I tillegg, tving forhåndsbetaling av avgifter og skatter, fordi kostnaden er 0.00.
`shippingQuotes[index].id`	En identifikator for den spesifikke fraktprisen; en 36-tegn UUID. Eksempelverdi: `bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a`
`shippingQuotes[index].restrictedItems`	Dette er en liste over kart, som inneholder detaljer om eventuelle varer i handlekurven som er begrenset ved hjelp av dette spesifikke frakttilbudet. Hver begrenset vare har en `reasonCode`. Årsaken kan være spesifikk for fraktalternativet eller ikke. Noen grunner til varebegrensninger skyldes importlover i landet, merkevarebegrensninger eller til og med regler opprettet av selgeren. Hver gang et fraktalternativ velges av kunden, bør handlekurvvarene kryssrefereres mot frakttilbudets `restrictedItems`-liste. Hvis noen av handlekurvvarene er begrenset, bør en melding vises til kunden, og den(e) begrensede varen(e) bør fjernes fra totalen for bestillingen, osv.
`shippingQuotes[index]` `.restrictedItems[index].cartItemId`	Dette er `cartItemId` fra forespørselens JSON for en begrenset handlekurvvare. Du bør kunne knytte denne `cartItemId` tilbake til en spesifikk vare i kundens handlekurv. Eksempelverdier: 1 eller 2 eller 3
`shippingQuotes[index]` `.restrictedItems[index].message`	Dette er en melding som kan vises til kunden om hvorfor varen er begrenset. Disse meldingene kan tilpasses av selgeren. Vennligst kontakt din Zonos representant for detaljer. Eksempelverdi: “Vi kan ikke selge Oakley-produkter til ditt land.”
`shippingQuotes[index]` `.restrictedItems[index].reasonCode`	Dette er årsakskoden for at varen er begrenset. Begrensninger er alltid landsspesifikke, og våre årsakskoder gjør det åpenbart. Eksempelverdier: `BRAND_COUNTRY` eller `IMPORT_COUNTRY` eller `EXPORT_COUNTRY` eller `CARRIER_COUNTRY` eller `MERCHANT_COUNTRY`. `BRAND_COUNTRY` betyr at du har spesifisert at du ikke kan selge et merke til et spesifikt sett av land. `IMPORT_COUNTRY` betyr at importlandet ikke vil tillate varen å bli importert. `EXPORT_COUNTRY` betyr at eksportlandet (vanligvis USA) ikke vil tillate varen å bli eksportert. `CARRIER_COUNTRY` betyr at den spesifikke transportøren ikke vil frakte varen. `MERCHANT_COUNTRY` betyr at du har satt opp en tilpasset restriksjonsregel som varen har utløst.
`shippingQuotes[index]` `.shippingTotal`	Den totale kostnaden for frakt for det gitte frakttilbudet. Frakttilbud kan også ha et `dutyTaxTotal` beløp, som ikke er inkludert i denne `shippingTotal`. Dette beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 25.82
`shippingQuotes[index].taxOrVat`	Skatte- eller MVA-beløpet inkludert i `dutyTaxTotal`. For noen land er dette en skatt; for andre er det en MVA. Dette beløpet er i USD, vil ikke inneholde komma, og vil inneholde to desimaler. Eksempelverdi: 4.35

Var denne siden nyttig?

Spørsmål?

Kontakt oss.

Se Zonos

retningslinjer og avtaler