getOrderStates
get
/ccagent/v1/merchant/orderStates
Get Order States. Lists the order States that can be used for searching for orders. Order state values incorporate changes made from admin UI, if any.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getOrderStates_response
Type:
Show Source
object
-
items(optional):
array items
The list of all Order States
Nested Schema : items
Type:
Show Source
object
-
displayKey(optional):
string
Display Key of the Order State
-
displayName(optional):
string
Display Name of the Order State
Example Response (application/json)
[
{
"displayKey":"PROCESSING",
"displayName":"Being processed"
},
{
"displayKey":"NO_PENDING_ACTION",
"displayName":"Fulfilled"
},
{
"displayKey":"INCOMPLETE",
"displayName":"Incomplete"
},
{
"displayKey":"PENDING_REMOVE",
"displayName":"Pending removal"
},
{
"displayKey":"REMOVED",
"displayName":"Removed"
},
{
"displayKey":"SUBMITTED",
"displayName":"Submitted to fulfillment"
}
]
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code