Get started

To use the Product View 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 product detail pages with the Product View Delivery Promise API

The Shipium Product View 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 Product View 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 Product View Delivery Promise API. You can find additional support in the Product View Delivery Estimate API Reference.

Required request fields

Conditional request fields

Optional request fields

Response attributes

The Product View Delivery Promise response attributes are defined in the following table.

Shipium assumptions for the Product View 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 product view (primary use case)

Example cURL call

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

Example request body

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "deliveryEstimateId": "da2959d6-248f-4dac-a557-c6b06a3f826f",
    "requestDate": "2024-08-20T18:52:06.357Z",
    "shipEstimateDate": "2024-08-22T17:00:00-04:00",
    "shipEstimateDateUTC": "2024-08-22T21:00:00Z",
    "deliveryEstimateDate": "2024-08-30T20:00:00-07:00",
    "deliveryEstimateDateUTC": "2024-08-31T03:00:00Z",
    "estimateSource": "ShipiumCalculated",
    "estimatedTimeInTransitDays": 8,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824"
  },
    "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 request body

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "requestDateOverride": "2024-08-19T18:52:06.357Z",
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

Shipping origin override

shippingOrigin
Dictate the origin that will fulfill the shipment by using the originID.

Example request body by origin ID

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "options": {
        "shippingOptions": {
            "originId": "194d28d5-53b3-4c80-badc-0793ba220932"
        }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response by origin ID

Ship date override

shipDateOverride
Dictate the date that the origin will ship the item.

Example request body

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "shipDateOverride": "2024-08-19T18:52:06.357Z",
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

Ship option override

shipOption
Retrieve the estimate for a different ship option.

Example request body

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "options": {
        "shippingOptions": {
            "shipOption": "TwoDay"
        }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

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 request, allowing granular control.

Example request body

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "options": {
    "shippingOptions": {
      "shipOption": "NextDay",
      "deliveryBehaviorOverrides": {
        "saturdayDeliveryBehavior": "ALLOW",
        "sundayDeliveryBehavior": "NON_TRANSIT_NON_DELIVERY_DAY"
      }
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
  "deliveryEstimateId": "da2959d6-248f-4dac-a557-c6b06a3f826f",
  "requestDate": "2024-08-20T18:52:06.357Z",
  "shipEstimateDate": "2024-08-22T17:00:00-04:00",
  "shipEstimateDateUTC": "2024-08-22T21:00:00Z",
  "deliveryEstimateDate": "2024-08-24T20:00:00-07:00",
  "deliveryEstimateDateUTC": "2024-08-25T03:00:00Z",
  "estimateSource": "ShipiumCalculated",
  "estimatedTimeInTransitDays": 2,
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "shippingOrigin": {
    "countryCode": "US",
    "postalCode": "43068",
    "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824"
  },
  "options": {
    "shippingOptions": {
      "shipOption": "NextDay",
      "deliveryBehaviorOverrides": {
        "saturdayDeliveryBehavior": "ALLOW",
        "sundayDeliveryBehavior": "NON_TRANSIT_NON_DELIVERY_DAY"
      }
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}