TAG LINE
TAG LINE
SMALL TITLE
Represents the status of an Order. Examples are draft, completed, in-progress etc.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the OrderStatusType |
name | "name": "completed" Type: String System defined status type for an Order. |
sortOrder | "sortOrder": 1 Type: Number Unused |
| GET | OrderStatusType/ |
| Retrieve all of the OrderStatusType objects. | |
Retrieve all of the OrderStatusType objects. GET OrderStatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "completed",
"sortOrder": 23
}
]
} | |
| GET | OrderStatusType/Paged |
| Retrieve all of the OrderStatusType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the OrderStatusType objects in a paged fashion. GET OrderStatusType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "completed",
"sortOrder": 0
}
]
}
} | |
| GET | OrderStatusType/{id} |
| Retrieve an instance of the OrderStatusType object by its ID. | |
| {id} | Unique identifier for the OrderStatusType object. |
Retrieve an instance of the OrderStatusType object by its ID. GET OrderStatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "completed",
"sortOrder": 16
}
} | |