/shipment-waybills

Shipment-waybills is how you print waybills for bulk shipments, where available.

Important

Each waybill generates a master shipment. The service used for the master shipment depends on waybill type, and in some cases several different services can be used for the master shipment.

If only one service is available for the master shipment the service is locked and doesn't have to be provided in the request.

Note

The REST API endpoints are only accessible via HTTPS and are located at api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

Before getting started you need to know your developer ID and create an API key.

Waybill Code	Waybill	Service Code	Service	Master/Child
PDKBREVIRFID	PostNord DK Trackable RFID
		PDKBREVIRFID	PostNord DK Traceable RFID Waybill	Master
		PDKBREVIAT	PostNord DK Trackable RFID, Maxibrev	Child
		PDKBREVIAU	PostNord DK Trackable RFID, Storbrev	Child
PDKBREVI	PostNord DK Tracked
		PDKBREVISL	Varebrev til udlandet Waybill	Master
		PDKBREVI	PostNord DK Tracked, Maxibrev	Child
		PDKBREVISB	PostNord DK Tracked, Storbrev	Child
PDKBREVIU	PostNord DK Untracked
		PDKBREVIUSL	PostNord DK Untracked	Master
		PDKBREVIU	PostNord DK Untracked Maxibrev	Child
		PDKBREVIUSB	PostNord DK Untracked Storbrev	Child
PDKBREVTS	PostNord Tracked Samsendning
		PDKWAY	PostNord DK Waybill	Master
		PDKBREVTS	PostNord DK Tracked Samsending	Child
PDK	PostNord Waybill
		PDKWAY	PostNord DK Waybill	Master
		P19DKBP	PostNord DK MyPack Collect (Samsending)	Child
		PDK17BP	PostNord DK MyPack Home (Samsending)	Child
		PDK18BP	PostNord DK Parcel (Samsending)	Child
UPSEXPDTP	UPS Expedited
		UPSEXPDTP	UPS Expedited (Non Docs)	Both
UPSEXPP	UPS Express
		UPSEXPP	UPS Express (Non Docs)	Both
		UPSSAVP	UPS Express Saver (Non Docs)	Both
		UPSEXPPLUSP	UPS Express Plus (Non Docs)	Both
UPSSTDP	UPS Standard
		UPSSTDP	UPS Standard (Non Docs)	Both

Fetch a list of waybills

GET /shipment-waybills

Fetch a list with information about created waybills.

Note

Use the query parameters to filter out which and how many waybills will be returned in the list.

Query parameters

Parameter	Type	Description	Category
dateFrom	string	The lower limit of a date interval. ISO-8601 date format, for example, 2020-01-01T01:00:00+00:00	Optional Must be used together with dateTo.
dateTo	string	The upper limit of a date interval. ISO-8601 date format, for example, 2020-02-01T01:00:00+00:00	Optional Must be used together with dateFrom.
page	number	Page number you need to see. "0" is the first page and each page contains 50 records.	Required
status		Waybill status. Valid values: ALL \| STD \| PRINTED \| CANCELLED Default: STD	Optional
waybillName	string	Filter the records based on waybill name ( bulk ID ). Can have multiple values separated by a comma (,).	Optional
waybillType	string	Filter the records based on waybill name ( bulk ID ). Can have multiple values separated by a comma (,).	Optional

Fetch a waybill

GET/shipment-waybills/{waybillId}

Fetches a waybill that was previously created.

URI parameters

Parameter	Type	Description	Category
waybillId	string	Identification of the waybill.	Required

{
  "id": 18,
  "name": "PostNord Norway Waybill test",
  "type": "PostNord Waybill",
  "description": null,
  "terminal": "PDKTERNO1",
  "status": "PRINTED",
  "recreateAfterPrinting": true,
  "numberOfShipmentsIncluded": 1,
  "shipments": [
    {
      "id": 5339841,
      "reference": "",
      "orderNumber": null,
      "shipDate": "2022-05-19 13:56",
      "serviceCode": "P19DKBP",
      "serviceName": "PostNord DK MyPack Collect (Samsending)",
      "senderQuickId": "",
      "senderName": "TEST return adress",
      "senderCity": "SKAGEN",
      "senderCountry": "DK",
      "receiverQuickId": "",
      "receiverName": "Grand Hotel",
      "receiverCity": "OSLO",
      "receiverCountry": "NO",
      "numberOfParcels": "1",
      "totalWeight": "0"
    }
  ]
}

Print a waybill

POST /shipment-waybills/{waybillId}/shipments

Prints a waybill according to the provided print configuration

Note

PDF or ZPL documents will be created according to the provided print configuration.

By default the documents are returned as a URL. As an option the documents can be inline in the print.data object in the result. The print.data object is encoded in base64.

The generated documents will only be available for one (1) hour.

URI parameters

Parameter	Type	Description	Category
waybillId	string	Identification of the waybill.	Required

Query parameters

Parameter	Type	Description	Category
returnFile	boolean	'true' if the PDF/ZPL file should be returned inline.	Optional

{
  "printConfig": {
    "target1Media": "thermo-250",
    "target1Type": "zpl",
    "target1YOffset": 0,
    "target1XOffset": 0,
    "target1Options": [{
      "key": "mode",
      "value": "DT"
    }],
    "target2Media": "laser-a4",
    "target2Type": "pdf",
    "target2YOffset": 0,
    "target2XOffset": 0,
    "target3Media": null,
    "target3Type": "pdf",
    "target3YOffset": 0,
    "target3XOffset": 0,
    "target4Media": null,
    "target4Type": "pdf",
    "target4YOffset": 0,
    "target4XOffset": 0
  },
  "shipment": {
    "sender": {
      "phone": "+46 31 725 35 00",
      "email": "email1@example.com",
      "quickId": "1",
      "zipcode": "41121",
      "name": "nShift Gbg",
      "address1": "Skeppsbron 5-6",
      "country": "SE",
      "city": "GÖTEBORG"
    },
    "parcels": [{
      "copies": "1",
      "weight": "2.75",
      "contents": "important things",
      "valuePerParcel": true
    }],
    "orderNo": "order number 123",
    "receiver": {
      "phone": "+46 8 34 35 15",
      "email": "email2@example.com",
      "zipcode": "11359",
      "name": "nShift Sthm",
      "address1": "Tegnérgatan 34",
      "country": "SE",
      "city": "STOCKHOLM"
    },
    "senderReference": "sender ref 234",
    "service": {
      "waybillBagCount": "2",
      "waybillContainerCount": "3",
      "id": "P15"
    },
    "receiverReference": "receiver ref 345",
    "options": [{
      "message": "This is order number 123",
      "to": "email2@example.com",
      "id": "ENOT",
      "languageCode": "sv",
      "from": "email1@example.com"
    }]
  }
}

[{
  "href": "https://api.unifaun.com/ufoweb-prod-202210061147/rs-extapi/v1/shipments/5666303",
  "id": "5666303",
  "sndName": "nShift Gbg",
  "sndZipcode": "41121",
  "sndCity": "GÖTEBORG",
  "sndCountry": "SE",
  "rcvName": "nShift Sthm",
  "rcvZipcode": "11359",
  "rcvCity": "STOCKHOLM",
  "rcvCountry": "SE",
  "serviceId": "P15",
  "shipmentNo": null,
  "orderNo": "order number 123",
  "reference": "sender ref 234",
  "parcelCount": 1,
  "parcels": [{
    "parcelNo": "69563053687SE",
    "reference": null
  }],
  "normalShipment": false,
  "returnShipment": false,
  "consolidated": false,
  "status": "PRINTED",
  "shipDate": "2015-06-02T14:05:56.342+0000",
  "created": "2015-06-02T14:05:56.569+0000",
  "changed": "2015-06-02T14:05:56.569+0000",
  "prints": [{
    "href": "https://api.unifaun.com/ufoweb-prod-202210061147/rs-extapi/v1/shipments/5666303/prints/10234334",
    "id": "10234334",
    "type": "zpl",
    "description": "Label"
  }],
  "previousPrints": null,
  "addons": "[NOTSMS]"
}]

Tip

For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

For description of properties, please refer to the Property reference guide.

For information about some crucial objects, please refer to REST API Objects.

In this section:

/shipment-waybills

Important

Note

Fetch a list of waybills

Note

Query parameters

Fetch a waybill

URI parameters

Print a waybill

Note

URI parameters

Query parameters

Tip

Search results