States and attributes
States and attributes mapping
Legacy Status | State | Attribute |
---|---|---|
SAVED | parked | N/A |
OPEN | pending | N/A |
VOIDED | voided | N/A |
CLOSED | closed | N/A |
ONACCOUNT | pending | onaccount |
ONACCOUNT_CLOSED | closed | onaccount |
LAYBY | pending | layby |
LAYBY_CLOSED | closed | layby |
AWAITING_DISPATCH | pending | delivery |
DISPATCHED_CLOSED | closed | delivery |
AWAITING_PICKUP | pending | pickup |
PICKED_UP_CLOSED | closed | pickup |
SERVICE | pending | service |
SERVICE_CLOSED | closed | service |
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
ORlayby
(choose one) - Fulfillment method:
pickup
ORdelivery
(choose one)
Updated 3 days ago