Conversational Actions were deprecated on June 13, 2023. For more information, see Conversational Actions sunset.

OrderState

JSON representation

Deprecated: Use V3 Proto instead. Current order state.

JSON representation
{ "state": string, "label": string }

Fields

Fields
`state`	`string` state can be one of the following values: `CREATED`: Order was created at integrator's system. `REJECTED`: Order was rejected by integrator. `CONFIRMED`: Order was confirmed by the integrator and is active. `CANCELLED`: User cancelled the order. `IN_TRANSIT`: Order is being delivered. `RETURNED`: User did a return. `FULFILLED`: User received what was ordered. `CHANGE_REQUESTED`: User has requested a change to the order, and the integrator is processing this change. The order should be moved to another state after the request is handled. Required.
`label`	`string` The user-visible string for the state. Required.

state

string

state can be one of the following values:

CREATED: Order was created at integrator's system. REJECTED: Order was rejected by integrator. CONFIRMED: Order was confirmed by the integrator and is active. CANCELLED: User cancelled the order. IN_TRANSIT: Order is being delivered. RETURNED: User did a return. FULFILLED: User received what was ordered. CHANGE_REQUESTED: User has requested a change to the order, and the integrator is processing this change. The order should be moved to another state after the request is handled.

Required.

label

string

The user-visible string for the state. Required.