Shipping order create API er en RESTful API, der giver dig mulighed for at oprette en ordre til forsendelse for at generere en forsendelsesetiket og en sporingskode til en pakke.

POST /v1/shipping-orders

Eksempel på anmodning

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

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

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

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.
shippingMethod (påkrævet)	ShippingMethod	Detaljer om forsendelsesmetode.
modtager (påkrævet)	Modtager	Oplysninger om modtageren.
afsender (påkrævet)	Afsender	Afsenderoplysninger.
pakker (påkrævet)	Pakke[]	Pakkedetaljer.

Valgmuligheder

Parameter	Type	Beskrivelse
Vægtenhed (valgfrit)	streng	Vægtenhed. Tilgængelige valg: g, kg, oz, lb. Som standard: g.
dimensionUnit (valgfrit)	streng	Enhed for længde. 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
Kundenavn (valgfrit)	streng	Forsendelse af kundeprofil. Bruges til at inkludere et brandnavn på etiketten (baseret på fragtfirmaets specifikationer).

ShippingMethod

Parameter	Type	Beskrivelse
uid (valgfrit)*	streng	Skal bruges til en bestemt forsendelsesmetode, f.eks. amazon_shipping_24.
speditør (valgfrit)	streng	Navnet på fragtfirmaet, f.eks. Amazon, DHL
niveau (påkrævet)*	streng	Forsendelsesmulighed. Tilgængelige valg: standard, ekspres. `standard`-niveauet skal bruges, når vi vælger den `billigste` forsendelsesmetode for dig `express`-niveauet skal bruges, når vi vælger `fastest` leveringsmetoden for dig

Bemærk: *Brug tier til Gelatos optimerede valg af transportør. Hvis du bruger tier, skal du lade uid stå tom, og omvendt.

Modtager

Parameter	Type	Beskrivelse
person (påkrævet)	ReceiverPerson	Personlige oplysninger om modtageren.
adresse (påkrævet)	Adresse	Modtagerens adresseoplysninger.
tilpassede (valgfrit)	Modtagerens told	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
firstName (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	Afsenderens telefonnummer (person/virksomhed).

Bemærk: *E-mail og telefonnummer 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.
adressefelt 2 (valgfrit)	streng	Anden linje i postadressen. Lejlighed / kontor / etagenummer.
addressLine3 (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
Momsnummer (valgfrit)	streng	Modtagerens momsnummer.

Afsender told

Parameter	Type	Beskrivelse
vatNumber (valgfrit)*	streng	Afsenderens momsnummer.
ioss-nummer (valgfrit)*	streng	Afsenderens IOSS-nummer.
EORI-nummer (valgfrit)*	streng	Afsenderens EORI-nummer.
pccc-nummer (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).
netWeight (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	Pakkens højde (som standard i mm).
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[]	Array af varer i pakken.

Vare*

Parameter	Type	Beskrivelse
itemReferenceId (påkrævet)	streng	Partner leverede 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
orderId	streng	Unikt ID for forsendelsesordren i vores system.
ordrereference-id	streng	Unikt ID for forsendelsesordren leveret af dig.
shippingMethod	ResponseShippingMethod	Forsendelsesmetoden, der bruges til forsendelsesordren.
pakker	ResponsePackage[]	Pakker brugt til forsendelsesordren.

ResponseShippingMethod

Parameter	Type	Beskrivelse
fragtfirma	streng	Forsendelsesfirma, der bruges til at oprette en ordre.
uid	streng	Shipping method uid, der bruges til at oprette en ordre.

ResponsePackage

Parameter	Type	Beskrivelse
packageReferenceId	streng	Partnerens ID på pakken.
trackingNumber	streng	Trackingnummer leveret af fragtfirmaet.
trackingUrl	streng	Tracking-URL leveret af fragtfirmaet.
etiket	ResponseLabel	Forsendelsesetiket til forsendelsesordren.
dokumenter (valgfrit)	ResponseDocument[]	Dokumenter til forsendelsesordren.
totalCost (valgfrit)	ResponseTotalCost	Estimeret pris for forsendelse af pakken.

Svarlabel

Parameter	Type	Beskrivelse
filnavn	streng	Filnavn på etiketten.
fileUrl	streng	URL til download af etiketten.
contentType	streng	Indholdstypen på etiketten.

ResponseDocument

Parameter	Type	Beskrivelse
documentType	streng	Dokumenttype (f.eks. faktura).
fileName	streng	Filnavn på dokumentet.
fileUrl	streng	URL til at downloade dokumentet.
contentType	streng	Indholdstype for dokumentet.

ResponseTotalCost

Parameter	Type	Beskrivelse
værdi (valgfrit)	nummer	Estimeret pris for forsendelse af pakken. (valgfrit)
valuta (valgfrit)	streng	Valuta

Fejlmeddelelse

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