v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB

delivery-experience

Get Delivery Estimate

Get a delivery estimate created from a product view.

Warning: this endpoint doesn't guarantee that the deliveryEstimateId can always be found immediately after being created from POST /productview.

get/api/v1/deliveryexperience/productview/{deliveryEstimateId}

Path parameters

deliveryEstimateIdstring required

The delivery estimate id provided from the productview action.

Headers

X-DELEGATED-PARTNER-IDstring

Response

Delivery Estimate retrieved.

deliveryEstimateIdstring required

The string used to identify this delivery experience.

requestDatestring date-time required

A valid date in ISO 8601 format representing the start date that estimates were derived from

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

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

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

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

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

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

estimatedTimeInTransitDaysinteger required

The number of days between shipEstimateDate and deliveryEstimateDate.

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 date-time

Overrides the shipEstimateDate to a specific date & time. Requires dateTime to be in the future (or after requestDateTime if it is specified). ISO 8601 format

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

{
  "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
  "requestDate": "2019-10-31T00:00:00Z",
  "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,
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "shippingOrigin": {
    "countryCode": "US",
    "postalCode": "98101",
    "shipiumOriginId": "0b3d140a-525b-43a7-896c-cdc381580d62",
    "originId": "warehouse-west",
    "partnerOriginId": "warehouse-west",
    "originProcessingDays": 2.5
  },
  "requestDateOverride": "2019-10-31T00:00:00Z",
  "shipDateOverride": "2019-10-31T00:00:00Z"
}