GET api-v1/commerce/orders/{status}
Get an order by order status
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
status |
The status of the orders to find |
RequestState |
Required |
Body Parameters
None.
Response Information
Resource Description
The orders which match the given status in the format appropriate for the Accept header
Collection of OrderResponseName | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the |
integer |
None. |
SchemaName |
The name of the which the order was created against |
string |
None. |
Status |
An enum representing the status of the Order |
RequestState |
None. |
Created |
The date and time the order was created |
date |
None. |
Modified |
The date and time the order was modified |
date |
None. |
The email address of the user that created the order |
string |
None. |
|
Filter |
The collection of filters attached to this order |
Collection of string |
None. |
Data |
A dictionary containing data saved against the order |
Dictionary of string [key] and Object [value] |
None. |
Items |
The samples submitted in this order |
Collection of LineItemResponse |
None. |
Response Formats
application/json,text/json
Sample:
[ { "Id": 1, "SchemaName": "sample string 2", "Status": 0, "Created": "2024-11-12T03:41:26.8368032+00:00", "Modified": "2024-11-12T03:41:26.8368032+00:00", "Email": "sample string 5", "Filter": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} }, "Items": [ { "Id": 1, "SuiteCodes": [ "sample string 1", "sample string 2" ], "DetCodes": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} } }, { "Id": 1, "SuiteCodes": [ "sample string 1", "sample string 2" ], "DetCodes": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} } } ] }, { "Id": 1, "SchemaName": "sample string 2", "Status": 0, "Created": "2024-11-12T03:41:26.8368032+00:00", "Modified": "2024-11-12T03:41:26.8368032+00:00", "Email": "sample string 5", "Filter": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} }, "Items": [ { "Id": 1, "SuiteCodes": [ "sample string 1", "sample string 2" ], "DetCodes": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} } }, { "Id": 1, "SuiteCodes": [ "sample string 1", "sample string 2" ], "DetCodes": [ "sample string 1", "sample string 2" ], "Data": { "sample string 1": {}, "sample string 3": {} } } ] } ]
application/xml,text/xml
Sample:
<ArrayOfOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/labPortal2.Web.Api.v1.Commerce.Messages"> <OrderResponse> <Created>2024-11-12T03:41:26.8368032+00:00</Created> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Data> <Email>sample string 5</Email> <Filter xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Filter> <Id>1</Id> <Items> <LineItemResponse> <Data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 3</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> </Data> <DetCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </DetCodes> <Id>1</Id> <SuiteCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </SuiteCodes> </LineItemResponse> <LineItemResponse> <Data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 3</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> </Data> <DetCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </DetCodes> <Id>1</Id> <SuiteCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </SuiteCodes> </LineItemResponse> </Items> <Modified>2024-11-12T03:41:26.8368032+00:00</Modified> <SchemaName>sample string 2</SchemaName> <Status>New</Status> </OrderResponse> <OrderResponse> <Created>2024-11-12T03:41:26.8368032+00:00</Created> <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> <d3p1:KeyValueOfstringanyType> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value /> </d3p1:KeyValueOfstringanyType> </Data> <Email>sample string 5</Email> <Filter xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Filter> <Id>1</Id> <Items> <LineItemResponse> <Data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 3</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> </Data> <DetCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </DetCodes> <Id>1</Id> <SuiteCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </SuiteCodes> </LineItemResponse> <LineItemResponse> <Data xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 1</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> <d5p1:KeyValueOfstringanyType> <d5p1:Key>sample string 3</d5p1:Key> <d5p1:Value /> </d5p1:KeyValueOfstringanyType> </Data> <DetCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </DetCodes> <Id>1</Id> <SuiteCodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </SuiteCodes> </LineItemResponse> </Items> <Modified>2024-11-12T03:41:26.8368032+00:00</Modified> <SchemaName>sample string 2</SchemaName> <Status>New</Status> </OrderResponse> </ArrayOfOrderResponse>