Overview of Shipium Javascript Local API

Overview

The Shipium Javascript Local API provides a client interface for retrieving product Delivery Estimates and subsequently registering the estimates and Order details with the Shipium service.

The API takes care of the following concerns:

  • Generating an OAuth token for a user and storing the token for future use in a cookie on your Customer's browser.
  • Providing a simple functional interface to call the Shipium service for a Delivery Estimate.
  • Formatting the resulting Delivery Estimate for easy use by the implementor.
  • Maintaining a list of Delivery Estimate IDs on the customer's browser in local storage.
  • Providing a simple functional interface to call the Shipium service to register Delivery Estimates after a customer has completed checking out.

🚧

Note

The Shipium JavaScript Local API provides support for all of the major production functions of the Shipium APIs, but may lag slightly behind more recent versions of the pure REST API.

📘

Roll your own

The Javascript Local API is provided to make integration easier, but you are also welcome to integrate with the APIs directly using the Shipium API


Did this page help you?