Shipment

Object model reference for Shipment object

Shipment

Physical or digital transfer of ordered goods/services

Attributes

Name	Type	Description
id	String	unique identifier
state	String	shipment state (ready, shipped or delivered)
source	Address	address to pick shipment from
destination	Address	address to deliver shipment to
created	DateTime	shipment creation timestamp
provider	String	provider of shipping service
target_delivery	DateTime	planned date and time of delivering shipment

Example

{
    "id": "1",
    "state": "shipped",
    "source": <Address>,
    "destination": <Address>,
    "created": <DateTime>,
    "provider": "matrix-rate",
    "target_delivery": <DateTime>,
}