GET 3dCartWebAPI/v1/OrderStatus/{id}


Get an OrderStatus

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

OrderStatus ID

integer

Required

Body Parameters

None.


Sample Request


Please click here to download the C# Rest API Client project from GitHub.
not yet available
not yet available
not yet available

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:i="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>