Skip to main content

/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.

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.

Create a shipment list

POST /shipment-manifests/{manifestType}/manifests

Creates and prints a shipment list with available shipments for a certain manifest type.

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.

Fetch shipment list documents

GET /shipment-manifests/{manifestType}/manifests/{manifestId}/prints

Fetches all shipment list documents based on manifest type and manifest ID.

Fetch a filtered shipment list

GET /shipment-manifests/{manifestType}/shipments

Fetches a filtered shipment list using different filtering criteria.

Fetch previously printed shipment list

GET /shipment-manifests/{manifestId}/prints

Fetches previously printed shipment list documents based on manifest ID.

Fetch a specific printed shipment list

GET /shipment-manifests/{manifestId}/prints/{printId}

Fetches a specific shipment list document based on manifest ID and print ID.

Create a shipment list copy

POST /shipment-manifests/{manifestId}/prints

Creates and prints a copy of a previously printed shipment list.

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.