Shipping order create API är ett RESTful API som låter dig skapa en order för frakt för att generera en fraktetikett och ett spårningsnummer för ett paket.
POST /v1/shipping-orders
Exempel på förfrågan
{ "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" } ] } ]}Exempel på lyckat 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" } } ]}Exempel på felmeddelande
{ "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." } ]}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. |
shippingMethod (obligatoriskt) | ShippingMethod | Detaljer om fraktmetoden. |
mottagare (obligatoriskt) | Mottagare | Mottagarens uppgifter. |
avsändare (obligatoriskt) | Avsändare | Avsändarens uppgifter. |
paket (obligatoriskt) | Paket[] | Paketinformation. |
Alternativ
Parameter | Typ | Beskrivning |
Viktenhet (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 |
clientName (valfritt) | sträng | Kundprofil för leverans. |
ShippingMethod
Parameter | Typ | Beskrivning |
uid (valfritt*) | sträng | Används för en specifik fraktmetod, t.ex. amazon_shipping_24. |
fraktbolag (valfritt) | sträng | Namn på fraktbolag, t.ex. Amazon, DHL |
nivå (obligatoriskt*) | sträng | Nivå för fraktalternativ. Tillgängliga val: standard, express. |
Obs! *Använd tier för Gelatos optimerade val av transportör. Om du använder tier ska du lämna uid tomt, och vice versa.
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 | Avsändarens företagsnamn. |
e-post (valfritt*) | sträng | E-postadress till avsändaren (person/företag). |
Telefon (valfritt*) | sträng | Telefonnummer till avsändaren / företaget. |
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 tyska adresser). |
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.
ReceiverCustoms
Parameter | Typ | Beskrivning |
VAT-nummer (valfritt) | sträng | Mottagarens momsregistreringsnummer. |
Avsändarens tull
Parameter | Typ | Beskrivning |
VAT-nummer (valfritt*) | sträng | Momsregistreringsnummer för avsändaren. |
iossNumber (valfritt*) | sträng | Avsändarens IOSS-nummer. |
EORI-nummer (valfritt*) | sträng | Avsändarens EORI-nummer. |
pccc-nummer (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). |
netto vikt (valfritt) | nummer | Vikt 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å paketet (i mm som standard). |
Volymetrisk vikt (valfritt) | nummer | Vikten beräknas utifrån paketets storlek (i gram som standard). |
boxType (valfritt) | sträng | Boxens form (t.ex. rektangel, tub). |
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[] | En 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å artikeln (i gram som standard). |
hsCode (obligatoriskt) | sträng | Harmonized System Code (Wiki). |
Tillverkningsland (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 |
orderId | sträng | Unikt ID för leveransorder i vårt system. |
orderReferenceId | sträng | Unikt ID för leveransorder som tillhandahålls av dig. |
shippingMethod | ResponseShippingMethod | Fraktmetod som används för fraktordern. |
paket | ResponsePackage[] | Förpackningar som används för leveransordern. |
ResponseShippingMethod
Parameter | Typ | Beskrivning |
fraktbolag | sträng | Fraktbolag som används för att skapa en order. |
uid | sträng | UID för fraktmetod som används för att skapa en order. |
ResponsePackage
Parameter | Typ | Beskrivning |
packageReferenceId | sträng | Paketets ID från partnern. |
trackingNumber | sträng | Spårningsnummer som tillhandahålls av fraktbolaget. |
trackingUrl | sträng | Spårnings-URL tillhandahållen av fraktbolaget. |
etikett | ResponseLabel | Fraktetikett för fraktordern. |
dokument (valfritt) | ResponseDocument[] | Dokument för leveransordern. |
totalCost (valfritt) | ResponseTotalCost | Uppskattad kostnad för att skicka paketet. |
ResponseLabel
Parameter | Typ | Beskrivning |
fileName | sträng | Filnamn på etiketten. |
fileUrl | sträng | URL för att ladda ner etiketten. |
contentType | sträng | Innehållstyp för etiketten. |
ResponseDocument
Parameter | Typ | Beskrivning |
documentType | sträng | Dokumenttyp (t.ex. faktura). |
fileName | sträng | Filnamn för dokumentet. |
fileUrl | sträng | URL för att ladda ner dokumentet. |
contentType | sträng | Dokumentets innehållstyp. |
ResponseTotalCost
Parameter | Typ | Beskrivning |
värde (valfritt) | nummer | Uppskattad kostnad för att skicka paketet. (valfritt) |
valuta (valfritt) | sträng | Valuta |
Felmeddelande
Parameter | Typ | Beskrivning |
orderReferenceId | sträng | Unikt ID för leveransorder som tillhandahålls av dig. |
kod | sträng | Felkod. |
meddelande | sträng | Felmeddelande. |
detalj (valfritt) | objekt | Detaljerat felmeddelande (JSON-objekt med en godtycklig struktur). |
fel (valfritt) | ResponseErrorDetails[] | Array med fel. |
ResponseErrorDetails
Parameter | Typ | Beskrivning |
kod | sträng | Felkod. |
meddelande | sträng | Felmeddelande |
referens (valfritt) | sträng | Referens-ID. |
Nästa steg: 🔗[GCL] Logistics API - Skapa utkast till fraktorder
📝 Inte vad du behövde?
Hjälp oss förbättra denna artikel, skicka ett mejl till [email protected] — vänligen inkludera artikelns titel.