Estimate Delivery Date

Forecast an expected delivery date and time based on delivery estimation settings and the selected shipping carrier method. Provide information on when a package is expected to be shipped and delivered.

Resource

1/commerce/delivery/estimation-setup/externalReference/estimate/estimate-date

Available version

63.0

HTTP methods

POST

Request body for POST

Estimate Delivery Date Input

Root XML tag

estimateDeliveryDateInput

JSON example

1{
2  "shippingCarrier": {
3    "externalReference": "UPS001",
4    "shippingCarrierMethods": [
5      {
6        "externalReference": "UPSGround001"
7      },
8      {
9        "externalReference": "UPSAIR001"
10      }
11    ]
12  },
13  "locations": [
14    "California"
15  ],
16  "products": [
17    {
18      "stockKeepingUnit": "SKU01",
19      "quantity": 5
20    }
21  ],
22  "deliveryAddress": {
23    "country": "USA",
24    "state": "CA",
25    "city": "San Francisco",
26    "postalCode": "00000",
27    "latitude": 30.123,
28    "longitude": 100.123
29  }
30}

Properties

Property	Type	Description	Required or Optional	Available Version
`deliveryAddress`	ConnectApi.DeliveryAddressInputRepresentation	Delivery address.	Optional	63.0
`locations`	String	List of location external references.	Optional	63.0
`products`	ConnectApi.DeliveryEstimationProductInputRepresentation	List of products included in delivery estimation.	Required	63.0
`shippingCarrier`	ConnectApi.ShippingCarrierInputRepresentation	Shipping carrier used to deliver the order.	Required	63.0

Response body for POST: Estimate Delivery Date

Connect REST API Developer Guide

Estimate Delivery Date