GET 3dCartWebAPI/v1/OrderStatus


Get all OrderStatus

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

countonly

Count the number of rows only

integer

Default value is 0

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of OrderStatus
NameDescriptionTypeAdditional information
OrderStatusID

Primary key. Auto-incremented. database reference = Order_Status.id

integer

None.

Sorting

database reference = Order_Status.StatusID

integer

None.

StatusDefinition

database reference = Order_Status.StatusDefinition

string

String length: inclusive between 0 and 50

StatusText

database reference = Order_Status.StatusText

string

String length: inclusive between 0 and 50

Visible

database reference = Order_Status.Visible

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OrderStatusID": 1,
    "Sorting": 1,
    "StatusDefinition": "sample string 1",
    "StatusText": "sample string 2",
    "Visible": true
  },
  {
    "OrderStatusID": 1,
    "Sorting": 1,
    "StatusDefinition": "sample string 1",
    "StatusText": "sample string 2",
    "Visible": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfOrderStatus xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderStatus>
    <OrderStatusID>1</OrderStatusID>
    <Sorting>1</Sorting>
    <StatusDefinition>sample string 1</StatusDefinition>
    <StatusText>sample string 2</StatusText>
    <Visible>true</Visible>
  </OrderStatus>
  <OrderStatus>
    <OrderStatusID>1</OrderStatusID>
    <Sorting>1</Sorting>
    <StatusDefinition>sample string 1</StatusDefinition>
    <StatusText>sample string 2</StatusText>
    <Visible>true</Visible>
  </OrderStatus>
</ArrayOfOrderStatus>