REST API objects
REST API has two objects on the root level:
printConfigshipment
Please refer to the Property reference guide for guidance regarding properties and values.
The printConfig object
The printConfig object defines the format and type of shipping documents.
It supports up to four targets. This can be useful if several services are used supporting multiple label formats, for example:
Letter services supporting letter label format
Parcel services requiring full size label format
Other documents such as waybills, customs declaration etc. requiring A4 format
The most common scenario is to have one output target for labels and another for other documents such as waybills, customs declaration documents, etc.
The smallest label format should come first, followed by the larger format and then A4 at the end. The system iterates through the object searching for a suitable target format.
The shipment object
A shipment object contains all the information about the shipment and usually consists of at least two address party objects (sender and receiver), a service object and a parcels object.
Depending on the use case, other objects are included in the shipment object, such as developerId, favorite, profileGroup and mergeId.
Address party objects
There are a number of address parties available and their usage depends on the service's requirements.
- sender
Sender information (mandatory)
- senderPartners
Carrier related information (for example, customer number) for the sender object.
- receiver
Receiver information (mandatory)
- dispatch
Alternative pickup address
- receiverPartners
Carrier related information (for example, customer number) for the receiver object.
- delivery
Alternative pickup address
- agent
Pickup point for B2C services
- returnPart
Alternative return address
- freightPayer
Alternative freightPayer party (not to be mistaken for the Receiver pays or the Other payer additional services)
- freightPayerPartners
Carrier information
- taxPayer
Tax payer information
- taxPayerPartners
Carrier information
- customsPayer
Customs payer information
- customsPayerPartners
Carrier information
The service object
The service object contains information about the carrier service. For additional services the addons object is included in the service object.
The parcels object
The parcels object contains information about the parcels included in the shipment, such as weight, contents and dangerous goods information. It can also contain the articles object which is used for the Item directory add-on.
The customs declaration object
The customsdeclaration object contains customs information, such as invoice type and currency, for shipments outside the EU.
By default, all necessary shipment documents are printed. You don't have to state them unless you want to override the default settings.
- label
Parcel labels
- dngdecl
Dangerous goods declaration
- sis
SIS/SFS/CMR waybill. Type depends on sender and receiver country.
- *
None
The printSet array is used to specify customs declaration documents.
- proforma
Commercial/proforma invoice
- proformaplabedi
Proforma invoice incl. EDI (PostNord only)
- plt
Customs information via EDI only
- edoc
ED document
- cn22
CN22 declaration
- cn23
CN23 declaration
- proformaups
Commercial invoice - UPS
- upschild
UPS World Ease Child shipment
- proformatnt
Proforma for TNT
- notetnt
TNT Note
- pnlwaybilledi
Separate custom documents for PNL are sent via EDI, not from this system
- fedexp
Commercial invoice for FedEx
- tradeinvoicepdk
Commercial invoice for PostNord DK
- datatransferpdk ()
Customs information via EDI only for PostNord DK
- cn22depostpt
CN22 for Deutsche Post Packet Tracked
The options object
The options object contains information about nShift add-ons, such as Email pre-notification, Link to print and Consolidated shipment.