GET v1/Shops/{shopId}/OrderStatuses

Get a list with all available Orders Statuses, for given shop.

Request Information

Requires Authorization!

URI Parameters

Name	Description	Type	Additional information
shopId	The id of the shop.	integer	Required.

Body Parameters

None.

Response Information

Resource Description

A list of the OrderStatusBasicInfo objects.

Collection of OrderStatusBasicInfo

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	Required
BaseOrderStatusId	Gets or sets the base order status identifier.	integer	None.
OrderStatusTypeId	Gets or sets the order status type identifier.	integer	None.
Name	Gets or sets the name.	string	Required Max length: 50
Enabled	Gets or sets the enabled.	boolean	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "BaseOrderStatusId": 2,
    "OrderStatusTypeId": 3,
    "Name": "sample string 4",
    "Enabled": true
  },
  {
    "Id": 1,
    "BaseOrderStatusId": 2,
    "OrderStatusTypeId": 3,
    "Name": "sample string 4",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderStatusBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderStatusBasicInfo>
    <Id>1</Id>
    <BaseOrderStatusId>2</BaseOrderStatusId>
    <OrderStatusTypeId>3</OrderStatusTypeId>
    <Name>sample string 4</Name>
    <Enabled>true</Enabled>
  </OrderStatusBasicInfo>
  <OrderStatusBasicInfo>
    <Id>1</Id>
    <BaseOrderStatusId>2</BaseOrderStatusId>
    <OrderStatusTypeId>3</OrderStatusTypeId>
    <Name>sample string 4</Name>
    <Enabled>true</Enabled>
  </OrderStatusBasicInfo>
</ArrayOfOrderStatusBasicInfo>