Skip to main content

/consolidated-shipments

PREMIUM

Consolidated-shipments is how you print shipment documents continuously while holding the EDI message.

Important

Availability of consolidated shipment may vary by carrier and service. Please refer to Help > Code lists > "Service codes - Integration".

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 consolidated shipment

POST /consolidated-shipments

Creates an open consolidated shipment.

Fetch consolidated shipments

GET /consolidated-shipments

Fetch a list of open consolidated shipments.

Delete a parcel group from a consolidated shipment

DELETE /consolidated-shipments/{consolidatedId}/parcel/{partOrderNo}

Deletes a parcel group from the consolidated shipment.

Delete a consolidated shipment

DELETE /consolidated-shipments/{consolidatedId}

Deletes a consolidated shipment.

Fetch a list of consolidated shipment documents

GET /consolidated-shipments/{consolidatedId}/prints

Fetch a list of all PDF or ZPL documents for a consolidated shipment.

Fetch a document for a consolidated shipment

GET /consolidated-shipments/{consolidatedId}/prints/{printId}

Fetch a PDF or ZPL document for a consolidated shipment.

Close a consolidated shipment and create shipment documents

POST /consolidated-shipments/{consolidatedId}/shipments

Closes an open consolidated shipment and creates PDF or ZPL shipment documents.

Close a consolidated shipment and create shipment documents and exclude shipments

POST /consolidated-shipments/{consolidatedId}/shipments/manifest

Closes an open consolidated shipment and creates PDF or ZPL shipment documents for the shipments identified by their part order number.

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.