1.0 Introduction to the OmniParcel API

Owned by Mette Evjenth
Last updated: Oct 25, 2023
2 min read

On this page:

1.1 Purpose

The purpose of this document is to explain how an operating system can integrate with OmniParcel via API (Web Services).

The processes outlined in this document include:

  • Order creation or publishing of an order

  • Reprinting of existing orders

  • Manifesting of orders

  • Tracking of orders

 

1.2 Required APIs

In order to set up a successful integration into OmniParcel, the following APIs are required at a minimum:

  • Consignment creation API (required in order to create a consignment)

  • Manifest API (required in order to notify OmniParcel and SEKO operations that consignments are ready)

 

Other APIs available:

  • Available rates API (enables the user to check what rates are available between the selected origin and destination prior to creating the consignment

  • Reprint API (enables OmniParcel to push a label directly to your printers for an already created consignment)

  • Consignment delete API (enables you to delete a consignment that has been created and has not started moving through the network)

  • Tracking via webhook, csv, or API (when activated, OmniParcel will send tracking updates relating to your consignments to your system)

 

1.3 REST API

OmniParcel uses REST API for data transmission. REST (REpresentational State Transfer) API is a simple stateless architecture that runs over the internet. RESTful applications use HTTP requests to create, read, update or delete data.

 

1.4 JSON

OmniParcel uses JSON due to its simplicity and human-readable data format. JSON (JavaScript Object Notation) is a way to store information in an organized, easy-to-access manner.

 

1.5 Field types

String – A String field is a field type used for textual characters.
Boolean – A Boolean field is a field type used for truth values. E.g. true, false
Integer – An Integer field is a field type used for numbers. E.g. an amount.

 

1.6 Label printing options

OmniParcel can produce Labels using two methods:

  1. OmniParcel sends information to an OmniParcel Print Agent. The print agent then sends the print job to the printer queue.

  2. OmniParcel sends label in either PDF or PNG format back to your system in API. Your system then sends job to the printer queue.

  3.  

1.7 Authentication

All HTTP requests will require an access key. The key needs to be declared as the HTTP Request Header.

  • The access key will be provided by OmniParcel on request.

  • If OmniParcel needs to send print jobs to multiple printers, each printer will require its own access key

  • Please ensure that the key is not hardcoded into the system.