POST {languagecode}/{version}/CreateShipment
Create labels in PDF format. Returns a base64 encoded PDF.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
shipment | The shipment |
Define this parameter in the request body. |
languagecode | Language code of the customer country. Format ISO3166 A2 ( "DK" for Denmark ). |
Define this parameter in the request URI. |
version | API version number |
Define this parameter in the request URI. |
Request body formats
application/json, text/json
Sample:
{ "UserName": "2080012345", "Password": "*********", "Customerid": "2080012345", "Contactid": "2080ab3453", "ShipmentDate": "20130911", "Reference": "Customer reference", "System": "", "LabelSize": null, "LabelFormat": "", "Addresses": { "Pickup": null, "AlternativeShipper": null, "Delivery": { "Name1": "Navn1", "Name2": "Navn2", "Name3": "Name3", "Street1": "Street", "CountryNum": "208", "ZipCode": "6000", "City": "Kolding", "Contact": "Contact person", "Email": "email@email.dk", "Phone": "+4576331100", "Mobile": "+4512345678" } }, "Parcels": [ { "Weight": 2.5, "Reference": "Parcel reference", "Comment": "Comment", "Cashservice": 0.0, "AddOnLiabilityService": 0.0, "WeightCategory": null, "Height": 0.0, "Width": 0.0, "Length": 0.0 }, { "Weight": 7.5, "Reference": "Parcel reference", "Comment": "Comment", "Cashservice": 0.0, "AddOnLiabilityService": 0.0, "WeightCategory": null, "Height": 0.0, "Width": 0.0, "Length": 0.0 } ], "Services": { "ShopDelivery": "96600", "NotificationEmail": null, "Deposit": null, "ShopReturn": null, "PickAndReturn": null, "C2X": null, "Express10": null, "Express12": null, "AddresseeOnly": null, "DirectShop": null, "PrivateDelivery": null, "G24": null, "FlexDelivery": null, "ThinkGreen": null, "SameDay": null, "SameDayPallet": null, "ParcelShop": null } }
application/xml, text/xml
Sample:
<Shipment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <UserName>2080012345</UserName> <Password>*********</Password> <Customerid>2080012345</Customerid> <Contactid>2080ab3453</Contactid> <ShipmentDate>20130911</ShipmentDate> <Reference>Customer reference</Reference> <System /> <LabelFormat /> <Addresses> <Delivery> <Reference>Delivery ref</Reference> <Name1>Navn1</Name1> <Name2>Navn2</Name2> <Name3>Name3</Name3> <Street1>Street</Street1> <CountryNum>208</CountryNum> <ZipCode>6000</ZipCode> <City>Kolding</City> <Contact>Contact person</Contact> <Email>email@email.dk</Email> <Phone>+4576331100</Phone> <Mobile>+4512345678</Mobile> </Delivery> </Addresses> <Parcels> <Parcel> <Weight>2.5</Weight> <Reference>Parcel reference</Reference> <Comment>Comment</Comment> <Cashservice>0</Cashservice> <AddOnLiabilityService>0</AddOnLiabilityService> <Height>0</Height> <Width>0</Width> <Length>0</Length> </Parcel> <Parcel> <Weight>7.5</Weight> <Reference>Parcel reference</Reference> <Comment>Comment</Comment> <Cashservice>0</Cashservice> <AddOnLiabilityService>0</AddOnLiabilityService> <Height>0</Height> <Width>0</Width> <Length>0</Length> </Parcel> </Parcels> <Services> <ShopDelivery>96600</ShopDelivery> </Services> </Shipment>
Response Information
Response body formats
application/json, text/json
Sample:
{ "ConsignmentId": "YO9O243H", "PDF": "Base64 encoded PDF", "Parcels": [ { "UniqueNumber": "YO9O243H", "ParcelNumber": "06099052861", "ParcelNumber12Digit": null, "NdiNumber": "", "Routing": { "Primary2D": "ADK0060DK00262080060990208a144c85YO9O243HAAn", "Secondary2D": "A\\7CGLS PakkeShop\\7CHøjager 2-4\\7CTaastru", "NationalRef": "06099052861" }, "NdiNumber2": null, "NdiNumber3": null, "NdiNumber4": null }, { "UniqueNumber": "YO9O243I", "ParcelNumber": "06099052862", "ParcelNumber12Digit": null, "NdiNumber": "", "Routing": { "Primary2D": "ADK0060DK00262080060990208a144c85YO9O243HAAn", "Secondary2D": "A\\7CGLS PakkeShop\\7CHøjager 2-4\\7CTaastrup", "NationalRef": "06099052862" }, "NdiNumber2": null, "NdiNumber3": null, "NdiNumber4": null } ], "PNG": null }
application/xml, text/xml
Sample:
<ShipmentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ConsignmentId>YO9O243H</ConsignmentId> <PDF>Base64 encoded PDF</PDF> <Parcels> <ParcelResponse> <UniqueNumber>YO9O243H</UniqueNumber> <ParcelNumber>06099052861</ParcelNumber> <NdiNumber /> <Routing> <Primary2D>ADK0060DK00262080060990208a144c85YO9O243HAAn</Primary2D> <Secondary2D>A\7CGLS PakkeShop\7CHøjager 2-4\7CTaastru</Secondary2D> <NationalRef>06099052861</NationalRef> </Routing> </ParcelResponse> <ParcelResponse> <UniqueNumber>YO9O243I</UniqueNumber> <ParcelNumber>06099052862</ParcelNumber> <NdiNumber /> <Routing> <Primary2D>ADK0060DK00262080060990208a144c85YO9O243HAAn</Primary2D> <Secondary2D>A\7CGLS PakkeShop\7CHøjager 2-4\7CTaastrup</Secondary2D> <NationalRef>06099052862</NationalRef> </Routing> </ParcelResponse> </Parcels> </ShipmentResponse>