Få forsendelsesmetoder baseret på adresse og pakkens parametre.

Returnerer en liste over returneringsmetoder for en given partner med yderligere parametre som tilgængelighed.

POST /v1/shipping-methods/quote

Eksempel på anmodning

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

Eksempel på succesfuldt svar

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

Eksempel på fejlmeddelelse

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

Anmodning

Parameter	Type	Beskrivelse
orderReferenceId (påkrævet)	streng	Unikt ID til forsendelsesordren. ID'et leveres af dig.
valuta (påkrævet)	streng	Valutaen for forsendelsesordren i 3-bogstavsformat.
muligheder (valgfrit)	Valgmuligheder	Valgfrie parametre.
partner (valgfrit)	Partner	Oplysninger om partneren.
modtager (påkrævet)	Modtager	Modtageroplysninger.
afsender (påkrævet)	Afsender	Afsenderoplysninger.
pakker (påkrævet)	Pakke[]	Pakkedetaljer.

Valgmuligheder

Parameter	Type	Beskrivelse
weightUnit (valgfrit)	streng	Vægtenhed. Tilgængelige valg: g, kg, oz, lb. Standard: g.
dimensionsenhed (valgfrit)	streng	Længdeenhed. Tilgængelige valg: mm, cm, in. Som standard: mm.
etiket (valgfrit)	Etiket	Indstillinger for etiketformat.

Etiket

Parameter	Type	Beskrivelse
format (valgfrit)	streng	Etiketformat. Tilgængelige valg: pdf, zpl (). Standard: pdf*.

Bemærk: Andre formater end pdf er muligvis ikke aktiveret for bestemte fragtfirmaer.

Partner

Parameter	Type	Beskrivelse
Kundens navn (valgfrit)	streng	Forsendelse af kundeprofil. Bruges til at inkludere et brandnavn på etiketten (baseret på fragtfirmaets specifikationer).

Modtager

Parameter	Type	Beskrivelse
person (påkrævet)	ReceiverPerson	Personlige oplysninger om modtageren.
adresse (påkrævet)	Adresse	Modtagerens adresseoplysninger.
Tilpasninger (valgfrit)	ReceiverCustoms	Modtagerens toldoplysninger.

Afsender

Parameter	Type	Beskrivelse
person (påkrævet)	SenderPerson	Afsenderens personlige oplysninger.
adresse (påkrævet)	Adresse	Afsenderens adresseoplysninger.
told (kræves til international forsendelse)	Afsender told	Afsenderens toldoplysninger.

ReceiverPerson

Parameter	Type	Beskrivelse
Fornavn (påkrævet)	streng	Modtagerens fornavn.
Efternavn (påkrævet)	streng	Modtagerens efternavn.
virksomhed (valgfrit)	streng	Virksomhedens navn.
e-mail (valgfrit)*	streng	Personens e-mailadresse. Dette kan bruges til forsendelsesmeddelelser.
telefon (valgfrit)*	streng	Telefonnummer på personen. Dette kan bruges til forsendelsesmeddelelser.

Bemærk: *E-mail og telefon kan være et obligatorisk felt afhængigt af fragtfirmaet

SenderPerson

Parameter	Type	Beskrivelse
Fornavn (valgfrit)	streng	Afsenderens fornavn.
Efternavn (valgfrit)	streng	Afsenderens efternavn.
virksomhed (påkrævet)	streng	Afsenderens firmanavn.
e-mail (valgfrit)*	streng	Afsenderens e-mailadresse (person/virksomhed).
telefon (valgfrit)*	streng	Telefonnummer på afsenderen / virksomheden.

Bemærk: *E-mail og telefon kan være et obligatorisk felt afhængigt af fragtfirmaet

Adresse

Parameter	Type	Beskrivelse
land (påkrævet)	streng	Landekode i 2-bogstavsformat.
stat (valgfrit)*	streng	Stat / amt / region.
by (påkrævet)	streng	By.
postnummer (påkrævet)	streng	Postnummer.
addressLine1 (påkrævet)	streng	Første linje i postadressen. Skal indeholde gade og husnummer.
adresse linje 2 (valgfrit)	streng	Anden linje i postadressen. Lejligheds-/kontor-/etagenummer.
adresse linje 3 (valgfrit)	streng	Tredje linje i postadressen.
gade (valgfrit)*	streng	Gade (påkrævet for tyske adresser).
Husnummer (valgfrit)*	streng	Husnummer (påkrævet for tyske adresser).
forstad (valgfrit)*	streng	Forstad (påkrævet for AU/NZ-adresser).

Bemærk: *Disse valgfrie felter er påkrævet for bestemte lande og transportører.

ReceiverCustoms

Parameter	Type	Beskrivelse
vatNumber (valgfrit)	streng	Modtagerens momsnummer.

Afsenderens toldoplysninger

Parameter	Type	Beskrivelse
Momsnummer (valgfrit)*	streng	Afsenderens momsnummer.
ioss-nummer (valgfrit)*	streng	Afsenderens IOSS-nummer.
EORI-nummer (valgfrit)*	streng	Afsenderens EORI-nummer.
pcccNumber (valgfrit)*	streng	PCCC-nummer på afsenderen.
Australian business number (valgfrit)*	streng	Australsk virksomhedsnummer på afsenderen.

Bemærk: *Afhængigt af afsender- og modtagerland kan disse felter være påkrævet.

Pakke

Parameter	Type	Beskrivelse
packageReferenceId (påkrævet)	streng	Partnerens ID på pakken.
Bruttovægt (påkrævet)	nummer	Emballagens vægt + varens vægt (i gram som standard).
netto vægt (valgfrit)	nummer	Vægten af varerne (i gram som standard).
Længde (påkrævet)	nummer	Pakkens længde (i mm som standard).
bredde (påkrævet)	nummer	Pakkens bredde (i mm som standard).
højde (påkrævet)	nummer	Højden på pakken (i mm som standard).
volumetrisk vægt (valgfrit)	nummer	Vægten beregnes ud fra pakkens størrelse (som standard i gram).
boxType (valgfrit)	streng	Formen på æsken (f.eks. rektangel, rør).
værdi (påkrævet for international forsendelse)	nummer	Den samlede værdi af alle varer i pakken (i den valgte valuta).
varer (påkrævet til international forsendelse)	Vare[]	Liste over varer i pakken.

Vare*

Parameter	Type	Beskrivelse
itemReferenceId (påkrævet)	streng	Partnerens ID på pakkeelementet.
Beskrivelse (påkrævet)	streng	Beskrivelse af varen.
antal (påkrævet)	nummer	Antal af varen.
værdi (påkrævet)	nummer	Værdien af varen (i den valgte valuta).
vægt (påkrævet)	nummer	Vægten af varen (som standard i gram ).
hsCode (påkrævet)	streng	Harmonized System Code (Wiki).
countryOfOrigin (påkrævet)	streng	Landskode i 2-bogstavsformat, hvor varen blev produceret.

Bemærk: *Alle vareparametre er kun nødvendige for international forsendelse.

Vellykket svar

Parameter	Type	Beskrivelse
antal	nummer	Antal fundne resultater.
genstande	ResponseItems	Et udvalg af citater

ResponseItems

Parameter	Type	Beskrivelse
fragtfirma	ResponseItemsCarrier	Oplysninger om fragtfirma.
metode	ResponseItemsMethod	Detaljer om forsendelsesmetode.

ResponseItemsCarrier

Parameter	Type	Beskrivelse
fragtfirma	streng	Forsendelsesudbyder brugt til ordren.
uid	streng	Forsendelsesmetode brugt til ordren.

ResponseItemsMethod

Parameter	Type	Beskrivelse
navn	streng	Navn på forsendelsesmetode.
uid	streng	UID for forsendelsesmetode.
pris	nummer	Anslået pris for leveringsmetode for partner.
maxShipmentDays	nummer	Maksimalt antal forsendelsesdage forsendelsesmetode.
minShipmentDays	nummer	Forsendelsesmetode min. forsendelsesdage.
deliveryPaddingDays (valgfrit)	nummer	Forsendelsesmetodens leveringstid i dage.

Fejlmeddelelse

Parameter	Type	Beskrivelse
ordrereference-id	streng	Unikt ID for forsendelsesordren, som du har angivet.
kode	streng	Fejlkode.
besked	streng	Fejlmeddelelse.
detalje (valgfrit)	ting	Detaljeret fejlmeddelelse (JSON-objekt med en vilkårlig struktur).
fejl (valgfrit)	ResponseErrorDetails[]	Array af fejl.