Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getOrderStates_response

Type: object

Show Source

• items(optional): array items
  The list of all Order States

{
    "properties":{
        "items":{
            "description":"The list of all Order States",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayKey":{
                        "description":"Display Key of the Order State",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display Name of the Order State",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all Order States

Show Source

• Array of: object items

{
    "description":"The list of all Order States",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayKey":{
                "description":"Display Key of the Order State",
                "type":"string"
            },
            "displayName":{
                "description":"Display Name of the Order State",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayKey(optional): string
  Display Key of the Order State
• displayName(optional): string
  Display Name of the Order State

{
    "type":"object",
    "properties":{
        "displayKey":{
            "description":"Display Key of the Order State",
            "type":"string"
        },
        "displayName":{
            "description":"Display Name of the Order State",
            "type":"string"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top