Which Shipium APIs should I use?

You can use just a single Shipium API to meet a specific need, or take advantage of multiple APIs.

This diagram shows the APIs in sequence order:

404404

What the APIs do

This list shows the APIs and what each can do for you:

You can combine APIs at different points in the ecommerce chain, or use just a single API to meet a specific need. Click the links for more details of the APIs.

Delivery experience with delivery estimate API

Most customers want to know when they will get a product delivered even before they buy it. This is the reason to use delivery estimates; it is critical to cart conversion.

When you use this API:

  1. When you show a Customer a product, the API registers a page view and produces an accurate delivery estimate date.
  2. When a Customer checks out, the API creates a representation of your order, maps deliveryEstimateIds to quantities in the order and provides other order properties.
  3. When a shipment leaves your Fulfillment Center (FC), the API reports when a partner has shipped a package containing one or more items.
  4. The API tracks the package(s).
  5. On delivery, the API updates the delivery date/time.

For full details, see Delivery Experience Flow: Using Delivery Estimates

Delivery experience (order-based) API

If you use order-based implementation instead of delivery promises, this API manages the rest of the flow.

When you use this API:

  1. After a Customer purchases a product from your site, you use the API to create a representation of your order and map products to quantities in the order along, plus other order properties.
  2. When your Fulfillment Center ships a package, the API handles both of the following cases:
    • The shipment contains exactly what was in the order.
    • The shipment contains the complete or partial contents of multiple orders.
  3. On delivery, the API records the delivery date/time.

For full details, see Delivery Experience Flow: Order-Based

Subscription timing API

If you use a subscription model, a common problem is knowing when to ship product to your customers to hit an approximate delivery date. This API solves the problem by using information on your business and carrier transit times to recommend when to ship each package.

For full details, see Subscription Timing API Overview

Package sizing API

Use this API to determine an appropriate set of packaging types and sizes for one or more items in a shipment. Special processes and hazardous materials can be covered too. You set up the sizes and types of package available at each Fulfillment Center (FC) in your network and the API does the rest.

For full details, see Package Sizing Flow

Carrier and method selection API

Optimizing carrier and method selection is one of the key places where ecommerce models can reduce costs.

Use this API to find the least expensive shipping carrier and shipment method that meets a set of rules you define for any given shipment. Once the carrier and method have been determined, your software can obtain a label for that shipper as appropriate (see the next API below), or use our upcoming one call flow as a single interface to all the major carriers.

For full details, see Carrier and method selection flow.

Carrier label service API

After determining the carrier and method with the above API, you can call this API to purchase postage and obtain an appropriate label for that shipper. You can also use this API on its own, if desired.

For full details, see Carrier shipment label flow.

Carrier and method selection and labeling in one call

This combines the functions of the previous two APIs in a single call, reducing network overheads.

For full details, see Carrier and Method Selection with Label Single Call.


Did this page help you?