DeliveryInformationDetails

Version 2024-04-01

Overview

Represents delivery information for certain items in an order. DeliveryInformationDetails in a pending state can divide into multiple DeliveryInformationDetails, each having its unique identifier.

Fields

Field Description

aliases ([Alias])

A list of aliases that are associated with the DeliveryInformationDetails. This could include unique identifier of the DeliveryInformationDetails in merchant's store or display Id of the DeliveryInformationDetails in the merchant store etc.

The total number of aliases associated with a DeliveryInformationDetails are limited to 5.

association ([Association])

DeprecatedUse deliveryInformationDetailsFor.orderLineItems

Associated intervals for LineItem in the deliveryInformation.

deliverFromAddress (ShippingAddress)

The address at which the delivery started. Consists of street address, locality/city, region/state, country code and postal code.

deliveryInformationDetailsFor (DeliveryInformationDetailsFor)

Contains details about entities associated with the delivery information.

estimatedDeliveryDate (String)

Estimated delivery date in ISO-8601 format and is provided in Coordinated Universal Timezone (UTC).

id (ID ^required)

Identifier for the deliveryInformation

reason (String)

Reason associated to the delivery information state. Currently, the field is only present for cancelled delivery information.

The value is constrained to one of the following

value	description
CUSTOMER_REQUESTED	Cancellation is requested by Customer
UNFULFILLABLE	Unable to Fulfill
UNDELIVERABLE	Failure during Delivery

state (String ^required)

Current status of deliveryInformation.

The value is constrained to one of the following

value	description
PENDING	The process of picking items has started and Delivery is currently pending.
IN_TRANSIT	Delivery is currently in progress and tracking details have been added to the delivery.
DELIVERED	Delivery is successfully completed.
CANCELLED	Delivery has been canceled for one of the reasons mentioned in the `cancellationReason`.

trackingDetails (TrackingDetails)

Tracking information associated with the delivery, such as the tracking ID and carrier.

Updated about 2 months ago