nshiftone

Shipping Management

Addresses

Senders

Receivers

Shipments

Create a new shipment.

To create a shipment, the values in the shipment data of the request body  must fulfill the specific requirements of the shipment's service. If this isn't the case no shipment will be created and a list of validation errors will be returned instead. To actually create a shipment the values supplied in the request body must **not** include an *`option`* object with id *`CONSOLIDATE`*. Otherwise a consolidated shipment will be created instead of a normal shipment. To check that a normal shipment was created look at the *`consolidated`* value in the result of a successful call.

Documents will be created according to the provided print configuration. Please note that the generated documents will only be available for 1 hour.
By default the documents have to be requested from the URL contained in the *`href`* value of *`prints`* objects in the result. As an option the PDF or ZPL documents can be inline in the *`data`* object in the result *`print`* array. The *`print.data`* object is encoded in base64. To activate this option include a query parameter named *`returnFile`* with the value set to *`true`*.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** license key.


Create Shipment

Fetch information about printed shipments.

To fetch batches of printed shipments this entry point uses a query parameter *`fetchId`* to track which shipments have been returned by previous calls. A client using this entry point should save the *`fetchId`* returned by a previous call and use that as parameter value for the next call. If no *`fetchId`* is available from a previous call the value -1 can used to make a call that will return the *`fetchId`* to use in a subsequent call.

No more than 100 shipments are returned as a result of a single call. If more than 100 shipments are available the *`done`* value in the result will be *`false`* and you should make another call to fetch the remaining shipments. Repeated calls when *`done`* is *`false`* are not subject to the rate limits (see below) of this entry point.

There is a rate limit on this entry point and if calls are made too fast the *`minDelay`* value in the result will return how long you have to wait (in milliseconds) before calling again. To avoid an uneven call rate because of the rate limit try to keep the call rate to less than one call per five minutes.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/shipments.html

This service requires a license for the **TrackBack** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by **REST API TrackBack** license key.


Fetch Shipment

Cancel a shipment.

After a successful call to this entry point the shipment will get a *`cancelled`* status. A cancel message will be sent for the shipment if it is supported by the carrier.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Discard** license key.


Delete Shipment

{shipmentId}

Shipment Manifests

Print a shipment manifest based on required param manifestType.


Create Shipment Manifest

Get filtered manifest list based on query params


Fetch Shipment Manifest

Get all manifests based on the required manifestType and manifestId.


Fetch Shipment Manifest Documents

Get the manifest PDF based on the required manifestType, manifestId and printId.


Fetch Shipment Manifest PDF

Get filtered shipments list based on query params


Fetch Filtered Shipment Manifest

Get list of manifests pdfs based on manifest id


Fetch Printed Shipment Manifest

Get list of manifest pdfs based on manifest id and print id


List Shipment Manifest PDFs

Create Shipment Manifest Copy

Stored Shipments

Create a new stored shipment.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Store** license key.


Create Stored Shipment

Fetch a list of stored shipments information.

Use the query parameters to filter which stored shipments will be returned in the list.
Please note that a maxium of 50 stored shipments will be returned.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Store** license key.


Lists Stored Shipments

Delete a stored shipment.

The stored shipment will be completely deleted from the system when this call returns successfully. No further operation will be possible on the ID of the stored shipment.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Store** license key.


Delete Stored Shipment

Update a stored shipment by replacing it.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Store** license key.


Replace Stored Shipment

Get a single stored shipment.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Delivery checkout** license key.


Fetch Stored Shipment

Create one or more shipments from a stored shipment.

A successful call to this entry point can result in either a shipment or a consolidated shipment. Use the *`consolidated`* value in the result to check what type of object was created.

Multiple shipments can be created if the stored shipment represent a combined normal and return shipment.

PDF or ZPL documents will be created according to the provided print configuration. Please note that the generated documents will only be available for 1 hour.
By default the documents have to be requested from the URL contained in the *`href`* value of *`prints`* objects in the result. As an option the PDF or ZPL documents can be inline in the *`data`* object in the result *`print`* array. The *`print.data`* object is encoded in base64. To activate this option include a query parameter named *`returnFile`* with the value set to *`true`*.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/stored-shipments.html

This service requires a license for the **APIConnect** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** license key.


Create Shipment from Stored Shipment

Consolidated Shipments

Create a new consolidated shipment.

To create a consolidated shipment, the values in the shipment data of the request body  must fulfill the specific requirements of the shipment's service. If this isn't the case no consolidated shipment will be created and a list of validation errors will be returned instead. To actually create a consolidated shipment the values supplied in the request body must include an *`option`* object with id *`CONSOLIDATE`*. Otherwise a normal shipment will be created instead. To check that a consolidated shipment was created look at the *`consolidated`* value in the result of a successful call.

PDF or ZPL documents will be created according to the provided print configuration. Please note that the generated documents will only be available for 1 hour.
By default the documents have to be requested from the URL contained in the *`href`* value of *`prints`* objects in the result. As an option the PDF or ZPL documents can be inline in the *`data`* object in the result *`print`* array. The *`print.data`* object is encoded in base64. To activate this option include a query parameter named *`returnFile`* with the value set to *`true`*.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** and **Consolidation** license keys.


Create Consolidated Shipment

Fetch a list of open consolidated shipments.

Use the query parameters to filter which consolidated shipments will be returned in the list.
Please note that a maxium of 50 consolidated shipments will be returned.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** and **Consolidation** license keys.


List Open Consolidated Shipments

Delete a parcel group on a consolidated shipment.

The matching consolidated parcel group will be removed from the system after a successful call to this entry point.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Discard** and **Consolidation** license keys.


Delete Parcel Group

Delete a consolidated shipment.

The consolidated shipment will be removed from the system after a successful call to this entry point. A cancelled shipment object will be added to shipments to represent the previously printed documents from this consolidated shipment.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Discard** and **Consolidation** license keys.


Delete Consolidated Shipment

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

The list of PDF documents can optionally include the PDF as a base64 encoded string if the *`inlinePdf`* query parameter is used with a value set to *`true`*.

Please note that generated PDF documents are only available for 1 hour.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** and **Consolidation** license keys.


List PDFs

Fetch a PDF document for a consolidated shipment.

The PDF document is streamed as a raw binary stream from this entry point. **NOTE** Make sure the request has a correct *`Accept`* header set to *`application/pdf`*.

Read more: https://help.unifaun.com/uo-se/en/integrations/apiconnect/consolidated-shipments.html

This service requires a license for the **APIConnect** and **Consolidation** functions that can be purchased from nShift webshop. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by the **REST API Print** and **Consolidation** license keys.


Fetch PDF

Shipment Waybills

Fetch information about shipments waybills.


List Shipment Waybill

{waybillId}

Shipment History

Fetch information about shipments (max 6 months old).
To fetch shipments this entry point uses a query parameter *`page`*, *`dateFrom`*, *`dateTo`*, *`dateType`*, *`searchField`*, *`searchValue`*, *`status`*, to track shipments.
No more than 50 shipments are returned as a result of a single page. All the results will be order by created date in descending order.
This service requires a license for the function that is delivered  with the integration API licence keys, under the
 name of **REST API Shipment History** license key.


Fetch Shipment History

Print

Clients

Send a print job to any connected printer by consolidatedId and printId. Define printerId and other print job settings in the request body. Returns the resulting print job. The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.  The property contentType must be either of the following values: pdf_base64, pdf_uri, raw_base64, raw_uri. and defaults to *_uri depending on format of the generated document.


Create Print Job

Printers

Printjobs

Send a print job to any connected printer by manifestId and printId. Define printerId and other print job settings in the request body. Returns the resulting print job. The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.  The property contentType must be either of the following values: pdf_base64, pdf_uri, raw_base64, raw_uri. and defaults to *_uri depending on format of the generated document.


Create Manifest Print Job

Send a print job to any connected printer by shipmentId and printId. Define printerId and other print job settings in the request body. Returns the resulting print job. The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.  The property contentType must be either of the following values: pdf_base64, pdf_uri, raw_base64, raw_uri. and defaults to *_uri depending on format of the generated document.


Create Shipment Print Job

Prices

Fetch price information about a shipment.
You can add additionl surcharges either amount, percent or both. If you add both the percent is calculated on sum of the price plus additional amount. You write percent as whole value for example if you want to add 10% you write 10.

Read more: https://help.unifaun.com/uo-se/en/integrations/price-via-api.html

This service requires a license for the **REST API price enquiry** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by **REST API price enquiry** license key.


Fetch Shipment Price

Fetch information about prices for shipments.

To fetch batches of prices this entry point uses a query parameter *`fetchId`* to track which prices have been returned by previous calls. A client using this entry point should save the *`fetchId`* returned by a previous call and use that as parameter value for the next call. If no *`fetchId`* is available from a previous call the value -1 can used to make a call that will return the *`fetchId`* to use in a subsequent call.

No more than 100 prices are returned as a result of a single call. If more than 100 prices are available the *`done`* value in the result will be *`false`* and you should make another call to fetch the remaining prices. Repeated calls when *`done`* is *`false`* are not subject to the rate limits (see below) of this entry point.

There is a rate limit on this entry point and if calls are made too fast the *`minDelay`* value in the result will return how long you have to wait (in milliseconds) before calling again. To avoid an uneven call rate because of the rate limit try to keep the call rate to less than one call per five minutes.

Read more: https://help.unifaun.com/uo-se/en/integrations/price-via-api.html

This service requires a license for the **Status events** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by **REST API price enquiry** license key.


Fetch Price History

Status Events

Fetch information about status events connected to shipments.

To fetch batches of status events this entry point uses a query parameter *`fetchId`* to track which events have been returned by previous calls. A client using this entry point should save the *`fetchId`* returned by a previous call and use that as parameter value for the next call. If no *`fetchId`* is available from a previous call the value -1 can used to make a call that will return the *`fetchId`* to use in a subsequent call.

No more than 100 events are returned as a result of a single call. If more than 100 events are available the *`done`* value in the result will be *`false`* and you should make another call to fetch the remaining events. Repeated calls when *`done`* is *`false`* are not subject to the rate limits (see below) of this entry point.

There is a rate limit on this entry point and if calls are made too fast the *`minDelay`* value in the result will return how long you have to wait (in milliseconds) before calling again. To avoid an uneven call rate because of the rate limit try to keep the call rate to less than one call per five minutes.

Read more: https://help.unifaun.com/uo-se/en/integrations/shipment-status-via-api/shipment-status.html

This service requires a license for the **Status events** function that can be ordered separately. To view functions available to you, go to *Help* -> *Session* menu in your account and look in the License keys section. This function is represented by **REST API Status events** license key.


Fetch Status Events

Code Lists

Lists

Onboarding

Primary users of this service are members of the partner network and it requires a special license. To view available functions in your account, navigate to Help -> Session menu in your account and look in the License keys section. This function is represented by the **REST API Onboarding** license key.

Read more: https://help.unifaun.com/phc-se/en/16401-16530-onboarding-api.html


Fetch Accounts

Applications

Fetch Onboarding Language

Order Management

Comments

Create Comment

Delete Comment

Fetch Comment

DeliveryOptions

Create Delivery Option

Update Delivery Option

Delete Delivery Option

Fetch Delivery Option

List Delivery Option

OrderChannels

Create Order Channel

Update Order Channel

Delete Order Channel

Fetch Order Channel

Fetch Order Channel Types

List Order Channels

Orders

Create Order

Update Order

Delete Order

Fetch Order

List Orders

Default

nShift Delivery

Production

Sandbox

Delete Receiver

Fetch Receiver

Update Receiver

Create Receiver

Replace Receiver

Delete Sender

Fetch Sender

Update Sender

Create Sender

Replace Sender

{clientId}

Fetch Application Language

Fetch Print Client

List Printers

List Print Clients

Fetch Code Lists

Get Printers

Get Printers PrinterId

List Print Jobs

Fetch Print Job

List Documents

Fetch Document

Fetch Shipment Waybill

Create Applications

Pdfs

Create PDF Copy

Create Document Copy

Create Shipment Waybill

Prints

Represents how you manage print client applications, printers and print jobs in Print by nShift.

Represents how you manage print client applications, printers and print jobs in Print by nShift.

Fetch a list of all Print client applications. Return only partial list using pagination parameters page and size.


Fetch a list of all Print client applications. Return only partial list using pagination parameters page and size.

Fetch a list of all Print client applications. Return only partial list using pagination parameters page and size.

Authorization

page

size

name

inet

inet6

hostname

version

createTimestamp

state

code

message

Returned for Access denied. This means you used an API key that was not registered on DPC.


Returned for missing licence for api key


Returned for internal server errors. If the error isn't resolved within a couple of minutes please contact Support for additional assistance to resolve the problem.


Sections

List Print Clients

Header Parameters

Query Parameters

Response

Response Attributes

Response Attributes

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

List Print Clients

Header Parameters

Query Parameters

Response

Response Attributes

Response Attributes

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Ask an AI

Code with AI