Shipping order create API er et RESTful API som lar deg opprette en ordre for frakt for å generere en fraktetikett og sporingskode for en pakke.

POST /v1/shipping-orders

Eksempel på forespørsel

{  "orderReferenceId": "EXMPL0001234",  "currency": "EUR",  "options": {    "weightUnit": "g",    "dimensionUnit": "mm",    "label": {      "format": "pdf"    }  },  "partner": {    "clientName": "ExampleCustomer"  },  "shippingMethod": {    "uid": "",    "carrier": "",    "tier": "standard"  },  "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": 18.42,          "quantity": 4,          "weight": 760,          "hsCode": "44199090",          "countryOfOrigin": "DE"        }      ]    }  ]}

Eksempel på vellykket respons

{  "orderId": "fb7c0bf6-bdb1-4443-b5db-7263793be32b",  "orderReferenceId": "EXMPL0001234",  "shippingMethod": {    "carrier": "UPS",    "uid": "ups_standard_tariff"  },  "packages": [    {      "packageReferenceId": "EXMPL0001234-0-1",      "trackingNumber": "EXMPL0001234TRCKNUM",      "trackingUrl": "https://www.ups.com/track?track=yes&trackNums=EXMPL0001234TRCKNUM&loc=en_US&requester=ST",      "label": {        "fileName": "18437f55ec0cd1b64ae6a0eabf03e21b67a57ea1_UPS.pdf",        "fileUrl": "https://s3-eu-west-1.amazonaws.com/printcloud.storage-test/label/18437f55ec0cd1b64ae6a0eabf03e21b67a57ea1_UPS.pdf",        "contentType": "application/pdf"      },      "documents": [        {          "documentType": "invoice",          "fileName": "18437f55ec0cd1b64ae6a0eabf03e21b67a57ea1_UPS_invoice.pdf",          "fileUrl": "https://s3-eu-west-1.amazonaws.com/printcloud.storage-test/label/18437f55ec0cd1b64ae6a0eabf03e21b67a57ea1_UPS_invoice.pdf",          "contentType": "application/pdf"        }      ],      "totalCost": {        "value": 2.56,        "currency": "EUR"      }    }  ]}

Eksempel på feilmelding

{  "orderReferenceId": "EXMPL0001234",  "code": "PUBLIC_API_ERROR",  "message": "Processing error",  "detail": {    "code": "UPS_API_ERROR",    "message": {      "status": {        "title": "Bad Request",        "status": 400,        "detail": "0 of 1 shipment successfully created.",        "statusCode": 400      },      "items": [        {          "sstatus": {            "title": "Bad Request",            "status": 400,            "statusCode": 400          },          "validationMessages": [            {              "property": "packages[0].items[0].hsCode",              "validationMessage": "Parameter hsCode must be between 4 and 11 characters long.",              "validationState": "Error"            }          ]        }      ]    }  },  "errors": [    {      "code": "IS_BLANK_ERROR",      "reference": "receiver.address.country",      "message": "This value should not be blank."    },    {      "code": "IS_BLANK_ERROR",      "reference": "receiver.address.city",      "message": "This value should not be blank."    },    {      "code": "MISSING_FIELD_ERROR",      "reference": "packages[EXMPL0001234-0-1][length]",      "message": "This field is missing."    }  ]}

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	Partnerdetaljer.
shippingMethod (obligatorisk)	ShippingMethod	Detaljer om fraktmetode.
mottaker (obligatorisk)	Mottaker	Mottakerens opplysninger.
avsender (obligatorisk)	Avsender	Avsenderens opplysninger.
pakker (obligatorisk)	Pakke[]	Pakkedetaljer.

Valg

Parameter	Type	Beskrivelse
weightUnit (valgfritt)	streng	Vektenhet. Tilgjengelige valg: g, kg, oz, lb. Standard: g.
dimensionUnit (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	Sender kundeprofil. Brukes til å inkludere et merkenavn på etiketten (basert på transportørens spesifikasjoner).

ShippingMethod

Parameter	Type	Beskrivelse
uid (valgfritt)*	streng	Skal brukes for en spesifikk fraktmetode, f.eks. amazon_shipping_24.
fraktleverandør (valgfritt)	streng	Navn på fraktselskap, f.eks. Amazon DHL
nivå (obligatorisk)*	streng	Nivå for fraktalternativ. Tilgjengelige valg: standard, ekspress. `standard`-nivået bør brukes når vi velger den `billigste` fraktmetoden for deg `express`-nivået bør brukes når vi velger `raskeste` fraktmetode for deg

Merk: *Bruk tier for Gelatos optimaliserte valg av transportør. Hvis du bruker tier, la uid stå tom, og omvendt.

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 for avsenderen.
toll (påkrevd for internasjonal frakt)	SenderCustoms	Tollinformasjon om avsenderen.

MottakerPerson

Parameter	Type	Beskrivelse
Fornavn (obligatorisk)	streng	Fornavn på mottaker.
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 fraktleverandør

SenderPerson

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 / selskapet.
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.
tilstand (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 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 fraktselskaper.

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 organisasjonsnummer (valgfritt)*	streng	Australsk organisasjonsnummer 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).
nettovekt (valgfritt)	nummer	Vekt på produktene (i gram som standard).
Lengde (obligatorisk)	nummer	Lengde på pakken (i mm som standard).
bredde (påkrevd)	nummer	Bredde på pakken (i mm som standard).
høyde (påkrevd)	nummer	Høyde på pakken (i mm som standard).
Volumvekt (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 oppgitte ID for pakkeelementet.
beskrivelse (påkrevd)	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).
HS-kode (obligatorisk)	streng	Harmonized System Code (Wiki).
produksjonsland (obligatorisk)	streng	Tosifret landskode for landet der varen ble produsert.

Merk: *Alle vareparametere kreves kun for internasjonal frakt.

Vellykket respons

Parameter	Type	Beskrivelse
orderId	streng	Unik ID for fraktordre i systemet vårt.
ordrereferanseId	streng	Unik ID for fraktordre levert av deg.
shippingMethod	ResponseShippingMethod	Fraktmetoden som brukes for fraktordren.
pakker	ResponsePackage[]	Pakker brukt til fraktordren.

ResponseShippingMethod

Parameter	Type	Beskrivelse
fraktselskap	streng	Fraktselskap brukt til å opprette en bestilling.
uid	streng	UID for fraktmetode som brukes til å opprette en bestilling.

ResponsePackage

Parameter	Type	Beskrivelse
packageReferenceId	streng	Partnerens ID for pakken.
trackingNumber	streng	Sporingsnummer gitt av fraktselskapet.
trackingUrl	streng	Sporings-URL levert av fraktselskapet.
etikett	Responsetikett	Fraktetikett for fraktordren.
dokumenter (valgfritt)	ResponseDocument[]	Dokumenter for fraktordren.
totalCost (valgfritt)	ResponseTotalCost	Estimert fraktkostnad for pakken.

Responsetikett

Parameter	Type	Beskrivelse
filnavn	streng	Filnavn på etiketten.
fileUrl	streng	URL for å laste ned etiketten.
contentType	streng	Innholdstype for etiketten.

ResponseDocument

Parameter	Type	Beskrivelse
documentType	streng	Dokumenttype (f.eks. faktura).
filnavn	streng	Filnavn på dokumentet.
fileUrl	streng	URL for å laste ned dokumentet.
contentType	streng	Innholdstype for dokumentet.

ResponseTotalCost

Parameter	Type	Beskrivelse
verdi (valgfritt)	nummer	Estimert fraktkostnad for pakken. (valgfritt)
valuta (valgfritt)	streng	Valuta

Feilmelding

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