Product View Delivery Estimate

URL Expired

The URL for this request expired after 30 days.

Information used to generate delivery estimate.

• customerCountryCode\n - string\n - required\n - The ISO 3166-1 country code (alpha-2) for the customer shipping address.

• customerPostalCode\n - string\n - required\n - A customerCountryCode-appropriate postal code for the customer shipping address.

• requestDateOverride\n - date-time\n - Overrides the requestDate to a specific date & time which the delivery estimate is calculated from. ISO 8601 format

• shipDateOverride\n - string\n - 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 given).

• referenceIdentifiers\n - array of objects\n - Reference external identifiers that are used for reporting purposes.

• referenceIdentifiers\n - ADD object

  • partnerReferenceIdentifier\n - string\n - Reference external identifier explicitly provided by the partner. Used for reporting purposes.
  • partnerReferenceIdentifier2\n - string\n - Second reference external identifier explicitly provided by the partner. Used for reporting purposes.

• shipmentTags\n - array of strings\n - Free-form list of shipment tags for this product view. Used for downstream reporting. Matches the shipmentTags field on the corresponding Carrier Selection API request.

• shipmentTags\n - ADD string

  • X-DELEGATED-PARTNER-ID\n - string\n - X-DELEGATED-USER-ID\n - string

Response Codes

• 200 Delivery Estimate provided.
• 204 No Delivery Estimate available.
• 400 Invalid inputs were provided.
• 403 Not authenticated / authorized via OAuth.

curl example

curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/productview \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

API Response Codes

• 200 - Successful response
• 400 - Bad request response
• 403 - Unauthorized response