---
title: "Cart Delivery Date Estimate"
method: POST
path: "/api/v1/deliveryexperience/cartDeliveryEstimate"
tags: ["delivery-experience"]
---

# Cart Delivery Date Estimate

`POST /api/v1/deliveryexperience/cartDeliveryEstimate`

Calculate the Estimated Delivery Date for a cart with multiple origins with inventory

## Headers

- `X-DELEGATED-PARTNER-ID` string

## Request body

- CartDeliveryEstimateRequest — Information used to generate delivery estimate.
  - `partnerCartId` string, required — A unique identifier for this cart from the partner system
  - `customerCountryCode` string, required — The ISO 3166-1 country code (alpha-2) for the customer shipping address.
  - `customerPostalCode` string, required — A customerCountryCode-appropriate postal code for the customer shipping address.
  - `requestDateOverride` string, date-time — Overrides the requestDate to a specific date & time which the delivery estimate is calculated from. ISO 8601 format
  - `shipDateOverride` string — The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. Overrides the shipEstimateDate to a specific date & time. Requires dateTime to be in the future (or after requestDateTime if it is specified).
  - `productViewDeliveryEstimateIds` string[] — List of product view delivery estimate IDs to include in the cart calculation
  - `cartShippingOptions` CartShippingOptions, required — Shipping information used as part of the DeliveryExperience Cart APIs
    - `shippingLocationOptions` ShippingOptions[], required — List of possible shipping location options with available inventory
      - `shipOption` 'NotProvided' | 'Standard' | 'StandardPlus' | 'SameDay' | 'NextDay' | 'Overnight' | 'PriorityOvernight' | 'TwoDay' | 'TwoDayMorning' | 'ThreeDay' | 'International24Hour' | 'InternationalOneToThreeDayEarly' | 'InternationalOneToThreeDay' | 'InternationalTwoToFiveDay' | 'InternationalTwoToTenDay' | 'InternationalOneToTwoWeek' | 'InternationalOneToFourWeek' | 'DesiredDeliveryDate' | 'BusinessDaysOfTransit' | 'Unknown' — A high-level shipping option shown to or selected by a customer.
      - `fromCountryCode` string — The ISO 3166-1 country code (alpha-2) from where the package is shipping from. Exclusive with originId.
      - `fromPostalCode` string — A country-appropriate postal code for the country defined in fromCountry. Exclusive with originId.
      - `originId` string — The provided identifier of the origin or the shipium originId. This is exclusive with fromCountryCode and fromPostalCode.
      - `estimateSource` 'PartnerProvided' | 'ShipiumCalculated' | 'CarrierProvided' | 'Unknown' — The source (ShipiumGenerated, PartnerProvided, or CarrierDefault) used to generate the estimate.
      - `deliveryBehaviorOverrides` DeliveryBehaviorOverrides — Optional overrides for weekend and holiday delivery behavior. When provided, these override partner-level configuration for the request.
        - `saturdayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for Saturday delivery behavior. When provided, overrides partner-level configuration for Saturday deliveries.
        - `sundayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for Sunday delivery behavior. When provided, overrides partner-level configuration for Sunday deliveries.
        - `holidayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for holiday delivery behavior. When provided, overrides partner-level configuration for holiday deliveries.
      - `timeInTransitSetting` string — Optional per-request override for time-in-transit aggressiveness. Overrides the account-level default for this request. One of: aggressive, standard, conservative, very_conservative. Values are case-sensitive.
  - `referenceIdentifiers` ReferenceIdentifier[] — Optional reference identifiers for tracking and correlation
    - `name` string
    - `value` string
  - `partnerReferenceIdentifier` string — Reference external identifier explicitly provided by the partner. Used for reporting purposes.
  - `partnerReferenceIdentifier2` string — Second reference external identifier explicitly provided by the partner. Used for reporting purposes.
  - `shipmentTags` string[] — Free-form list of shipment tags for the cart. Used for downstream reporting. Matches the shipmentTags field on the corresponding Carrier Selection API request.

## Response `200`

Cart Delivery Estimates provided.

- CartDeliveryEstimateResponse
  - `shipiumCartId` string, required — Unique identifier for this cart generated by Shipium
  - `partnerCartId` string, required — Unique identifier for this cart from the partner system
  - `customerCountryCode` string, required — The ISO 3166-1 country code (alpha-2) for the customer shipping address.
  - `customerPostalCode` string, required — A customerCountryCode-appropriate postal code for the customer shipping address.
  - `requestDateOverride` string, date-time — Overrides the requestDate to a specific date & time which the delivery estimate is calculated from. ISO 8601 format
  - `shipDateOverride` string — The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. Overrides the shipEstimateDate to a specific date & time.
  - `productViewDeliveryEstimateIds` string[] — List of product view delivery estimate IDs included in the cart calculation
  - `originDeliveryEstimates` CartOriginDeliveryEstimate[], required — List of origin delivery estimates
    - `deliveryEstimateId` string, required — The string used to identify this delivery experience.
    - `shipEstimateDate` string, date-time, required — A valid date in ISO 8601 format representing the estimated ship date to a customer configured in the call parameters for a given partner.
    - `shipEstimateDateUTC` string, date-time, required — A valid date in ISO 8601 format with UTC timezone representing the estimated ship date to a customer configured in the call parameters for a given partner.
    - `deliveryEstimateDate` string, date-time, required — A valid date in ISO 8601 format representing the estimated delivery date to a customer configured in the call parameters for a given partner.
    - `deliveryEstimateDateUTC` string, date-time, required — A valid date in ISO 8601 format with UTC timezone representing the estimated delivery date to a customer configured in the call parameters for a given partner.
    - `customerOrderCutoff` string, date-time — A valid date in ISO 8601 format representing the latest (non-inclusive) moment a customer can place an order and still ship on shipEstimateDate. Null when not computable.
    - `customerOrderCutoffUTC` string, date-time — A valid date in ISO 8601 format with UTC timezone representing the latest (non-inclusive) moment a customer can place an order and still ship on shipEstimateDate. Null when not computable.
    - `estimateSource` 'PartnerProvided' | 'ShipiumCalculated' | 'CarrierProvided' | 'Unknown', required — The source (ShipiumGenerated, PartnerProvided, or CarrierDefault) used to generate the estimate.
    - `estimatedTimeInTransitDays` integer, required — The number of days between shipEstimateDate and deliveryEstimateDate.
    - `shippingOrigin` ShippingOrigin, required — The predicted origin that the package is shipping from.
      - `countryCode` string — The ISO 3166-1 country code (alpha-2) representing where the package is shipping from.
      - `postalCode` string — A country-appropriate postal code representing where the package is shipping from.
      - `shipiumOriginId` string — The string used to identify the shipium originId.
      - `originId` string — The originId provided on the request. Null if no originId was provided.
      - `partnerOriginId` string — The partner-provided identifier (origin name) of the selected origin.
      - `originProcessingDays` number, double — The number of processing days configured for the given origin.
    - `shippingOptions` ShippingOptions, required — Optional shipping information used as part of the Delivery Experience APIs.
      - `shipOption` 'NotProvided' | 'Standard' | 'StandardPlus' | 'SameDay' | 'NextDay' | 'Overnight' | 'PriorityOvernight' | 'TwoDay' | 'TwoDayMorning' | 'ThreeDay' | 'International24Hour' | 'InternationalOneToThreeDayEarly' | 'InternationalOneToThreeDay' | 'InternationalTwoToFiveDay' | 'InternationalTwoToTenDay' | 'InternationalOneToTwoWeek' | 'InternationalOneToFourWeek' | 'DesiredDeliveryDate' | 'BusinessDaysOfTransit' | 'Unknown' — A high-level shipping option shown to or selected by a customer.
      - `fromCountryCode` string — The ISO 3166-1 country code (alpha-2) from where the package is shipping from. Exclusive with originId.
      - `fromPostalCode` string — A country-appropriate postal code for the country defined in fromCountry. Exclusive with originId.
      - `originId` string — The provided identifier of the origin or the shipium originId. This is exclusive with fromCountryCode and fromPostalCode.
      - `estimateSource` 'PartnerProvided' | 'ShipiumCalculated' | 'CarrierProvided' | 'Unknown' — The source (ShipiumGenerated, PartnerProvided, or CarrierDefault) used to generate the estimate.
      - `deliveryBehaviorOverrides` DeliveryBehaviorOverrides — Optional overrides for weekend and holiday delivery behavior. When provided, these override partner-level configuration for the request.
        - `saturdayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for Saturday delivery behavior. When provided, overrides partner-level configuration for Saturday deliveries.
        - `sundayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for Sunday delivery behavior. When provided, overrides partner-level configuration for Sunday deliveries.
        - `holidayDeliveryBehavior` 'ALLOW' | 'NON_DELIVERY_DAY' | 'NON_TRANSIT_NON_DELIVERY_DAY' — Override for holiday delivery behavior. When provided, overrides partner-level configuration for holiday deliveries.
      - `timeInTransitSetting` string — Optional per-request override for time-in-transit aggressiveness. Overrides the account-level default for this request. One of: aggressive, standard, conservative, very_conservative. Values are case-sensitive.
  - `referenceIdentifiers` ReferenceIdentifier[] — Reference identifiers for tracking and correlation
    - `name` string
    - `value` string
  - `partnerReferenceIdentifier` string — Reference external identifier explicitly provided by the partner.
  - `partnerReferenceIdentifier2` string — Second reference external identifier explicitly provided by the partner.
  - `shipmentTags` string[] — Shipment tags echoed back from the request. Matches the shipmentTags field on the corresponding Carrier Selection API request and is used for downstream reporting.

## Other responses

- `400` — Invalid inputs were provided.
- `403` — Not authenticated / authorized via OAuth.
- `500` — No Cart Delivery Estimates available.

---

[API](https://skmtc.net/shipium/apis/shipium-api.md) · [All operations](https://skmtc.net/shipium/apis/shipium-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipium/shipium-api/versions/7ef5dbd6a025/schema)