Get started

To use the Cart Checkout Delivery Promise API, you must first configure your account. Guidance can be found in the Delivery Promise documentation. This document provides instructions for using the API.

Retrieve an estimated delivery date (EDD) for your cart checkout pages with the Cart Checkout Delivery Promise API

The Shipium Cart Checkout Delivery Promise API is designed to be flexible to fit your organization’s business strategy and technical capabilities. All API calls assume you're using one of the authentication mechanisms detailed in our authentication documentation. The endpoint for all Cart Checkout Delivery Promise API calls is included in the table below.

Request and response fields for API calls

The following tables provide required, conditional, and optional fields for calling the Cart Checkout Delivery Promise API. You can find additional support in the Cart Delivery Date Estimate API Reference.

Required request fields

Conditional request fields

Optional request fields

Response attributes

The Cart Checkout Delivery Promise response attributes are defined in the following table.

Shipium assumptions for the Cart Checkout Delivery Promise API

• Origin

The shipment will ship from the closest origin to the customer based on distance.

• Shipment date

The shipment will ship based on the timestamp of the request plus the configured click-to-ship time and the configured schedule at the origin.

• Ship method

Standard Ground

Retrieve an EDD for a shipment at cart checkout (primary use case)

Example cURL call

curl --request POST
  --url https://api.shipium.com/api/v1/deliveryexperience/cartDeliveryEstimate
  --header 'accept: application/json'
  --header $AUTHSTRING
  --header 'content-type: application/json'
  --data 'INSERT REQUEST BODY FROM BELOW'

Example request body

{
  "partnerCartId": "74b6e652-8db2-4441-9cf6-85a18a15ca88",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "productViewDeliveryEstimateIds": ["0b3d140a-525b-43a7-896c-cdc381580d61"],
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "fromCountryCode": "US",
        "fromPostalCode": "98101",
        "estimateSource": "ShipiumGenerated"
      }
      ]
    },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
   "shipiumCartId": "66401470-aedc-4a03-9509-a8383e650a4d",
   "partnerCartId": "74b6e652-8db2-4441-9cf6-85a18a15ca88",
   "customerCountryCode": "US",
   "customerPostalCode": "98101",
   "productViewDeliveryEstimateIds": ["0b3d140a-525b-43a7-896c-cdc381580d61"],
   "originDeliveryEstimates":[
      {
         "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
         "deliveryEstimateDate": "2019-10-31T00:00:00Z",
         "deliveryEstimateDateUTC": "2019-10-31T00:00:00Z",
         "estimateSource": "ShipiumGenerated",
         "estimatedTimeInTransitDays": 3,
         "shippingOrigin": {
            "countryCode": "US",
            "postalCode": "98101",
            "shipiumOriginId": "0b3d140a-525b-43a7-896c-cdc381580d62",
            "originProcessingDays": 2.5
         },
         "cartShippingOptions":{
            "shippingLocation": {
               "fromCountryCode": "US",
               "fromPostalCode": "98101",
               "estimateSource": "ShipiumGenerated"
            }
         }
      }
   ],
   "partnerReferenceIdentifier": "ORD-2026-12345"
}

Augmentations to the EDD request (additional use cases)

Your organization may choose to augment your EDD request by including any of the following optional fields, which will generally enhance the accuracy of our EDD calculation.