Guides

Product View Delivery Promise API

Retrieve estimated delivery dates for product detail pages with Shipium's Product View Delivery Promise API.

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.

API typeAPI endpoint
POSThttps://api.shipium.com/api/v1/deliveryexperience/productview
🔐

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

Required request fields

Request fieldDetails
customerCountryCodeType: String (enumeration)
Format: Limited to 2 characters and ISO 3166 standards
Description: Shipment's destination country
customerPostalCodeType: String
Format: A customerCountryCode-appropriate postal code. See non-US address formats.
Description: Shipment's destination postal code

Conditional request fields

Request fieldDetails
shipDateOverrideType: 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.

Optional request fields

When you supply neither the fromCountryCode and fromPostalCode pair nor originId, Shipium selects an origin for you. See How Shipium Selects an Origin.

Request fieldDetails
requestDateOverrideType: 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.
options.shippingOptions .shipOptionType: String (enumeration)
Values: Standard, SameDay, NextDay, TwoDay, ThreeDay
Description: Retrieve the estimate for a different ship option; the default value is Standard.
options.shippingOptions .estimateSourceType: 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.
options.shippingOptions .deliveryBehaviorOverridesType: Object
Description: Override your organization's account-level weekend and holiday delivery behavior for this request. These overrides apply to the shipOption specified in the same shippingOptions object. 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.
options.shippingOptions .deliveryBehaviorOverrides .saturdayDeliveryBehaviorType: 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.
options.shippingOptions .deliveryBehaviorOverrides .sundayDeliveryBehaviorType: 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 .
options.shippingOptions .deliveryBehaviorOverrides .holidayDeliveryBehaviorType: 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 .
options.shippingOptions
.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.
partnerReferenceIdentifierType: String
Description: An optional identifier your organization provides, used for reporting and cross-product correlation across Shipium APIs. This value is stored and returned in the response. Pass the same value in your Cart Checkout and downstream Carrier Selection calls to correlate this order across the full API chain. This value is not passed to carriers. See Link API Calls Across Shipium Products for the full cross-product linking guide.
referenceIdentifiersType: Array of objects
Description: Name and value pairs your organization supplies for reporting and internal tracking; returned in the response
referenceIdentifiers.nameType: String
Description: Your organization's identifier to associate with this request
referenceIdentifiers.valueType: String
Description: The value associated with the specified name
partnerReferenceIdentifier2Type: 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.
shipmentTagsType: Array of strings
Description: A free-form list of shipment tags for this product view, 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.
options.shippingOptions.fromCountryCodeType: String
Format: Limited to 2 characters and ISO 3166 standards
Description: The country the shipment ships from. Supply together with fromPostalCode; cannot be supplied in the same request as originId.
options.shippingOptions.fromPostalCodeType: String
Description: The origin-country-appropriate postal code the shipment ships from. Supply together with fromCountryCode; cannot be supplied in the same request as originId.
options.shippingOptions.originIdType: String
Example: origin-id-123
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 request as fromCountryCode or fromPostalCode
🗓️

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 Product View Delivery Promise response attributes are defined in the following table.

Response attributeDescription
deliveryEstimateIdUnique Shipium-generated ID related to the response
requestDateA valid date-time in ISO 8601 format representing the point in time from which the estimate was calculated
shipEstimateDateA valid date in ISO 8601 format representing the estimated ship date to a customer configured in the call parameters (e.g., 2023-10-31T00:00:00Z)
shipEstimateDateUTCA valid date in ISO 8601 format with UTC timezone representing the estimated ship date to a customer configured in the call parameters (e.g., 2023-10-31T00:00:00Z)
deliveryEstimateDateShipium's estimated delivery date (EDD) in the local timezone of the delivery postal code (customerPostalCode)
deliveryEstimateDateUTCA valid date in ISO 8601 format with UTC timezone representing the estimated delivery date to a customer configured in the call parameters (e.g., 2023-10-31T00:00:00Z)
customerOrderCutoffThe latest moment an order can be placed and still ship on 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.
customerOrderCutoffUTCThe same value as customerOrderCutoff, expressed in UTC; the two attributes are always populated together and are null together.
estimateSourceThe time in transit (TNT) calculation method that was used when calculating this EDD; one of ShipiumCalculated, PartnerProvided, CarrierProvided, or Unknown
estimatedTimeInTransitDaysAn integer value of the time in transit (TNT) in days
shippingOriginThe origin used for this estimate, whether selected by Shipium or specified in the request
shippingOrigin.countryCodeThe origin's country, limited to 2 characters and ISO 3166 standards
shippingOrigin.postalCodeThe origin's country-appropriate postal code
shippingOrigin.shipiumOriginIdShipium's unique identifier for the origin
shippingOrigin.originIdThe value you supplied in options.shippingOptions.originId, 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.
shippingOrigin.partnerOriginIdThe identifier your organization assigned to the origin used for this estimate; no value is returned when no identifier has been assigned to that origin.
shippingOrigin.originProcessingDaysThe 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.

How Shipium selects an origin

When you do not identify an origin on the request, Shipium evaluates origins near your customer and selects the one that produces the earliest estimated delivery date. Distance is used only to break a tie between origins that would deliver on the same date, so the origin selected is not always the closest one.

To choose the origin yourself, supply either originId or the fromCountryCode and fromPostalCode pair.

Retrieve an EDD for a shipment at product view (primary use case)

Example cURL call

curl --request POST   
  --url API_URL/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": "2026-10-08T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": null,
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "Standard"
        }
    },
    "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/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",
  "requestDateOverride": "2026-10-05T14:30:00Z",
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "deliveryEstimateId": "1f0c9a47-3d52-4e88-9b21-5c7e04a1f9d3",
    "requestDate": "2026-10-05T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": "2026-10-05T14:30:00Z",
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "Standard"
        }
    },
    "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):

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

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

  2. 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/productview 
  --header 'accept: application/json' 
  --header $AUTHSTRING  
  --header 'content-type: application/json'  
  --data 'INSERT REQUEST BODY FROM BELOW'

Example request body by origin ID

{
  "customerCountryCode": "US",
  "customerPostalCode": "98101",
  "options": {
    "shippingOptions": {
      "originId": "warehouse-west"
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response by origin ID

{
    "deliveryEstimateId": "6b48e2c0-91af-4d37-bc05-e3f7a2d84610",
    "requestDate": "2026-10-08T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "89501",
        "shipiumOriginId": "7f3ac081-5d2e-4b96-9c14-2a80e5f6d13b",
        "originId": "warehouse-west",
        "partnerOriginId": "warehouse-west",
        "originProcessingDays": 0.5
    },
    "requestDateOverride": null,
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "Standard",
            "originId": "warehouse-west"
        }
    },
    "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. 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.

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.

The response'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.

Example cURL call

curl --request POST   
  --url API_URL/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",
  "shipDateOverride": "2026-10-20",
  "options": {
    "shippingOptions": {
      "fromCountryCode": "US",
      "fromPostalCode": "33101"
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response body

{
    "deliveryEstimateId": "5d1e74bc-0a39-4c85-b2f1-6e93807ad214",
    "requestDate": "2026-10-08T14:30:00Z",
    "shipEstimateDate": "2026-10-20T17:00:00-04:00",
    "shipEstimateDateUTC": "2026-10-20T21:00:00Z",
    "deliveryEstimateDate": "2026-10-25T20:00:00-07:00",
    "deliveryEstimateDateUTC": "2026-10-26T03:00:00Z",
    "customerOrderCutoff": null,
    "customerOrderCutoffUTC": null,
    "estimateSource": "ShipiumCalculated",
    "estimatedTimeInTransitDays": 5,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "33101",
        "shipiumOriginId": null,
        "originId": null,
        "partnerOriginId": null,
        "originProcessingDays": null
    },
    "requestDateOverride": null,
    "shipDateOverride": "2026-10-20T21:00:00Z",
    "options": {
        "shippingOptions": {
            "shipOption": "Standard",
            "fromCountryCode": "US",
            "fromPostalCode": "33101"
        }
    },
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

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/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",
  "shipDateOverride": "2026-10-20",
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "deliveryEstimateId": "a70d6b19-cc84-4f52-8e63-19b5c0d73f28",
    "requestDate": "2026-10-08T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": null,
    "shipDateOverride": "2026-10-20T20:00:00Z",
    "options": {
        "shippingOptions": {
            "shipOption": "Standard"
        }
    },
    "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/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",
  "options": {
    "shippingOptions": {
      "shipOption": "TwoDay"
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "deliveryEstimateId": "c35f8a62-7e10-4b49-ad86-204c9f1e7b55",
    "requestDate": "2026-10-08T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": null,
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "TwoDay"
        }
    },
    "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. The overrides apply to the shipOption in the same request. When provided, they take precedence over your account configuration.

Example cURL call

curl --request POST   
  --url API_URL/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",
  "options": {
    "shippingOptions": {
      "shipOption": "NextDay",
      "deliveryBehaviorOverrides": {
        "saturdayDeliveryBehavior": "NON_DELIVERY_DAY",
        "sundayDeliveryBehavior": "NON_DELIVERY_DAY"
      }
    }
  },
  "partnerReferenceIdentifier": "ORD-2026-12345"
}

Example response

{
    "deliveryEstimateId": "e92b4d07-58c3-4a16-9f72-8dbe105c3a47",
    "requestDate": "2026-10-08T14:30:00Z",
    "shipEstimateDate": "2026-10-09T16:00:00-04:00",
    "shipEstimateDateUTC": "2026-10-09T20:00:00Z",
    "deliveryEstimateDate": "2026-10-12T20:00:00-07:00",
    "deliveryEstimateDateUTC": "2026-10-13T03:00:00Z",
    "customerOrderCutoff": "2026-10-08T16:00:00-04:00",
    "customerOrderCutoffUTC": "2026-10-08T20:00:00Z",
    "estimateSource": "ShipiumCalculated",
    "estimatedTimeInTransitDays": 3,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": null,
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "NextDay",
            "deliveryBehaviorOverrides": {
               "saturdayDeliveryBehavior": "NON_DELIVERY_DAY",
               "sundayDeliveryBehavior": "NON_DELIVERY_DAY"
      }
        }
    },
    "partnerReferenceIdentifier": "ORD-2026-12345"
}

Reference identifiers and tags

Example cURL call

curl --request POST   
  --url API_URL/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",
  "partnerReferenceIdentifier2": "LINE-4",
  "referenceIdentifiers": [
    {
      "name": "order-instance-id",
      "value": "ORD-2026-12345-2026-10-08"
    }
  ],
  "shipmentTags": ["priority-fulfillment"]
}

Example response body

{
    "deliveryEstimateId": "9c07f3a8-42d6-4b71-8503-ae1f92d6b0c7",
    "requestDate": "2026-10-08T14:30:00Z",
    "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,
    "customerCountryCode": "US",
    "customerPostalCode": "98101",
    "shippingOrigin": {
        "countryCode": "US",
        "postalCode": "43068",
        "shipiumOriginId": "b1c9d24e-86f1-4bd6-b6dc-661a6f16e824",
        "originId": null,
        "partnerOriginId": "warehouse-east",
        "originProcessingDays": 1.0
    },
    "requestDateOverride": null,
    "shipDateOverride": null,
    "options": {
        "shippingOptions": {
            "shipOption": "Standard"
        }
    },
    "referenceIdentifiers": [
        {
            "name": "order-instance-id",
            "value": "ORD-2026-12345-2026-10-08"
        }
    ],
    "partnerReferenceIdentifier": "ORD-2026-12345",
    "partnerReferenceIdentifier2": "LINE-4",
    "shipmentTags": [
        "priority-fulfillment"
    ]
}

Resources

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

Updated about 1 month ago

Did this page help you?