Få fraktmetoder basert på adresse og pakkens parametere.

Returnerer en liste over metoder for en gitt partner med tilleggsparametere som tilgjengelighet.

POST /v1/shipping-methods/quote

Eksempel på forespørsel

{  "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å suksessrespons

{  "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å feilmelding

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

Forespørsel

Parameter	Type	Beskrivelse
orderReferenceId (obligatorisk)	streng	Unik ID for fraktordre. ID-en du oppgir.
valuta (obligatorisk)	streng	Valutaen for fraktordren i 3-bokstavsformat.
alternativer (valgfritt)	Valg	Valgfrie parametere.
partner (valgfritt)	Partner	Detaljer om partneren.
mottaker (obligatorisk)	Mottaker	Mottakerens opplysninger.
avsender (obligatorisk)	Avsender	Avsenderens opplysninger.
pakker (påkrevd)	Pakke[]	Detaljer om pakken.

Valg

Parameter	Type	Beskrivelse
vekt (valgfritt)	streng	Vektenhet. Tilgjengelige valg: g, kg, oz, lb. Standard: g.
dimensjonsenhet (valgfritt)	streng	Lengdeenhet. Tilgjengelige valg: mm, cm, in. Standard: mm.
etikett (valgfritt)	Merkeetikett	Innstillinger for etikettformat.

Merkeetikett

Parameter	Type	Beskrivelse
format (valgfritt)	streng	Etikettformat. Tilgjengelige valg: pdf, zpl (). Standard: pdf*.

Merk: Andre formater enn PDF er kanskje ikke aktivert for enkelte fraktselskaper.

Partner

Parameter	Type	Beskrivelse
Kundenavn (valgfritt)	streng	Frakt av kundens profil. Brukes til å inkludere et merkenavn på etiketten (basert på transportørens spesifikasjoner).

Mottaker

Parameter	Type	Beskrivelse
person (obligatorisk)	MottakerPerson	Personlige opplysninger om mottakeren.
adresse (obligatorisk)	Adresse	Adresseopplysninger til mottakeren.
personlig tilpasset (valgfritt)	Mottakerens toll	Mottakerens tollopplysninger.

Avsender

Parameter	Type	Beskrivelse
person (obligatorisk)	SenderPerson	Personlige opplysninger om avsenderen.
adresse (obligatorisk)	Adresse	Adresseopplysninger til avsenderen.
toll (påkrevd for internasjonal frakt)	SenderCustoms	Tollinformasjon om avsenderen.

MottakerPerson

Parameter	Type	Beskrivelse
Fornavn (obligatorisk)	streng	Fornavnet til mottakeren.
Etternavn (obligatorisk)	streng	Etternavnet til mottakeren.
firma (valgfritt)	streng	Firmanavnet.
e-post (valgfritt)*	streng	E-postadressen til personen. Dette kan brukes til fraktvarsler.
telefon (valgfritt)*	streng	Telefonnummeret til personen. Dette kan brukes til fraktvarsler.

Merk: *E-post og telefon kan være obligatoriske felt avhengig av fraktselskap

AvsenderPerson

Parameter	Type	Beskrivelse
Fornavn (valgfritt)	streng	Fornavn på avsenderen.
Etternavn (valgfritt)	streng	Etternavnet til avsenderen.
firma (obligatorisk)	streng	Navnet på avsenderfirmaet.
e-post (valgfritt)*	streng	E-postadressen til avsenderen (person eller selskap).
telefon (valgfritt)*	streng	Telefonnummer til avsenderen / selskapet.

Merk: *E-post og telefon kan være obligatoriske felt avhengig av fraktleverandør

Adresse

Parameter	Type	Beskrivelse
land (obligatorisk)	streng	Landskode i 2-bokstavsformat.
delstat (valgfritt)*	streng	Stat/fylke/region.
by (obligatorisk)	streng	By.
postnummer (obligatorisk)	streng	Postnummer.
adresse 1 (obligatorisk)	streng	Første linje i postadressen. Bør inneholde gate og husnummer.
adresse linje 2 (valgfritt)	streng	Andre linje i postadressen. Leilighets-/kontor-/etasjenummer.
adresse 3 (valgfritt)	streng	Tredje linje i postadressen.
gate (valgfritt)*	streng	Gate (påkrevd for tyske adresser).
Husnummer (valgfritt)*	streng	Husnummer (påkrevd for tyske adresser).
forstad (valgfritt)*	streng	Forstad (påkrevd for adresser i Australia og New Zealand).

Merk: *Disse valgfrie feltene er påkrevd for enkelte land og transportører.

Mottakerens toll

Parameter	Type	Beskrivelse
mva-nummer (valgfritt)	streng	Mva-nummer til mottakeren.

SenderCustoms

Parameter	Type	Beskrivelse
mva-nummer (valgfritt)*	streng	Mva-nummer til avsenderen.
ioss-nummer (valgfritt)*	streng	IOSS-nummer til avsenderen.
EORI-nummer (valgfritt)*	streng	EORI-nummer til avsenderen.
pccc-nummer (valgfritt)*	streng	PCCC-nummer til avsenderen.
australsk bedriftsnummer (valgfritt)*	streng	Australsk forretningsnummer til avsenderen.

Merk: *Avhengig av avsender- og mottakerland kan disse feltene være påkrevd.

Pakke

Parameter	Type	Beskrivelse
packageReferenceId (obligatorisk)	streng	Partnerens ID for pakken.
bruttovekt (obligatorisk)	nummer	Emballasjevekt + varevekt (i gram som standard).
netto vekt (valgfritt)	nummer	Vekten på varene (i gram som standard).
lengde (obligatorisk)	nummer	Lengde på pakken (i mm som standard).
bredde (påkrevd)	nummer	Pakkens bredde (i mm som standard).
høyde (påkrevd)	nummer	Høyde på pakken (i mm som standard).
volumetrisk vekt (valgfritt)	nummer	Vekten beregnes ut fra pakkens størrelse (i gram som standard).
boxType (valgfritt)	streng	Formen på esken (f.eks. rektangel, sylinder).
verdi (nødvendig for internasjonal frakt)	nummer	Totalverdi av alle varer i pakken (i valgt valuta).
varer (nødvendig for internasjonal frakt)	Vare[]	Liste over varer i pakken.

Vare*

Parameter	Type	Beskrivelse
itemReferenceId (obligatorisk)	streng	Partnerens ID for pakkeelementet.
beskrivelse (obligatorisk)	streng	Beskrivelse av produktet.
antall (obligatorisk)	nummer	Antall av varen.
verdi (obligatorisk)	nummer	Verdien av varen (i valgt valuta).
vekt (obligatorisk)	nummer	Vekt på varen (i gram som standard).
hsCode (obligatorisk)	streng	Harmonized System Code (Wiki).
produksjonsland (obligatorisk)	streng	Landkode i 2-bokstavsformat der varen ble produsert.

Merk: *Alle vareparametere kreves kun for internasjonal frakt.

Vellykket respons

Parameter	Type	Beskrivelse
antall	nummer	Antall resultater funnet.
gjenstander	ResponseItems	En rekke tilbud

ResponseItems

Parameter	Type	Beskrivelse
fraktselskap	ResponseItemsCarrier	Detaljer om fraktselskapet.
metode	ResponseItemsMethod	Detaljer om fraktmetode.

ResponseItemsCarrier

Parameter	Type	Beskrivelse
fraktleverandør	streng	Fraktselskap brukt for bestillingen.
uid	streng	Fraktmetode brukt for bestillingen.

ResponseItemsMethod

Parameter	Type	Beskrivelse
navn	streng	Navn på fraktmetode.
uid	streng	UID for fraktmetode.
pris	nummer	Estimert pris for fraktmetode for partner.
maxShipmentDays	nummer	Maksimalt antall forsendelsesdager for fraktmetoden.
minShipmentDays	nummer	Min. antall forsendelsesdager for fraktmetode.
deliveryPaddingDays (valgfritt)	nummer	Leveringsdager for fraktmetode.

Feilmelding

Parameter	Type	Beskrivelse
ordrereferanseId	streng	Unik ID for fraktordre gitt av deg.
kode	streng	Feilkode.
melding	streng	Feilmelding.
detalj (valgfritt)	ting	Detaljert feilmelding (JSON-objekt med en vilkårlig struktur).
feil (valgfritt)	ResponseErrorDetails[]	Array med feil.