GET order-status

Returns a list of available Order Statuses used in StoreFeeder along with a description of the status.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns a list of available Order Statuses used in StoreFeeder along with a description of the status.

Collection of OrderStatusModel
NameDescriptionTypeAdditional information
OrderStatusID The Order Statuses ID integer None.
OrderStatus Order Status name string None.
Description A description of what the Order Status means string None.
UserCanOverrideToStatus Determines whether a user is allowed to override an order to this status. boolean None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OrderStatus": {
      "OrderStatusID": 3,
      "OrderStatus": "CompleteReadyToPick",
      "Description": "An order that is ready to be processed for despatch.",
      "UserCanOverrideToStatus": true
    }
  },
  {
    "OrderStatus": {
      "OrderStatusID": 7,
      "OrderStatus": "Despatched",
      "Description": "An order that has been despatched.",
      "UserCanOverrideToStatus": true
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOrderStatusesResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderStatusesResponse>
    <OrderStatus>
      <OrderStatusID>3</OrderStatusID>
      <OrderStatus>CompleteReadyToPick</OrderStatus>
      <Description>An order that is ready to be processed for despatch.</Description>
      <UserCanOverrideToStatus>true</UserCanOverrideToStatus>
    </OrderStatus>
  </OrderStatusesResponse>
  <OrderStatusesResponse>
    <OrderStatus>
      <OrderStatusID>7</OrderStatusID>
      <OrderStatus>Despatched</OrderStatus>
      <Description>An order that has been despatched.</Description>
      <UserCanOverrideToStatus>true</UserCanOverrideToStatus>
    </OrderStatus>
  </OrderStatusesResponse>
</ArrayOfOrderStatusesResponse>