v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB

delivery-experience

Cart Delivery Date Estimate

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

post/api/v1/deliveryexperience/cartDeliveryEstimate

Headers

X-DELEGATED-PARTNER-IDstring

Request body

partnerCartIdstring required

A unique identifier for this cart from the partner system

customerCountryCodestring required

The ISO 3166-1 country code (alpha-2) for the customer shipping address.

customerPostalCodestring required

A customerCountryCode-appropriate postal code for the customer shipping address.

requestDateOverridestring date-time

Overrides the requestDate to a specific date & time which the delivery estimate is calculated from. ISO 8601 format

shipDateOverridestring

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).

productViewDeliveryEstimateIdsstring[]

List of product view delivery estimate IDs to include in the cart calculation

partnerReferenceIdentifierstring

Reference external identifier explicitly provided by the partner. Used for reporting purposes.

partnerReferenceIdentifier2string

Second reference external identifier explicitly provided by the partner. Used for reporting purposes.

shipmentTagsstring[]

Free-form list of shipment tags for the cart. Used for downstream reporting. Matches the shipmentTags field on the corresponding Carrier Selection API request.

Example request

{
  "customerCountryCode": "US",
  "customerPostalCode": "\"98101\"",
  "requestDateOverride": "2019-10-31T00:00:00Z",
  "shipDateOverride": "2019-10-31T00:00:00.000000Z",
  "cartShippingOptions": {
    "shippingLocationOptions": [
      {
        "shipOption": "Standard",
        "fromCountryCode": "US",
        "fromPostalCode": "\"98101\"",
        "originId": "\"origin-id-123\"",
        "estimateSource": "ShipiumGenerated",
        "timeInTransitSetting": "aggressive"
      }
    ]
  }
}

Response

Cart Delivery Estimates provided.

shipiumCartIdstring required

Unique identifier for this cart generated by Shipium

partnerCartIdstring required

Unique identifier for this cart from the partner system

customerCountryCodestring required

The ISO 3166-1 country code (alpha-2) for the customer shipping address.

customerPostalCodestring required

A customerCountryCode-appropriate postal code for the customer shipping address.

requestDateOverridestring date-time

Overrides the requestDate to a specific date & time which the delivery estimate is calculated from. ISO 8601 format

shipDateOverridestring

The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. Overrides the shipEstimateDate to a specific date & time.

productViewDeliveryEstimateIdsstring[]

List of product view delivery estimate IDs included in the cart calculation

partnerReferenceIdentifierstring

Reference external identifier explicitly provided by the partner.

partnerReferenceIdentifier2string

Second reference external identifier explicitly provided by the partner.

shipmentTagsstring[]

Shipment tags echoed back from the request. Matches the shipmentTags field on the corresponding Carrier Selection API request and is used for downstream reporting.

Example response

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "requestDateOverride": "2019-10-31T00:00:00Z",
  "shipDateOverride": "2019-10-31T00:00:00.000000Z",
  "originDeliveryEstimates": [
    {
      "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
      "shipEstimateDate": "2019-10-31T00:00:00Z",
      "shipEstimateDateUTC": "2019-10-31T00:00:00Z",
      "deliveryEstimateDate": "2019-10-31T00:00:00Z",
      "deliveryEstimateDateUTC": "2019-10-31T00:00:00Z",
      "customerOrderCutoff": "2019-10-31T15:00:00-07:00",
      "customerOrderCutoffUTC": "2019-10-31T22:00:00Z",
      "estimateSource": "ShipiumGenerated",
      "estimatedTimeInTransitDays": 3,
      "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "98101",
        "shipiumOriginId": "0b3d140a-525b-43a7-896c-cdc381580d62",
        "originId": "warehouse-west",
        "partnerOriginId": "warehouse-west",
        "originProcessingDays": 2.5
      },
      "shippingOptions": {
        "shipOption": "Standard",
        "fromCountryCode": "US",
        "fromPostalCode": "\"98101\"",
        "originId": "\"origin-id-123\"",
        "estimateSource": "ShipiumGenerated",
        "timeInTransitSetting": "aggressive"
      }
    }
  ]
}