Delivery Experience Flow: Order-Based

Overview

The Shipium ShipTime API is focused on helping you to provide better information to your Customers on your company's product pages and to help you better understand the times inherent in each step of your fulfillment process. In order to facilitate that, your systems will call into the ShipTime API at a few points in your Customer's Delivery Experience.

In the order-based flow, everything begins when a Customer checks out, as shown below.

Activity

Endpoint

1. Customer orders and checks out

After a Customer purchases a product from your site, you call the endpoint to create a representation of your order and provide a map of products to quantities in the order along, plus other order properties.

For simplicity, you can also pass your company's orderId to use as an alias in future calls.

/deliveryexperience/order

2. Customer's shipment leaves your warehouse

When your FC ships a package to a customer, you call one of two endpoints depending on the situation:

  • If the shipment contains exactly what was in a prior order, you call the first endpoint for simplicity.
  • If you are shipping a package that contains the complete or partial contents of multiple orders, you can specify the contents of the shipment using the second endpoint.

/deliveryexperience/order/{orderId}/shipment)

/deliveryexperience/ship

3. Customer's shipment is delivered

When your Customer's shipment is delivered by a carrier, you call the endpoint to update the shipment's delivery date/time with a PUT to the existing shipment.

/deliveryexperience/shipment/{shipmentId})

These three stages are described in detail in the following pages.


Did this page help you?