ShippingFulfillment
The details of a shipped order.
Declaration
object ShippingFulfillmentProperties
| Name | Type | Description |
|---|---|---|
fulfillmentIdentifier Required | string | An opaque value that uniquely identifies this fulfillment in the order. This isn’t displayed to the user, and is only used for determining changes and user notifications. |
fulfillmentType Required | string | The type of fulfillment, which is |
status Required | string | The status of the fulfillment. |
carrier | string | The shipping carrier used to complete this fulfillment. |
deliveredAt | date-time | The date and time when the carrier delivered the shipment, in RFC 3339 format. |
estimatedDeliveryAt | date-time | The estimated delivery date and time from the carrier, in RFC 3339 format. The system ignores the time components unless the carrier provides a window duration. |
estimatedDeliveryWindowDuration | duration | The duration for the estimated delivery window, in ISO 8601-1 duration format. |
lineItems | [LineItem] | The items the carrier will ship, displayed in the order provided. |
notes | string | Additional localized information about the shipment. For example, whether it requires a signature. |
recipient | ShippingFulfillment.Recipient | The recipient of the shipment. |
shippedAt | date-time | The date and time when the carrier shipped the order, in RFC 3339 format. |
shippingType | string | The type used for display. Default: shipping |
statusDescription | string | A localized message describing the fulfillment status. |
trackingNumber | string | The tracking number provided by the shipping carrier. |
trackingURL | uri | A URL where the customer can track the shipment. |