States and attributes

States and attributes mapping

Legacy StatusStateAttribute
SAVEDparkedN/A
OPENpendingN/A
VOIDEDvoidedN/A
CLOSEDclosedN/A
ONACCOUNTpendingonaccount
ONACCOUNT_CLOSEDclosedonaccount
LAYBYpendinglayby
LAYBY_CLOSEDclosedlayby
AWAITING_DISPATCHpendingdelivery
DISPATCHED_CLOSEDcloseddelivery
AWAITING_PICKUPpendingpickup
PICKED_UP_CLOSEDclosedpickup
SERVICEpendingservice
SERVICE_CLOSEDclosedservice

Example API Usage

The attributes field accepts an array of attribute values. Multiple compatible attributes can be combined:

Example: On-account sale with delivery

{
  "state": "pending",
  "attributes": ["onaccount", "delivery"]
}

Example: Layby sale with pickup

{
  "state": "pending", 
  "attributes": ["layby", "pickup"]
}

Attribute Constraints

Important: The following attribute pairs are mutually exclusive and cannot be used together:

  • Payment method: onaccount OR layby (choose one)
  • Fulfillment method: pickup OR delivery (choose one)