Shipping order create API is een RESTful API waarmee je een verzendorder kunt aanmaken om een verzendlabel en trackingcode voor een pakket te genereren.
POST /v1/shipping-orders
Voorbeeld aanvragen
{ "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" } ] } ]}Voorbeeld van een succesvolle reactie
{ "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" } } ]}Voorbeeld van foutmelding
{ "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." } ]}Request
Parameter | Type | Beschrijving |
orderReferenceId (verplicht) | string | Uniek ID voor de verzendopdracht. ID verstrekt door jou. |
valuta (verplicht) | string | Valuta van de verzendbestelling in 3-letterformaat. |
opties (optioneel) | Opties | Optionele parameters. |
partner (optioneel) | Partner | Partnergegevens. |
shippingMethod (verplicht) | ShippingMethod | Details van de verzendmethode. |
ontvanger (verplicht) | Ontvanger | Gegevens ontvanger. |
afzender (verplicht) | Afzender | Gegevens van de afzender. |
pakketten (verplicht) | Pakket[] | Pakketdetails. |
Opties
Parameter | Type | Beschrijving |
gewichtseenheid (optioneel) | string | Gewichtseenheid. Beschikbare keuzes: g, kg, oz, lb. Standaard: g. |
dimensionUnit (optioneel) | string | Lengte-eenheid. Beschikbare keuzes: mm, cm, in. Standaard: mm. |
label (optioneel) | Label | Instellingen voor labelformaat. |
Label
Parameter | Type | Beschrijving |
formaat (optioneel) | string | Labelformaat. Beschikbare keuzes: pdf, zpl (*). Standaard: pdf. |
Opmerking: Formaten anders dan pdf zijn mogelijk niet ingeschakeld voor bepaalde verzendbedrijven.
Partner
Parameter | Type | Beschrijving |
Klantnaam (optioneel) | string | Klantprofiel verzenden. |
ShippingMethod
Parameter | Type | Beschrijving |
uid (optioneel*) | string | Te gebruiken voor een specifieke verzendmethode, bijvoorbeeld amazon_shipping_24. |
vervoerder (optioneel) | string | Naam van de verzendmaatschappij, bijv. Amazon, DHL |
niveau (vereist*) | string | Laag van verzendoptie. Beschikbare keuzes: standaard, express. |
Opmerking: *Gebruik tier voor Gelato's geoptimaliseerde vervoerdersselectie. Als je tier gebruikt, laat uid dan leeg, en omgekeerd.
Ontvanger
Parameter | Type | Beschrijving |
persoon (verplicht) | OntvangerPersoon | Persoonlijke gegevens van de ontvanger. |
adres (verplicht) | Adres | Adresgegevens van de ontvanger. |
gepersonaliseerd (optioneel) | Douane van de ontvanger | Douanegegevens van de ontvanger. |
Afzender
Parameter | Type | Beschrijving |
persoon (vereist) | Afzenderpersoon | Persoonlijke gegevens van de afzender. |
adres (verplicht) | Adres | Adresgegevens van de afzender. |
douane (vereist voor internationale verzending) | Douane van de afzender | Douanegegevens van de afzender. |
OntvangerPersoon
Parameter | Type | Beschrijving |
Voornaam (verplicht) | string | Voornaam van de ontvanger. |
Achternaam (verplicht) | string | Achternaam van de ontvanger. |
bedrijf (optioneel) | string | De titel van het bedrijf. |
e-mail (optioneel*) | string | E-mailadres van de persoon. Dit kan worden gebruikt voor verzendmeldingen. |
telefoon (optioneel*) | string | Telefoonnummer van de persoon. Dit kan worden gebruikt voor verzendmeldingen. |
Opmerking: *E-mail en telefoon kunnen verplichte velden zijn, afhankelijk van de verzendmaatschappij
AfzenderPersoon
Parameter | Type | Beschrijving |
Voornaam (optioneel) | string | Voornaam van de afzender. |
Achternaam (optioneel) | string | Achternaam van de afzender. |
bedrijf (verplicht) | string | De titel van het verzendende bedrijf. |
e-mail (optioneel*) | string | E-mailadres van de afzender (persoon/bedrijf). |
telefoon (optioneel*) | string | Telefoonnummer van de afzender (persoon/bedrijf). |
Opmerking: *E-mail en telefoon kunnen verplichte velden zijn, afhankelijk van de verzendmaatschappij
Adres
Parameter | Type | Beschrijving |
land (verplicht) | string | Landcode in 2-letterformaat. |
staat (optioneel*) | string | Staat / provincie / regio. |
stad (verplicht) | string | Stad. |
postcode (verplicht) | string | Postcode. |
adresregel 1 (verplicht) | string | Eerste regel van het postadres. Moet straat en huisnummer bevatten. |
adresregel 2 (optioneel) | string | Tweede regel van het postadres. Appartement / kantoor / verdieping. |
adresregel 3 (optioneel) | string | Derde regel van het postadres. |
straat (optioneel*) | string | Straat (verplicht voor Duitse adressen). |
huisnummer (optioneel*) | string | Huisnummer (verplicht voor Duitse adressen). |
buitenwijk (optioneel*) | string | Buitenwijk (verplicht voor AU/NZ-adressen). |
Opmerking: *Deze optionele velden zijn verplicht voor bepaalde landen en vervoerders.
Douane van de ontvanger
Parameter | Type | Beschrijving |
btw-nummer (optioneel) | string | BTW-nummer van de ontvanger. |
Douane van de afzender
Parameter | Type | Beschrijving |
btw-nummer (optioneel*) | string | BTW-nummer van de afzender. |
ioss-nummer (optioneel*) | string | IOSS-nummer van de afzender. |
eori-nummer (optioneel*) | string | EORI-nummer van de afzender. |
pccc-nummer (optioneel*) | string | PCCC-nummer van de afzender. |
australianBusinessNumber (optioneel*) | string | Australisch bedrijfsnummer van de afzender. |
Opmerking: *Afhankelijk van het land van de afzender en de ontvanger kunnen deze velden verplicht zijn.
Verpakking
Parameter | Type | Beschrijving |
packageReferenceId (verplicht) | string | Door de partner verstrekt ID van het pakket. |
brutogewicht (verplicht) | nummer | Verpakkingsgewicht + artikelgewicht (standaard in gram). |
netto gewicht (optioneel) | nummer | Gewicht van de artikelen (standaard in gram). |
Lengte (verplicht) | nummer | Lengte van het pakket (standaard in mm). |
breedte (vereist) | nummer | Breedte van het pakket (standaard in mm). |
hoogte (verplicht) | nummer | Hoogte van het pakket (standaard in mm). |
volumetrisch gewicht (optioneel) | nummer | Gewicht berekend op basis van de grootte van het pakket (standaard in gram ). |
boxType (optioneel) | string | Vorm van de doos (bijv. rechthoek, buis). |
waarde (vereist voor internationale verzending) | nummer | Totale waarde van alle artikelen in het pakket (in geselecteerde valuta). |
artikelen (vereist voor internationale verzending) | Item[] | Lijst van artikelen in het pakket. |
Artikel*
Parameter | Type | Beschrijving |
itemReferenceId (verplicht) | string | Door de partner verstrekt ID van het pakketitem. |
beschrijving (verplicht) | string | Beschrijving van het artikel. |
aantal (verplicht) | nummer | Aantal stuks. |
waarde (vereist) | nummer | Waarde van het artikel (in geselecteerde valuta). |
gewicht (vereist) | nummer | Gewicht van het artikel (standaard in gram). |
hsCode (verplicht) | string | Harmonized System Code (Wiki). |
land van herkomst (verplicht) | string | Landcode in 2-letterformaat waar het artikel is geproduceerd. |
Opmerking: *Alleen alle artikelparameters die nodig zijn voor internationale verzending.
Succesvolle reactie
Parameter | Type | Beschrijving |
orderId | string | Uniek ID voor de verzendopdracht in ons systeem. |
orderreferentie-id | string | Uniek ID voor de verzendopdracht die door jou is opgegeven. |
shippingMethod | ResponseShippingMethod | Verzendmethode gebruikt voor de verzendopdracht. |
verpakkingen | ResponsePackage[] | Pakketten die worden gebruikt voor de verzendopdracht. |
ResponseShippingMethod
Parameter | Type | Beschrijving |
vervoerder | string | Vervoerder die wordt gebruikt om een bestelling aan te maken. |
uid | string | UID van de verzendmethode die wordt gebruikt om een bestelling aan te maken. |
ResponsePackage
Parameter | Type | Beschrijving |
packageReferenceId | string | Door de partner verstrekt ID van het pakket. |
trackingNumber | string | Trackingnummer verstrekt door de verzendmaatschappij. |
trackingUrl | string | Tracking-URL verstrekt door de verzendmaatschappij. |
label | Reactielabel | Verzendlabel voor de verzendopdracht. |
documenten (optioneel) | ResponseDocument[] | Documenten voor de verzendopdracht. |
totalCost (optioneel) | ResponseTotalCost | Geschatte verzendkosten van het pakket. |
Antwoordlabel
Parameter | Type | Beschrijving |
bestandsnaam | string | Bestandsnaam van het label. |
bestandsURL | string | URL om het label te downloaden. |
contentType | string | Soort inhoud van het etiket. |
ResponseDocument
Parameter | Type | Beschrijving |
documentType | string | Documenttype (bijv. factuur). |
bestandsnaam | string | Bestandsnaam van het document. |
bestandsURL | string | URL om het document te downloaden. |
contentType | string | Soort inhoud van het document. |
ResponseTotalCost
Parameter | Type | Beschrijving |
waarde (optioneel) | nummer | Geschatte verzendkosten van het pakket. (optioneel) |
valuta (optioneel) | string | Munteenheid |
Foutmelding
Parameter | Type | Beschrijving |
orderreferentie-id | string | Uniek ID voor de verzendopdracht die door jou is opgegeven. |
code | string | Foutcode. |
Bericht | string | Foutmelding. |
detail (optioneel) | object | Gedetailleerd foutbericht (JSON-object van een willekeurige structuur). |
fouten (optioneel) | ResponseErrorDetails[] | Array met fouten. |
ResponseErrorDetails
Parameter | Type | Beschrijving |
code | string | Foutcode. |
Bericht | string | Foutmelding |
referentie (optioneel) | string | Referentie-ID. |
Volgende stap: 🔗[GCL] Logistics API - Shipping Order Create Draft
📝 Niet wat je nodig had?
Help ons dit artikel te verbeteren, stuur ons een e-mail naar [email protected] — vermeld alsjeblieft de titel van het artikel.