Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...