GET api-v1/commerce/orders/{id}

Get an order by the order id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Id of the order to find

integer

Required

Body Parameters

None.

Response Information

Resource Description

The order which matches the given Id in the format appropriate for the Accept header

OrderResponse
NameDescriptionTypeAdditional 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.

Email

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": "2018-10-20T14:38:34.7289033+01:00",
  "Modified": "2018-10-20T14:38:34.7289033+01: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:
<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/labPortal2.Web.Api.V1.Commerce.Messages">
  <Created>2018-10-20T14:38:34.7289033+01:00</Created>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <Email>sample string 5</Email>
  <Filter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Filter>
  <Id>1</Id>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/labPortal2.Web.Api.v1.Commerce.Messages">
    <d2p1:LineItemResponse>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Data>
      <d2p1:DetCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:DetCodes>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:SuiteCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:SuiteCodes>
    </d2p1:LineItemResponse>
    <d2p1:LineItemResponse>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Data>
      <d2p1:DetCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:DetCodes>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:SuiteCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:SuiteCodes>
    </d2p1:LineItemResponse>
  </Items>
  <Modified>2018-10-20T14:38:34.7289033+01:00</Modified>
  <SchemaName>sample string 2</SchemaName>
  <Status>New</Status>
</OrderResponse>