nShift Delivery Help Center

APIConnect

APIConnect is an integration service provided by nShift making it easy to integrate your cloud-based ERP or WMS system with nShift Delivery resulting in simpler dispatch processing, safer transactions and significant time savings.

APIConnect uses a REST API framework for communication with JSON as data carrier offering a number of functions.

With APIConnect you can:

  • Print labels and documents

  • Create and print shipment lists (also known as "Manifests", "End of day manifests", "Shipment manifests", etc.)

  • Store shipments

  • Retrieve shipment history

  • Generate single and consolidated shipments

  • Create email pre-notification

  • Create and send links to shipment documents

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.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

How it works

APIConnect offers a number of resources with functions and methods that can be used to perform certain actions.

For information about some crucial objects, please refer to REST API Objects.

Resources
/shipments

Print shipment documents as PDF or ZPL files provided as a URL or a Base64 encoded file. The resource also has methods and endpoints for history follow-up and shipment deletion, i.e. preventing sending EDI message to carrier.

Printed files are available for one (1) hour and can be fetched multiple times.

/shipment-manifests

Print shipment list 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.

Printed files are available for one (1) hour and can be fetched multiple times.

/stored-shipments

Store shipments that do not require immediate printing. Stored shipments can be printed either via the API or manually from the nShift Delivery interface.

/consolidated-shipments

Print shipment documents continuously while holding the EDI message. Creating fewer shipments containing multiple orders reduces shipping costs. The Consolidated shipment feature's availability depends on service.