Create and print shipment lists.
Go to:
- Create a shipment list
- Fetch a shipment list
- Fetch shipment list documents
- Fetch a filtered shipment list
- Fetch previously printed shipment list
- Create a shipment list copy
/Shipment-manifests
Shipment-manifests is how you create and print shipment lists (also known as "Manifests", "End of day manifests", "Shipment manifests", etc.) as PDF files provided as a URL or a Base64 encoded file. The resource also has methods and endpoints for creating copies of previously printed shipment lists.
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.
Create a shipment list
POST /shipment-manifests/{manifestType}/manifests
Creates and prints a shipment list with available shipments for a certain manifest type.
Returns the shipment list and the associated ID.
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 |
|
manifestType |
string |
Carrier's shipment list type Valid values:
|
Required |
Query parameters
| Parameter | Type | Description | Category |
|
returnFile |
boolean |
'true' if the files should be returned inline. |
Optional |
Fetch a shipment list
GET /shipment-manifests/{manifestType}/manifests/{manifestId}/prints/{printId}
Fetches a shipment list based on manifest ID, manifest type and print ID.
URI parameters
| Parameter | Type | Description | Category |
|
manifestId |
string |
Identifies the shipment list |
Required |
|
manifestType |
string |
Carrier's shipment list type Valid values:
|
Required |
|
printId |
string |
Identifies the document. |
Required |
Response example
A PDF file
Fetch shipment list documents
GET/shipment-manifests/{manifestType}/manifests/{manifestId}/prints
Fetches all shipment list documents based on manifest type and manifest ID.
URI parameters
| Parameter | Type | Description | Category |
|
manifestId |
string |
Identifies the shipment list |
Required |
|
manifestType |
string |
Carrier's shipment list type Valid values:
|
Required |
Query parameters
|
Parameter |
Type |
Description |
Category |
|
returnFile |
boolean |
'true' if the files should be returned inline. |
Optional |
Response example:
[
{
"href": "http://localhost:8080/rs-extapi/v1/shipment-manifests/SBTL/manifests/11888/prints/11692820",
"id": "11692820",
"description": "Doc",
"pdf": "JVBERi0xLjQKJeLjz9MKMyAwIG9iaiA8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDg3OT4+c3RyZWF
tCnicnZdtb9MwEMff51NY4g1IDHx+is27FcqQJp7awPuwulNomo40K+KL8gn2QTjHScgWTzFo0lZ5/t2d7/
5nX38kiyyhRAt4oQ3JNskySz4n9AVVlBPqfv5+vNonP9z2l2+BMKpItk2g/QcQIyQBZhgj2T55ur6rNlVRX
R/L4tjkz7Lv3upjMJNGj+g3C7J+/W754XK5mkWVAjFCGWVwBuyM6SkJSoxJDSl3JE9bEkZAe2xSX3cfVheJ
4W6vVgwxTAYTpLbJ9pHNwCElAKnWRGgXod8MHBPsl5H/uyzwk19O2WhZ6uCySnvbRo2WU5OGbGtXlqkRIyB
gBFMLASMMqAkch0EwQMZp0Ah32Z7uFipoWwZTxRQPnZIpLUPH0SxoxAQD5Kic4LLhgQA5KBlaZjqUb8510L
ZgocMPkmUExD3JovQcIHHnvS6r6odqRxQjGbcY5S4EKbzaFXaRO7BE3zwA328VARLzjkXhLXx+OqLnvLazP
daB3IgWvLzFgOtX8/60UiNM0ZRQjHMS6GP+GJU+Qbba2Jp8yPeWnMfCFJSHl2cCMHFALn5ny8XH1UWkBdDM
Jzmz5eSsU6Y968Bgmc5SJqWksd4U1y25sttobz3zPq+KrT02JHO/nkCsTyFMy3/Ky3IXU1El1VhB7w9Nk1/
HKKgD/1VBKUv/T0Gdv15BK3tli1OnoVi4V5BL6rqprW3IfGY9O+igUx/oePV1Fvrarn/aja1iqbmKTrj2wQ
ea+qso+35XHZt5Cq9NMcJGL/1NXl/Zkhz23243cc6p1v7Rz4qyPOURvea9D9z5qTjaGi/QSH/KePUubJOXK
N55GXYOe/BfL7IBvDyUZRHb3QM1Lzp/Lkl9lyy/rMgN1j/CkQ+vB78Wu4jad9H1ELDnNPaSw1vR9+PXQ/lr
H+2qp+hzYJGNMCTvbZnv9raxEa3Qkf3B1s2vq1001cfoGu+mzJvjmAwMogyHHK3d+IqDL5cPRoZghY2Uvrm
zAwq3IXmFf8guqKmJhBnHoXewMC8pHMXNA4/kFNLH9NXnQo08xcnDAJ94C2pk+iRxnIgGNE4iGr+nPPC2dT
qZ96ZdnUfe6HyVBY7dkyqH9uKXklQ4RTBFcL6bDJFTRWgtqb+A8+Z2P68Bg6/pwPjHGx+1/DSf5NQdoicXR
TkaVf8A+eoj8QplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmo8PC9Db250ZW50cyAzIDAgUi9UeXBlL1BhZ2Uv
UmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vRm9udDw
8L0YxIDEgMCBSL0YyIDIgMCBSPj4+Pi9QYXJlbnQgNCAwIFIvTWVkaWFCb3hbMCAwIDU5NS4yOCA4NDEuOD
ldPj4KZW5kb2JqCjEgMCBvYmo8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY
2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjIgMCBvYmo8PC9TdWJ0eXBlL1R5cGUxL1R5
cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmR
vYmoKNCAwIG9iajw8L0tpZHNbNSAwIFJdL1R5cGUvUGFnZXMvQ291bnQgMT4+CmVuZG9iago2IDAgb2JqPD
wvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSPj4KZW5kb2JqCjcgMCBvYmo8PC9Nb2REYXRlKEQ6MjAyMTEyM
jgxNTA5MTYrMDInMDAnKS9DcmVhdGlvbkRhdGUoRDoyMDIxMTIyODE1MDkxNiswMicwMCcpL1Byb2R1Y2Vy
KGlUZXh0IDIuMC4yIFwoYnkgbG93YWdpZS5jb21cKSk+PgplbmRvYmoKeHJlZgowIDgKMDAwMDAwMDAwMCA
2NTUzNSBmIAowMDAwMDAxMTMyIDAwMDAwIG4gCjAwMDAwMDEyMTkgMDAwMDAgbiAKMDAwMDAwMDAxNSAwMD
AwMCBuIAowMDAwMDAxMzExIDAwMDAwIG4gCjAwMDAwMDA5NjEgMDAwMDAgbiAKMDAwMDAwMTM2MSAwMDAwM
CBuIAowMDAwMDAxNDA1IDAwMDAwIG4gCnRyYWlsZXIKPDwvSW5mbyA3IDAgUi9JRCBbPGM4OTA3ZjAzMTYx
OWJlZWJiZDA3YWVkN2UzOTY1ZTFjPjw5ZGIxYWQyMzZhNWI5NTU4ZTFjOTgzZjk5ZWQwMjc3ND5dL1Jvb3Q
gNiAwIFIvU2l6ZSA4Pj4Kc3RhcnR4cmVmCjE1MzYKJSVFT0YK",
"media": "laser-a4"
}
]
Fetch a filtered shipment list
GET/shipment-manifests/{manifestType}/shipments
Fetches a filtered shipment list using different filtering criteria.
URI parameters
|
Parameter |
Type |
Description |
Category |
|
manifestType |
string |
Carrier's shipment list type Valid values:
|
Required |
Query parameters
|
Parameter |
Type |
Description |
Category |
|
dateFrom |
string |
The lower limit of a date interval, referring to "Printed date" 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, referring to "Printed date" |
Optional Must be used together with dateFrom. |
|
page |
number |
Result pages containing max. 50 shipments |
Required Provides a way to page through the complete result. Starts at zero and increments upwards. |
|
receiverId |
string |
Unique receiver identification |
Optional |
|
route |
string |
Shipment route |
Optional |
|
senderID |
string |
Unique sender identification |
Optional |
|
services |
string |
Services to be included For service codes, see>> Services in nShift Delivery. |
Optional Service codes are separated using a comma (,). |
|
status |
string |
Shipment status Valid values: "new" (default)|"all" |
Optional |
Response example
{
"page": 0,
"totalPages": 1,
"totalCount": 2,
"manifestShipmentsInfoData": [
{
"id": 5322890,
"sndName": "Unifaun AB",
"sndZipcode": "11359",
"sndCity": "STOCHOLM",
"sndCountry": "SE",
"sndQuickId": "1",
"rcvName": "Unifaun AB",
"rcvZipcode": "11359",
"rcvCity": "STOCKHOLM",
"rcvCountry": "SE",
"rcvQuickId": "1",
"serviceId": "BCF",
"orderNo": "Order number",
"reference": "A reference",
"route": "",
"status": "PRINTED",
"shipDate": "2022-01-04T13:20:40.000+0000",
"printDate": "2022-01-04T13:20:40.971+0000"
},
{
"id": 5322926,
"sndName": "Unifaun AB",
"sndZipcode": "11359",
"sndCity": "STOCHOLM",
"sndCountry": "SE",
"sndQuickId": "1",
"rcvName": "Unifaun AB",
"rcvZipcode": "11359",
"rcvCity": "STOCKHOLM",
"rcvCountry": "SE",
"rcvQuickId": "1",
"serviceId": "BCF",
"orderNo": "Order number",
"reference": "A reference",
"route": "",
"status": "PRINTED",
"shipDate": "2022-01-04T13:45:14.000+0000",
"printDate": "2022-01-04T13:45:14.703+0000"
}
]
}
Fetch a previously printed shipment list
GET/shipment-manifests/{manifestId}/prints
Fetches previously printed shipment list documents based on manifest ID.
URI parameters
| Parameter | Type | Description | Category |
|
manifestId |
string |
Identifies the shipment list |
Required |
Query parameters
| Parameter | Type | Description | Category |
|
returnFile |
boolean |
'true' if the file should be returned inline. |
Optional |
Response example
Create a shipment list copy
POST/shipment-manifests/{manifestId}/prints
Creates and prints a copy of a previously printed shipment list.
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 |
|
manifestId |
string |
Identifies the shipment list |
Required |
Query parameters
| Parameter | Type | Description | Category |
|
returnFile |
boolean |
'true' if the file should be returned inline. |
Optional |
Body example
{
"target1Media":"laser-a4"
}
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.