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.

API type	API endpoint
POST	`https://api.shipium.com/api/v1/deliveryexperience/cartDeliveryEstimate`

🔐
Authentication for API Calls
In the cURL example on this page, the environment variable AUTHSTRING is used to handle authorization. The recipe below shows how to set it correctly for both API Key and OAuth users.

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

Request field	Details
`partnerCartId`	Type: String Description: Your organization's identifier for this cart; returned in the response for correlation
`cartShippingOptions`	Type: Object Description: The container for this cart's shipping location options; must be supplied.
`cartShippingOptions` `.shippingLocationOptions`	Type: Array Description: An array of possible shipping locations with available inventory; at least one entry must be supplied. For each entry, supply either the `fromCountryCode` and `fromPostalCode` pair or the `originId`.
`customerCountryCode`	Type: String (enumeration) Format: Limited to 2 characters and ISO 3166 standards Description: Shipment's destination country
`customerPostalCode`	Type: String Description: Shipment's destination country appropriate postal code

Conditional request fields

Request field	Details
`shipDateOverride`	Type: String Format: Either the ISO 8601 standard date or a local date (`yyyy-mm-dd`) Condition: Required when `fromCountryCode` and `fromPostalCode` identify a location that is not one of your configured origins Description: Dictate the date that the origin will ship the item.
cartShippingOptions .shippingLocationOptions .fromCountryCode	Type: String Format: Limited to 2 characters and ISO 3166 standards Condition: Either the `fromCountryCode` and `fromPostalCode` or the `originId` must be provided. Description: Shipment's origin country; cannot be supplied in the same shipping location option as `originId`
`cartShippingOptions .shippingLocationOptions .fromPostalCode`	Type: String Condition: Either the `fromCountryCode` and `fromPostalCode` or the `originId` must be provided. Description: Shipment's origin country appropriate postal code; cannot be supplied in the same shipping location option as `originId`
`cartShippingOptions .shippingLocationOptions .originId`	Type: String Example: `origin-id-123` Condition: Either the `fromCountryCode` and `fromPostalCode` or the `originId` must be provided. Description: An identifier for the origin. Shipium accepts a Shipium origin ID, an identifier your organization assigned (`partnerProvided`), or an origin tag, and matches them in that order. An organization-assigned identifier or a tag can belong to more than one origin, in which case Shipium uses whichever of them produces the earliest estimated delivery date. Cannot be supplied in the same shipping location option as `fromCountryCode` or `fromPostalCode`

Optional request fields

Request field	Details
`requestDateOverride`	Type: String (date-time) Format: Limited to the ISO 8601 standard Example: `2019-10-31T00:00:00Z` Description: Dictate the base calculation of when the request happened. This field allows you to specify the request as though it had happened on a different date and/or time.
`productViewDeliveryEstimateIds`	Type: Array of strings Example: `0b3d140a-525b-43a7-896c-cdc381580d61` Description: An array of identifiers that were returned in the response from a call to the Product View API
`cartShippingOptions.shippingLocationOptions .shipOption`	Type: String (enumeration) Values: `Standard`, `SameDay`, `NextDay`, `TwoDay`, `ThreeDay` Description: Retrieve the estimate for a different ship option; the default value is `Standard`.
`cartShippingOptions.shippingLocationOptions .estimateSource`	Type: String (enumeration) Values: `ShipiumCalculated`, `PartnerProvided`, `CarrierProvided` Description: Restrict the estimate to a single time in transit (TNT) source. When you omit this field, Shipium uses whichever source is available for the route. When you supply a value and no estimate is available from that source, the request returns an error rather than falling back to another source.
`cartShippingOptions.shippingLocationOptions .deliveryBehaviorOverrides`	Type: Object Description: Override your organization's account-level weekend and holiday delivery behavior for this shipping location. These overrides apply to the `shipOption` specified in the same `shippingLocationOptions` object. Because the Cart Checkout API accepts multiple shipping location options, you can specify different overrides for different ship options within a single request — for example, enabling Saturday delivery for next-day shipping while using account defaults for standard shipping. When provided, these settings take precedence over your default configuration. Each field within the object is optional and can be set independently. If omitted, your account-level settings apply.
`cartShippingOptions.shippingLocationOptions .deliveryBehaviorOverrides .saturdayDeliveryBehavior`	Type: String (enumeration) Values: `ALLOW`, `NON_DELIVERY_DAY`, `NON_TRANSIT_NON_DELIVERY_DAY` Description: Controls how Saturdays affect delivery estimates. `ALLOW` treats Saturday as a regular transit and delivery day. `NON_DELIVERY_DAY` allows transit but no final delivery; if the calculated delivery date falls on Saturday, it shifts to the next available delivery day. `NON_TRANSIT_NON_DELIVERY_DAY` excludes Saturday from transit calculations entirely — no transit movement or delivery occurs. When provided, this overrides your organization's configuration in the Shipium platform for Saturday deliveries.
`cartShippingOptions.shippingLocationOptions .deliveryBehaviorOverrides .sundayDeliveryBehavior`	Type: String (enumeration) Values: `ALLOW`, `NON_DELIVERY_DAY`, `NON_TRANSIT_NON_DELIVERY_DAY` Description: Controls how Sundays affect delivery estimates. `ALLOW` treats Sunday as a regular transit and delivery day. `NON_DELIVERY_DAY` allows transit but no final delivery; if the calculated delivery date falls on Sunday, it shifts to the next available delivery day. `NON_TRANSIT_NON_DELIVERY_DAY` excludes Sunday from transit calculations entirely — no transit movement or delivery occurs. When provided, this overrides your organization's configuration in the Shipium platform for Sunday deliveries .
`cartShippingOptions.shippingLocationOptions .deliveryBehaviorOverrides .holidayDeliveryBehavior`	Type: String (enumeration) Values: `ALLOW`, `NON_DELIVERY_DAY`, `NON_TRANSIT_NON_DELIVERY_DAY` Description: Controls how holidays affect delivery estimates. `ALLOW` treats the holiday as a regular transit and delivery day. `NON_DELIVERY_DAY` allows transit but no final delivery; if the calculated delivery date falls on the holiday, it shifts to the next available delivery day. `NON_TRANSIT_NON_DELIVERY_DAY` excludes the holiday from transit calculations entirely — no transit movement or delivery occurs. When provided, this overrides your organization's configuration in the Shipium platform for holiday deliveries.
`cartShippingOptions.shippingLocationOptions` `.timeInTransitSetting`	Type: String (enumeration) Values: `aggressive`, `standard`, `conservative`, `very_conservative` Description: Overrides your account-level time-in-transit setting for this request; values are case sensitive. When omitted, your account-level setting applies.
`partnerReferenceIdentifier`	Type: String Description: An optional identifier your organization provides, used for reporting and cross-product correlation across Shipium APIs. Pass the same value you used in your Product View call to correlate this order across the full API chain. Continue passing this value in downstream Fulfillment Engine and Carrier Selection calls. This value is not passed to carriers. See Link API Calls Across Shipium Products for the full cross-product linking guide.
`referenceIdentifiers`	Type: Array of objects Description: Name and value pairs your organization supplies for reporting and internal tracking; returned in the response
`referenceIdentifiers.name`	Type: String Description: Your organization's identifier to associate with this request
`referenceIdentifiers.value`	Type: String Description: The value associated with the specified name
`partnerReferenceIdentifier2`	Type: String Description: A second optional identifier your organization provides, used for reporting and cross-product correlation alongside `partnerReferenceIdentifier`; returned in the response. This value is not passed to carriers.
`shipmentTags`	Type: Array of strings Description: A free-form list of shipment tags for this cart, used for downstream reporting; a maximum of 20 tags, each up to 64 characters; blank entries are ignored. Tags you provide are returned in the response; matches the `shipmentTags` field on the corresponding Carrier Selection request.

🗓️
Weekend and holiday delivery behavior values

ALLOW. The day is treated as a regular transit and delivery day.

NON_DELIVERY_DAY. Packages continue moving through the carrier network, but no final delivery occurs. If the calculated delivery date falls on this day, it shifts to the next available delivery day.

NON_TRANSIT_NON_DELIVERY_DAY. All carrier operations halt — no transit or delivery. The day is excluded from transit time calculations entirely.

Response attributes

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

Response attribute	Description
`shipiumCartId`	Unique Shipium-generated ID related to the request and response
`originDeliveryEstimates`	An array containing one delivery estimate for each shipping location option supplied on the request; each entry is evaluated independently, so the attributes below can differ between entries in the same response.
`originDeliveryEstimates` `.deliveryEstimateId`	Unique Shipium-generated ID for this origin's estimate
`originDeliveryEstimates` `.shipEstimateDate`	A valid date in ISO 8601 format representing the estimated ship date from this origin
`originDeliveryEstimates` `.shipEstimateDateUTC`	A valid date in ISO 8601 format with UTC timezone representing the estimated ship date from this origin
`originDeliveryEstimates` `.deliveryEstimateDate`	Shipium's estimated delivery date (EDD) for this origin, in the local timezone of the delivery postal code (`customerPostalCode`)
`originDeliveryEstimates` `.deliveryEstimateDateUTC`	A valid date in ISO 8601 format with UTC timezone representing the estimated delivery date for this origin
`originDeliveryEstimates` `.customerOrderCutoff`	The latest moment an order can be placed and still ship on this origin's `shipEstimateDate`, in the time zone of the shipping origin. The cutoff is non-inclusive: an order placed at exactly this moment ships on the next available ship date. Returned as `null` when a `shipDateOverride` applies to the request or when no delivery estimate could be calculated. Because this attribute uses the origin's time zone while `deliveryEstimateDate` uses the delivery postal code's, the two can carry different UTC offsets within the same response.
`originDeliveryEstimates` `.customerOrderCutoffUTC`	The same value as `customerOrderCutoff`, expressed in UTC; the two attributes are always populated together and are `null` together.
`originDeliveryEstimates` `.estimateSource`	The time in transit (TNT) calculation method that was used when calculating this EDD; one of `ShipiumCalculated`, `PartnerProvided`, `CarrierProvided`, or `Unknown`
`originDeliveryEstimates` `.estimatedTimeInTransitDays`	An integer value of the time in transit (TNT) in days
`originDeliveryEstimates` `.shippingOrigin`	The origin this estimate was calculated for
`originDeliveryEstimates` `.shippingOrigin` `.countryCode`	The origin's country, limited to 2 characters and ISO 3166 standards
`originDeliveryEstimates` `.shippingOrigin.postalCode`	The origin's country-appropriate postal code
`originDeliveryEstimates` `.shippingOrigin` `.shipiumOriginId`	Shipium's unique identifier for the origin
`originDeliveryEstimates` `.shippingOrigin.originId`	The value you supplied in `cartShippingOptions.shippingLocationOptions.originId` for this shipping location, returned exactly as you sent it. That request field accepts a Shipium origin ID, an identifier your organization assigned, or an origin tag, so this attribute may hold any of the three. Because an organization-assigned identifier or a tag can belong to more than one origin, this attribute does not always identify the origin used; `shippingOrigin.shipiumOriginId` always does. No value is returned when you did not supply one.
`originDeliveryEstimates` `.shippingOrigin` `.partnerOriginId`	The identifier your organization assigned to the origin used for this estimate; no value is returned when no identifier has been assigned to that origin.
`originDeliveryEstimates` `.shippingOrigin` `.originProcessingDays`	The number of processing days used to calculate the ship date for this estimate; may be fractional, in which case the fraction represents a portion of a day applied on top of whole business days. A value of `0` means the origin ships the same day.

📘
The shippingOptions object in the response
Each entry in originDeliveryEstimates includes a shippingOptions object. It reports the values Shipium used for that estimate, not a copy of what you sent.

originId holds the Shipium identifier of the origin that was used. It returns that value even when you identified the origin some other way, and even when you supplied no identifier. The value you sent is returned in shippingOrigin.originId.

fromCountryCode and fromPostalCode hold the location of the origin that was used, and are returned even when you did not supply them.

estimateSource holds the time-in-transit source that was used for the estimate.

timeInTransitSetting is not returned, even when you supply it on the request.

Identifying origins on a cart request

Every shipping location option must identify an origin, either by originId or by the fromCountryCode and fromPostalCode pair. Shipium does not select an origin for you on this API, and a shipping location option that supplies neither is rejected.

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

Example cURL call

curl --request POST   
  --url API_URL/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": "cart-2026-10-08-4471",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "originId": "warehouse-east"
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "shipiumCartId": "66401470-aedc-4a03-9509-a8383e650a4d",
    "partnerCartId": "cart-2026-10-08-4471",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
            "shipEstimateDate": "2026-10-09T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-09T20:00:00Z",
            "deliveryEstimateDate": "2026-10-13T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-14T03:00:00Z",
            "customerOrderCutoff": "2026-10-08T16:00:00-04:00",
            "customerOrderCutoffUTC": "2026-10-08T20:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 4,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": "warehouse-east",
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "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.

Request date override

requestDateOverride

Dictate the base calculation of when the request happened. This field allows you to specify the request as though it had happened on a different date and/or time.

Example cURL call

curl --request POST   
  --url API_URL/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": "cart-2026-10-08-4472",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "requestDateOverride": "2026-10-05T14:30:00Z",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "originId": "warehouse-east"
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "shipiumCartId": "b8e14d29-370c-4f65-9a02-cd7513e8f461",
    "partnerCartId": "cart-2026-10-08-4472",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "requestDateOverride": "2026-10-05T14:30:00Z",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "27a6c4f1-9b08-4de3-85c7-1f0a62d3948e",
            "shipEstimateDate": "2026-10-06T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-06T20:00:00Z",
            "deliveryEstimateDate": "2026-10-10T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-11T03:00:00Z",
            "customerOrderCutoff": "2026-10-05T16:00:00-04:00",
            "customerOrderCutoffUTC": "2026-10-05T20:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 4,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": "warehouse-east",
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Shipping origin override

shippingOrigin

Dictate the origin that will fulfill the shipment by using the originId. You can retrieve the originId value from the Shipium platform, following these steps (your Implementation team member will assist you):

Access your organization's account by logging in to the Shipium Console.
Navigate to Configure in the lefthand menu, and then select Fulfillment Configuration.

Within Fulfillment Center Configuration, select Origins.

From your list of origins, locate the one for which you wish to retrieve the originId. Then choose Detail from the Actions dropdown menu for that origin.
Copy the value listed for the Origin ID in the detailed card view. This is your originId value.

Example cURL call

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

Example request body by origin ID

{
  "partnerCartId": "cart-2026-10-08-4473",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "originId": "warehouse-west"
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response by origin ID

{
    "shipiumCartId": "3f92a7d0-61be-4c38-8571-0ea94b2f6cd5",
    "partnerCartId": "cart-2026-10-08-4473",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "8e5b0192-ad47-4f63-bb20-59c7e4a1830f",
            "shipEstimateDate": "2026-10-09T08:00:00-07:00",
            "shipEstimateDateUTC": "2026-10-09T15:00:00Z",
            "deliveryEstimateDate": "2026-10-11T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-12T03:00:00Z",
            "customerOrderCutoff": "2026-10-08T14:00:00-07:00",
            "customerOrderCutoffUTC": "2026-10-08T21:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 2,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "89501",
                "shipiumOriginId": "7f3ac081-5d2e-4b96-9c14-2a80e5f6d13b",
                "originId": "warehouse-west",
                "partnerOriginId": "warehouse-west",
                "originProcessingDays": 0.5
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "89501",
                "originId": "7f3ac081-5d2e-4b96-9c14-2a80e5f6d13b",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Supplying a ship-from location that is not a configured origin

You can request an estimate for a ship-from location that is not one of your configured origins by supplying fromCountryCode and fromPostalCode on a shipping location option. Shipium compares the pair against your configured origins as an exact match on both values. There is no partial or prefix matching.

When the pair matches none of your configured origins, you must also supply shipDateOverride. Without it, the request is rejected. A top-level shipDateOverride applies to every shipping location option in the request, so one value satisfies the requirement for all of them.

On this path, a shipDateOverride given as a date with no time resolves to a platform default cutoff time in the time zone of the ship-from location you supplied. When the pair does match a configured origin, it resolves to that origin's own configured cutoff instead.

That option's shippingOrigin returns the countryCode and postalCode you supplied. No value is returned for shipiumOriginId, originId, partnerOriginId, or originProcessingDays, because no configured origin was used.

How errors across multiple shipping location options are returned

Each shipping location option is evaluated independently, but a failure in any one of them fails the whole request. The response returns the first failure's status and message, and no estimates are returned for the options that succeeded. The message does not identify which option failed.

Ship date override

shipDateOverride

Dictate the date that the origin will ship the item.

Example cURL call

curl --request POST   
  --url API_URL/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": "cart-2026-10-08-4474",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "shipDateOverride": "2026-10-20",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "shipOption": "Standard",
        "fromCountryCode": "US",
        "fromPostalCode": "43068"
      },
      {
        "shipOption": "Standard",
        "originId": "warehouse-west"
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "shipiumCartId": "d47c10b8-5e93-4a27-91f0-3b6d825ace14",
    "partnerCartId": "cart-2026-10-08-4474",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shipDateOverride": "2026-10-20",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "4a2e8b57-c103-49df-a6b8-71e05f39d2c6",
            "shipEstimateDate": "2026-10-20T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-20T20:00:00Z",
            "deliveryEstimateDate": "2026-10-24T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-25T03:00:00Z",
            "customerOrderCutoff": null,
            "customerOrderCutoffUTC": null,
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 4,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": null,
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        },
        {
            "deliveryEstimateId": "b60f3c94-812a-4d75-8ef3-0c497a2be5d1",
            "shipEstimateDate": "2026-10-20T14:00:00-07:00",
            "shipEstimateDateUTC": "2026-10-20T21:00:00Z",
            "deliveryEstimateDate": "2026-10-22T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-23T03:00:00Z",
            "customerOrderCutoff": null,
            "customerOrderCutoffUTC": null,
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 2,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "89501",
                "shipiumOriginId": "7f3ac081-5d2e-4b96-9c14-2a80e5f6d13b",
                "originId": "warehouse-west",
                "partnerOriginId": "warehouse-west",
                "originProcessingDays": 0.5
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "89501",
                "originId": "7f3ac081-5d2e-4b96-9c14-2a80e5f6d13b",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Ship option override

shipOption

Retrieve the estimate for a different ship option.

Available ship options for the API call request:

Standard
SameDay
NextDay
TwoDay
ThreeDay

Example cURL call

curl --request POST   
  --url API_URL/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": "cart-2026-10-08-4475",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "shipOption": "TwoDay",
        "fromCountryCode": "US",
        "fromPostalCode": "43068"
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "shipiumCartId": "9b5e2a06-f318-4c74-ad91-6e820fc35741",
    "partnerCartId": "cart-2026-10-08-4475",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "f1c84760-25db-4e09-9a3f-7d6021be4c38",
            "shipEstimateDate": "2026-10-09T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-09T20:00:00Z",
            "deliveryEstimateDate": "2026-10-11T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-12T03:00:00Z",
            "customerOrderCutoff": "2026-10-08T16:00:00-04:00",
            "customerOrderCutoffUTC": "2026-10-08T20:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 2,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": null,
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "TwoDay",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Weekend and holiday delivery overrides

Use the deliveryBehaviorOverrides object to override your account-level weekend and holiday settings on a per-request basis. Overrides apply to the specific shipOption in the same shippingLocationOptions object, allowing granular control. Because the Cart Checkout API accepts multiple shipping location options, you can specify different overrides for different ship options within a single request — for example, enabling Saturday delivery for next-day shipping while using account defaults for standard shipping.

Example cURL call

curl --request POST   
  --url API_URL/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": "cart-2026-10-08-4476",
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "shipOption": "Standard",
        "fromCountryCode": "US",
        "fromPostalCode": "43068",
        "deliveryBehaviorOverrides": {
          "saturdayDeliveryBehavior": "ALLOW",
          "sundayDeliveryBehavior": "ALLOW"
        }
      },
      {
        "shipOption": "Standard",
        "fromCountryCode": "US",
        "fromPostalCode": "43068",
        "deliveryBehaviorOverrides": {
          "saturdayDeliveryBehavior": "NON_TRANSIT_NON_DELIVERY_DAY",
          "sundayDeliveryBehavior": "NON_TRANSIT_NON_DELIVERY_DAY"
        }
      }
    ]
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "shipiumCartId": "7e03b9f2-4a68-41cd-95e7-b28051d6ac39",
    "partnerCartId": "cart-2026-10-08-4476",
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "originDeliveryEstimates": [
        {
            "deliveryEstimateId": "3c19d840-6be5-472f-a0d3-84e6120f7b95",
            "shipEstimateDate": "2026-10-09T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-09T20:00:00Z",
            "deliveryEstimateDate": "2026-10-13T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-14T03:00:00Z",
            "customerOrderCutoff": "2026-10-08T16:00:00-04:00",
            "customerOrderCutoffUTC": "2026-10-08T20:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 4,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": null,
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        },
        {
            "deliveryEstimateId": "aa74e5b3-1082-4d69-bf37-5029c6e81a4d",
            "shipEstimateDate": "2026-10-09T16:00:00-04:00",
            "shipEstimateDateUTC": "2026-10-09T20:00:00Z",
            "deliveryEstimateDate": "2026-10-15T20:00:00-07:00",
            "deliveryEstimateDateUTC": "2026-10-16T03:00:00Z",
            "customerOrderCutoff": "2026-10-08T16:00:00-04:00",
            "customerOrderCutoffUTC": "2026-10-08T20:00:00Z",
            "estimateSource": "ShipiumCalculated",
            "estimatedTimeInTransitDays": 6,
            "shippingOrigin": {
                "countryCode": "US",
                "postalCode": "43068",
                "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "originId": null,
                "partnerOriginId": "warehouse-east",
                "originProcessingDays": 1.0
            },
            "shippingOptions": {
                "shipOption": "Standard",
                "fromCountryCode": "US",
                "fromPostalCode": "43068",
                "originId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
                "estimateSource": "ShipiumCalculated"
            }
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

Get started

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

Authentication for API Calls

Request and response fields for API calls

Required request fields

Conditional request fields

Optional request fields

Weekend and holiday delivery behavior values

Response attributes

The shippingOptions object in the response

Identifying origins on a cart request

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

Example cURL call

Example request body

Example response

Augmentations to the EDD request (additional use cases)

Request date override

Example cURL call

Example request body

Example response

Shipping origin override

Example cURL call

Example request body by origin ID

Example response by origin ID

Supplying a ship-from location that is not a configured origin

How errors across multiple shipping location options are returned

Ship date override

Example cURL call

Example request body

Example response

Ship option override

Example cURL call

Example request body

Example response

Weekend and holiday delivery overrides

Example cURL call

Example request body

Example response

Resources

The `shippingOptions` object in the response