Hämta leveransmetoder baserat på adress och paketparametrar.

Returnerar en lista över returalternativ för en given partner med ytterligare parametrar som tillgänglighet.

POST /v1/shipping-methods/quote

Exempel på förfrågan

{  "orderReferenceId": "EXMPL0001234",  "currency": "EUR",  "options": {    "weightUnit": "g",    "dimensionUnit": "mm",    "label": {      "format": "pdf"    }  },  "partner": {    "clientName": "ExampleCustomer"  },  "receiver": {    "person": {      "firstName": "Foo",      "lastName": "Bar",      "company": "",      "email": "[email protected]",      "phone": "01273552886"    },    "address": {      "country": "GB",      "state": "East Sussex",      "city": "Brighton",      "postcode": "BN1 8YQ",      "addressLine1": "11 London Rd",      "addressLine2": "",      "addressLine3": "",      "street": "London Rd",      "houseNumber": "11",      "suburb": null    },    "customs": {      "vatNumber": null    }  },  "sender": {    "person": {      "firstName": "",      "lastName": "",      "company": "Example Company",      "email": "[email protected]",      "phone": "01666 123456"    },    "address": {      "country": "DE",      "state": "",      "city": "Donauwörth",      "postcode": "86609",      "addressLine1": "Am Wassergraben 11",      "addressLine2": null,      "addressLine3": null,      "street": "Am Wassergraben",      "houseNumber": "11",      "suburb": null    },    "customs": {      "vatNumber": "DE123456789000",      "iossNumber": null,      "eoriNumber": "GB987654321000",      "pcccNumber": null,      "australianBusinessNumber": null    }  },  "packages": [    {      "packageReferenceId": "EXMPL0001234-0-1",      "grossWeight": 810,      "netWeight": 760,      "length": 229,      "width": 200,      "height": 36,      "boxType": "rectangle",      "volumetricWeight": 700,      "items": [        {          "itemReferenceId": "EXMPL0001234-0-1-ITEM1",          "description": "Mug",          "value": 48,          "quantity": 4,          "weight": 760,          "hsCode": "44199090",          "countryOfOrigin": "DE"        }      ]    }  ]}

Exempel på lyckad respons

{  "items": [    {      "carrier": {        "name": "DHL",        "uid": "dhl"      },      "method": {        "name": "DHL Global Parcel",        "uid": "dhl_global_parcel",        "price": 3.32,        "maxShipmentDays": 5,        "minShipmentDays": 2,        "deliveryPaddingDays": 0      }    },    {      "carrier": {        "name": "UPS",        "uid": "ups"      },      "method": {        "name": "UPS Standard Tariff",        "uid": "ups_standard_tariff",        "price": 5.25,        "maxShipmentDays": 5,        "minShipmentDays": 2,        "deliveryPaddingDays": 0      }    }  ],  "count": 2}

Exempel på felmeddelande

{  "orderReferenceId": "EXMPL0001234",  "code": "VALIDATION_ERROR",  "message": "There are errors in submitted data",  "errors": [    {      "code": "NO_SUCH_CHOICE_ERROR",      "reference": "options.label.format",      "message": "The value you selected is not a valid choice."    },    {      "code": "IS_BLANK_ERROR",      "reference": "receiver.address.country",      "message": "This value should not be blank."    }  ]}

Begäran

Parameter	Typ	Beskrivning
orderReferenceId (obligatoriskt)	sträng	Unikt ID för leveransorder. ID tillhandahållet av dig.
valuta (obligatoriskt)	sträng	Valutan för leveransordern i 3-bokstavsformat.
alternativ (valfritt)	Alternativ	Valfria parametrar.
partner (valfritt)	Partner	Partnerinformation.
mottagare (obligatoriskt)	Mottagare	Mottagarens uppgifter.
avsändare (obligatoriskt)	Avsändare	Avsändarens uppgifter.
paket (obligatoriskt)	Paket[]	Paketinformation.

Alternativ

Parameter	Typ	Beskrivning
weightUnit (valfritt)	sträng	Viktenhet. Tillgängliga val: g, kg, oz, lb. Standard: g.
dimensionUnit (valfritt)	sträng	Längdenhet. Tillgängliga val: mm, cm, in. Standard: mm.
etikett (valfritt)	Etikett	Inställningar för etikettformat.

Etikett

Parameter	Typ	Beskrivning
format (valfritt)	sträng	Etikettformat. Tillgängliga val: pdf, zpl (). Standard: pdf*.

Obs! Andra format än pdf kanske inte är aktiverade för vissa fraktbolag.

Partner

Parameter	Typ	Beskrivning
Kundnamn (valfritt)	sträng	Kundprofil för frakt. Används för att inkludera ett varumärkesnamn på etiketten (baserat på tillverkarens specifikationer).

Mottagare

Parameter	Typ	Beskrivning
person (obligatoriskt)	ReceiverPerson	Mottagarens personuppgifter.
adress (obligatoriskt)	Adress	Adressuppgifter för mottagaren.
Tull (valfritt)	Mottagarens tull	Mottagarens tulluppgifter.

Avsändare

Parameter	Typ	Beskrivning
Person (obligatoriskt)	AvsändarePerson	Personliga uppgifter om avsändaren.
adress (obligatoriskt)	Adress	Adressuppgifter för avsändaren.
tull (krävs för internationell frakt)	Avsändarens tulluppgifter	Tulluppgifter om avsändaren.

ReceiverPerson

Parameter	Typ	Beskrivning
firstName (obligatoriskt)	sträng	Mottagarens förnamn.
Efternamn (obligatoriskt)	sträng	Mottagarens efternamn.
företag (valfritt)	sträng	Företagets namn.
e-post (valfritt)*	sträng	Personens e-postadress. Den kan användas för leveransaviseringar.
Telefon (valfritt)*	sträng	Personens telefonnummer. Detta kan användas för leveransaviseringar.

Obs! *E-post och telefon kan vara obligatoriska fält beroende på fraktbolag

AvsändarePerson

Parameter	Typ	Beskrivning
Förnamn (valfritt)	sträng	Förnamn på avsändaren.
Efternamn (valfritt)	sträng	Efternamn på avsändaren.
företag (obligatoriskt)	sträng	Namnet på avsändarföretaget.
e-post (valfritt)*	sträng	E-postadress till avsändaren (person/företag).
Telefon (valfritt)*	sträng	Telefonnummer till avsändaren (person/företag).

Obs! *E-post och telefon kan vara obligatoriska fält beroende på fraktbolag

Adress

Parameter	Typ	Beskrivning
land (obligatoriskt)	sträng	Landskod i 2-bokstavsformat.
delstat (valfritt)*	sträng	Stat / län / region.
stad (obligatoriskt)	sträng	Stad.
postnummer (obligatoriskt)	sträng	Postnummer.
addressLine1 (obligatoriskt)	sträng	Första raden i postadressen. Bör innehålla gata och husnummer.
addressLine2 (valfritt)	sträng	Andra raden i postadressen. Lägenhets-/kontors-/våningsnummer.
addressLine3 (valfritt)	sträng	Tredje raden i postadressen.
Gatuadress (valfritt)*	sträng	Gata (obligatoriskt för tyska adresser).
Husnummer (valfritt)*	sträng	Husnummer (obligatoriskt för adresser i Tyskland).
förort (valfritt)*	sträng	Förort (obligatoriskt för adresser i Australien/Nya Zeeland).

Obs! *Dessa valfria fält är obligatoriska för vissa länder och transportörer.

Mottagarens tull

Parameter	Typ	Beskrivning
VAT-nummer (valfritt)	sträng	Mottagarens momsregistreringsnummer.

Avsändarens tulluppgifter

Parameter	Typ	Beskrivning
VAT-nummer (valfritt)*	sträng	Momsregistreringsnummer för avsändaren.
ioss-nummer (valfritt)*	sträng	Avsändarens IOSS-nummer.
EORI-nummer (valfritt)*	sträng	Avsändarens EORI-nummer.
pcccNumber (valfritt)*	sträng	PCCC-nummer för avsändaren.
australianBusinessNumber (valfritt)*	sträng	Australienskt företagsnummer för avsändaren.

Obs! *Beroende på avsändarens och mottagarens land kan dessa fält vara obligatoriska.

Paket

Parameter	Typ	Beskrivning
packageReferenceId (obligatoriskt)	sträng	Partnerns paket-ID.
Bruttovikt (obligatoriskt)	nummer	Förpackningens vikt + varornas vikt (i gram som standard).
netWeight (valfritt)	nummer	Vikten på artiklarna (i gram som standard).
Längd (obligatoriskt)	nummer	Paketets längd (i mm som standard).
bredd (obligatoriskt)	nummer	Förpackningens bredd (i mm som standard).
höjd (obligatoriskt)	nummer	Höjd på förpackning (i mm som standard).
volymvikt (valfritt)	nummer	Vikten beräknas utifrån paketets storlek (i gram som standard).
boxType (valfritt)	sträng	Formen på lådan (t.ex. rektangel, rör).
värde (krävs för internationell frakt)	nummer	Totalt värde för alla artiklar i paketet (i vald valuta).
artiklar (krävs för internationell frakt)	Artikel[]	Lista över artiklar i paketet.

Artikel*

Parameter	Typ	Beskrivning
itemReferenceId (obligatoriskt)	sträng	Partnerns angivna ID för paketartikeln.
Beskrivning (obligatoriskt)	sträng	Beskrivning av artikeln.
antal (obligatoriskt)	nummer	Antal av varan.
värde (obligatoriskt)	nummer	Värdet på varan (i vald valuta).
Vikt (obligatoriskt)	nummer	Vikt på varan (i gram som standard).
hsCode (obligatoriskt)	sträng	Harmonized System Code (Wiki).
ursprungsland (obligatoriskt)	sträng	Landskod i 2-bokstavsformat där varan tillverkades.

Obs! *Alla artikelparametrar krävs endast för internationell frakt.

Lyckad respons

Parameter	Typ	Beskrivning
antal	nummer	Antal resultat som hittades.
föremål	ResponseItems	En lista med offerter

ResponseItems

Parameter	Typ	Beskrivning
fraktbolag	ResponseItemsCarrier	Information om fraktbolag.
metod	ResponseItemsMethod	Detaljer om fraktmetod.

ResponseItemsCarrier

Parameter	Typ	Beskrivning
fraktbolag	sträng	Fraktbolag som används för beställningen.
uid	sträng	Fraktmetod som används för beställningen.

ResponseItemsMethod

Parameter	Typ	Beskrivning
Namn	sträng	Namn på fraktmetod.
uid	sträng	UID för fraktmetod.
pris	nummer	Beräknat pris för leveransmetod för partner.
maxShipmentDays	nummer	Max antal leveransdagar för fraktmetoden.
minShipmentDays	nummer	Minsta antal leveransdagar för fraktmetoden.
deliveryPaddingDays (valfritt)	nummer	Leveransmetodens leveranstid i dagar.

Felmeddelande

Parameter	Typ	Beskrivning
orderReferenceId	sträng	Unikt ID för leveransordern som tillhandahålls av dig.
kod	sträng	Felkod.
meddelande	sträng	Felmeddelande.
detalj (valfritt)	objekt	Detaljerat felmeddelande (JSON-objekt av en godtycklig struktur).
fel (valfritt)	ResponseErrorDetails[]	Array med fel.