POST api/Order/GetOrderStatus

Get order status details for the list of provided orderIds.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
OrderIdList	The list of order IDs for which the user needs to retrieve the status. OrderIdList is required.	Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "OrderIdList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<GetOrderStatusRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <OrderIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIdList>
  <UserId>1</UserId>
</GetOrderStatusRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing order status details for the list of provided orderIds

GetOrderStatusResponseModel

Name	Type	Additional information
OrderId	integer	None.
Media	string	None.
Status	string	None.
CreatedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "Media": "sample string 2",
  "Status": "sample string 3",
  "CreatedBy": "sample string 4"
}

application/xml, text/xml

Sample:

<GetOrderStatusResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <CreatedBy>sample string 4</CreatedBy>
  <Media>sample string 2</Media>
  <OrderId>1</OrderId>
  <Status>sample string 3</Status>
</GetOrderStatusResponseModel>