List, view and print waybills.

Go to:

• Overview of service options
• Fetch a list of waybills
• Fetch a waybill
• Print a waybill

/shipment-waybills

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

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 does not have to be provided in the request.

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.

Overview of service options

Fetch a list of waybills

GET /shipment-waybills

Fetch a list with information about created waybills.

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

Query parameters

Response example

{
  "page": 0,
  "totalPages": 1,
  "totalCount": 2,
  "shipmentWaybillData": [
    {
      "id": 13,
      "bulkId": "UPSWE",
      "description": null,
      "type": "UPSEXPP",
      "crated": "2022-02-01 12:36:43.685",
      "updated": "2022-02-01 12:49:42.148"
    },
    {
      "id": 12,
      "bulkId": "UPSWE",
      "description": null,
      "type": "UPSEXPP",
      "crated": "2022-02-01 12:29:44.729",
      "updated": "2022-02-01 12:33:54.929"
    }
  ]
}

Fetch a waybill

GET/shipment-waybills/{waybillId}

Fetches a waybill that was previously created.

URI parameters

Response example

{
  "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

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

Query parameters

Body example

{
  "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"
    }]
  }
}

Response example

[{
  "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]"
}]

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

For a description of properties, please see the Property reference guide.

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