nShift Delivery Help Center

Stored shipments

Create shipments and store them for later printing.

POST /stored-shipments

Creates a shipment and stores it for later printing.

Notice

Only a limited number of values are needed in the shipment data of the request body. But for a stored shipment to be created as ready it must fulfill the specific requirements of the shipment service.

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 /stored-shipments POST.

GET /stored-shipments

Fetch a list of stored shipments.

Notice

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

Max. 50 stored shipments will be returned.

Query parameters

dateFrom

string

The lower limit of a date interval.

ISO-8601 date format, e.g. 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, e.g. 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 /stored-shipments GET.

DELETE /stored-shipments/{storedId}

Deletes a stored shipment.

URI parameters

storedId

string

The stored shipment ID

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 /stored-shipments/{storedId} DELETE.

POST /stored-shipments/{storedId}/shipments

Creates and prints a shipment from a stored shipment. Creates more shipments if the stored shipment represents a combined normal and return shipment.

Notice

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.

Important

The generated documents will only be available for one (1) hour.

Query parameters

storedId

string

Stored shipment ID

Required

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 /stored-shipments/{storedId}/shipments POST.