OrderFulfillmentShipmentDetails

Description

Contains details necessary to fulfill a shipment order. Note: This model is in beta.

Properties

Name	Type	Description	Notes
recipient	OrderFulfillmentRecipient	Information on the person meant to receive this shipment fulfillment.	[optional]
carrier	String	The shipping carrier being used to ship this fulfillment e.g. UPS, FedEx, USPS, etc.	[optional]
shippingNote	String	A note with additional information for the shipping carrier.	[optional]
shippingType	String	A description of the type of shipping product purchased from the carrier. e.g. First Class, Priority, Express	[optional]
trackingNumber	String	The reference number provided by the carrier to track the shipment's progress.	[optional]
trackingUrl	String	A link to the tracking webpage on the carrier's website.	[optional]
placedAt	String	The timestamp indicating when the shipment was requested. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
inProgressAt	String	The timestamp indicating when this fulfillment was moved to the `RESERVED` state. Indicates that preparation of this shipment has begun. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
packagedAt	String	The timestamp indicating when this fulfillment was moved to the `PREPARED` state. Indicates that the fulfillment is packaged. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
expectedShippedAt	String	The timestamp indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
shippedAt	String	The timestamp indicating when this fulfillment was moved to the `COMPLETED`state. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
canceledAt	String	The timestamp indicating the shipment was canceled. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
cancelReason	String	A description of why the shipment was canceled.	[optional]
failedAt	String	The timestamp indicating when the shipment failed to be completed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".	[optional]
failureReason	String	A description of why the shipment failed to be completed.	[optional]