Transactions API will be deprecated on May 3, 2023, ahead of the Conversational Actions sunset on June 13, 2023. For more information, see Conversational Actions sunset.
OrderState
Stay organized with collections
Save and categorize content based on your preferences.
Page Summary
This document describes the OrderState type, which is part of the deprecated Orders version 2 API.
The OrderState type has two fields: state, which indicates the current state of the order, and label, which is a user-visible string for the state.
The state field can have several possible values such as CREATED, REJECTED, CONFIRMED, CANCELLED, IN_TRANSIT, RETURNED, FULFILLED, and CHANGE_REQUESTED.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[],["The document outlines the structure for representing the current state of an order within a deprecated API. The order state is defined by two fields: `state` and `label`. `state` is a string indicating the order's status, such as `CREATED`, `REJECTED`, `CONFIRMED`, `CANCELLED`, `IN_TRANSIT`, `RETURNED`, `FULFILLED`, or `CHANGE_REQUESTED`. `label` is a user-visible string that corresponds to the state. The document also advises users to migrate to the newer Orders version 3 API.\n"]]
