Skip to main content

Consolidated shipments

PREMIUM

Create, print and follow-up consolidated shipments.

Note

Availability of consolidated shipment may vary by carrier and service. Please refer to Help > Code lists > "Services (ERP-connection XML)".

POST /consolidated-shipments

Creates an open consolidated shipment.

Note

The shipment data in the request body must fulfill the specific requirements of the shipment's service.

The request body must contain an option object with id 'consolidate'.

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.

Query parameters

returnFile

boolean

'true' if the PDF/ZPL 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 /consolidated-shipments POST.

GET /consolidated-shipments

Fetch a list of open consolidated shipments.

Note

Use the query parameters to filter out which consolidated shipments will be returned in the list.

Max. 50 consolidated shipments are returned per call.

Query parameters

dateFrom

string

The lower limit of a date interval.

ISO-8601 date format, for example, 2020-01-01T01:00:00+00:00

Optional

Must be used together with dateTo and dateType.

dateTo

string

The upper limit of a date interval.

ISO-8601 date format, for example, 2020-02-01T01:00:00+00:00

Optional

Must be used together with dateFrom and dateType.

dateType

string

The type of date.

Valid values: created | ship

Optional

Must be used in combination with dateFrom and dateTo.

searchField

The field to search in.

Valid values: orderNo | reference | shipmentNo

Optional

searchOp

The operator used on the field.

Valid values: equals | contains | startsWith |endsWith

Optional

searchValue

string

The value to search for.

Optional

status

Shipment status

Valid values: ready | invalid | failed | warned

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 /consolidated-shipments GET.

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

Deletes a parcel group from the consolidated shipment.

Note

No response body is returned when a parcel group is successfully deleted.

URI parameters

Consolidated Shipment ID

string

Identifies the consolidated shipment

Required

Part Order No

string

The parcel group order number

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 /consolidated-shipments/{consolidatedId}/parcel/{partOrderNo} DELETE.

DELETE /consolidated-shipments/{consolidatedId}

Deletes a consolidated shipment.

Note

No response body is returned when a consolidated shipment is successfully deleted.

A cancelled consolidated shipment will be added to the shipment history to represent the previously printed documents related to the consolidated shipment.

URI parameters

Consolidated Shipment ID

string

Identifies the consolidated shipment

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 /consolidated-shipments/{consolidatedId} DELETE.

GET /consolidated-shipments/{consolidatedId}/prints

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

Note

By default the documents are returned as a URL. As an option the documents can be inline in the prints.data object in the result. The prints.data object is encoded in base64.

Charset options are set in the target1Options array in the printConfig object.

Generated documents are only available for one (1) hour.

URI parameters

Consolidated Shipment ID

string

Identifies the consolidated shipment

Required

Query parameters

returnFile

boolean

'true' if the PDF/ZPL 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 /consolidated-shipments/{consolidatedId}/prints GET.

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

Fetch a PDF or ZPL document for a consolidated shipment.

Note

The document is returned as a raw binary stream from this endpoint. Make sure the request has the Accept header set to application/pdf for PDF documents or application/octet-stream for ZPL documents.

Charset options are set in the target1Options array in the printConfig object.

URI parameters

Consolidated Shipment ID

string

Identifies the consolidated shipment

Required

Print ID

string

Identifies the PDF or ZPL 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 /consolidated-shipments/{consolidatedId}/prints/{printId} GET.

POST /consolidated-shipments/{consolidatedId}/shipments

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

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

Consolidated Shipment ID

string

Identifies the consolidated shipment

Required

Query parameters

returnFile

boolean

'true' if the PDF/ZPL 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 /consolidated-shipments/{consolidatedId}/shipments POST.

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.

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

Consolidated Shipment ID

string

Identifies the consolidated shipment

Required

Query parameters

returnFile

boolean

'true' if the PDF/ZPL 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 /consolidated-shipments/{consolidatedId}/shipments/manifest POST.