Shipment lists
Create and print shipment lists.
POST |
Creates and prints a shipment list with available shipments for a certain manifest type.
Note
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
manifestType | string | Carrier's shipment list type Valid values:
| Required |
Query parameters
returnFile | boolean | 'true' if the file should be returned inline. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestType}/manifests POST.
GET |
Fetches a shipment list based on manifest ID, manifest type and print ID.
URI parameters
manifestId | string | Identifies the shipment list | Required |
manifestType | string | Carrier's shipment list type Valid values:
| Required |
printId | string | Identifies the document. | Required |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestType}/manifests/{manifestId}/prints/{printId} GET.
GET |
Fetches all shipment list documents based on manifest type and manifest ID.
URI parameters
manifestId | string | Identifies the shipment list | Required |
manifestType | string | Carrier's shipment list type Valid values:
| Required |
Query parameters
returnFile | boolean | 'true' if the files should be returned inline. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestType}/manifests/{manifestId}/prints GET.
GET |
Fetches a filtered shipment list using different filtering criteria.
URI parameters
manifestType | string | Carrier's shipment list type Valid values:
| Required |
Query parameters
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 |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestType}/shipments GET.
GET |
Fetches previously printed shipment list documents based on manifest ID.
URI parameters
manifestId | string | Identifies the shipment list | Required |
Query parameters
returnFile | boolean | 'true' if the file should be returned inline. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestId}/prints GET.
POST |
Creates and prints a copy of a previously printed shipment list.
Note
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
manifestId | string | Identifies the shipment list | Required |
Query parameters
returnFile | boolean | 'true' if the file should be returned inline. | Optional |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-manifests/{manifestId}/prints POST.