GET api/v2/orders
Returns the Order details and status information
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderNumber |
A list of customer assigned idenfiers for the orders. |
Collection of string |
None. |
Response Information
Resource Description
OrderStatusResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderStatuses |
List of order statuses |
Collection of OrderStatus |
None. |
Response Formats
Sample:
{
"OrderStatuses": [
{
"OrderNumber": "sample string 1",
"PurchaseOrderNumber": "sample string 2",
"Status": "sample string 3",
"OrderTotal": 1.0,
"InvoiceTotal": 1.0,
"SalesTax": 1.0,
"PostageAndHandling": 1.0,
"OrderDate": "2024-04-28T11:35:57.393958-05:00",
"ScheduledShipDate": "2024-04-28T11:35:57.393958-05:00",
"ActualShipDate": "2024-04-28T11:35:57.393958-05:00",
"InvoiceDate": "2024-04-28T11:35:57.393958-05:00",
"ShipMethod": "sample string 6",
"TrackingNumber": "sample string 7",
"TrackingLink": "sample string 8",
"OrderStatusDetails": [
{
"LineNumber": 1,
"ItemNumber": "sample string 2",
"OrderQuantity": 3,
"OrderQuantityUnitOfMeasure": "sample string 4",
"ShipQuantity": 5,
"ShipQuantityUnitOfMeasure": "sample string 6",
"UnitPrice": 7.0,
"UnitPriceUnitOfMeasure": "sample string 8"
},
{
"LineNumber": 1,
"ItemNumber": "sample string 2",
"OrderQuantity": 3,
"OrderQuantityUnitOfMeasure": "sample string 4",
"ShipQuantity": 5,
"ShipQuantityUnitOfMeasure": "sample string 6",
"UnitPrice": 7.0,
"UnitPriceUnitOfMeasure": "sample string 8"
}
]
},
{
"OrderNumber": "sample string 1",
"PurchaseOrderNumber": "sample string 2",
"Status": "sample string 3",
"OrderTotal": 1.0,
"InvoiceTotal": 1.0,
"SalesTax": 1.0,
"PostageAndHandling": 1.0,
"OrderDate": "2024-04-28T11:35:57.393958-05:00",
"ScheduledShipDate": "2024-04-28T11:35:57.393958-05:00",
"ActualShipDate": "2024-04-28T11:35:57.393958-05:00",
"InvoiceDate": "2024-04-28T11:35:57.393958-05:00",
"ShipMethod": "sample string 6",
"TrackingNumber": "sample string 7",
"TrackingLink": "sample string 8",
"OrderStatusDetails": [
{
"LineNumber": 1,
"ItemNumber": "sample string 2",
"OrderQuantity": 3,
"OrderQuantityUnitOfMeasure": "sample string 4",
"ShipQuantity": 5,
"ShipQuantityUnitOfMeasure": "sample string 6",
"UnitPrice": 7.0,
"UnitPriceUnitOfMeasure": "sample string 8"
},
{
"LineNumber": 1,
"ItemNumber": "sample string 2",
"OrderQuantity": 3,
"OrderQuantityUnitOfMeasure": "sample string 4",
"ShipQuantity": 5,
"ShipQuantityUnitOfMeasure": "sample string 6",
"UnitPrice": 7.0,
"UnitPriceUnitOfMeasure": "sample string 8"
}
]
}
]
}
Sample:
<OrderStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<OrderStatuses>
<OrderStatus>
<OrderNumber>sample string 1</OrderNumber>
<PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
<Status>sample string 3</Status>
<InvoiceTotal>1</InvoiceTotal>
<OrderTotal>1</OrderTotal>
<SalesTax>1</SalesTax>
<PostageAndHandling>1</PostageAndHandling>
<OrderDate>2024-04-28T11:35:57.393958-05:00</OrderDate>
<ScheduledShipDate>2024-04-28T11:35:57.393958-05:00</ScheduledShipDate>
<ActualShipDate>2024-04-28T11:35:57.393958-05:00</ActualShipDate>
<InvoiceDate>2024-04-28T11:35:57.393958-05:00</InvoiceDate>
<ShipMethod>sample string 6</ShipMethod>
<TrackingNumber>sample string 7</TrackingNumber>
<TrackingLink>sample string 8</TrackingLink>
<OrderStatusDetails>
<OrderStatusDetail>
<LineNumber>1</LineNumber>
<ItemNumber>sample string 2</ItemNumber>
<OrderQuantity>3</OrderQuantity>
<OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
<ShipQuantity>5</ShipQuantity>
<ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
<UnitPrice>7</UnitPrice>
<UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
</OrderStatusDetail>
<OrderStatusDetail>
<LineNumber>1</LineNumber>
<ItemNumber>sample string 2</ItemNumber>
<OrderQuantity>3</OrderQuantity>
<OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
<ShipQuantity>5</ShipQuantity>
<ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
<UnitPrice>7</UnitPrice>
<UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
</OrderStatusDetail>
</OrderStatusDetails>
</OrderStatus>
<OrderStatus>
<OrderNumber>sample string 1</OrderNumber>
<PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
<Status>sample string 3</Status>
<InvoiceTotal>1</InvoiceTotal>
<OrderTotal>1</OrderTotal>
<SalesTax>1</SalesTax>
<PostageAndHandling>1</PostageAndHandling>
<OrderDate>2024-04-28T11:35:57.393958-05:00</OrderDate>
<ScheduledShipDate>2024-04-28T11:35:57.393958-05:00</ScheduledShipDate>
<ActualShipDate>2024-04-28T11:35:57.393958-05:00</ActualShipDate>
<InvoiceDate>2024-04-28T11:35:57.393958-05:00</InvoiceDate>
<ShipMethod>sample string 6</ShipMethod>
<TrackingNumber>sample string 7</TrackingNumber>
<TrackingLink>sample string 8</TrackingLink>
<OrderStatusDetails>
<OrderStatusDetail>
<LineNumber>1</LineNumber>
<ItemNumber>sample string 2</ItemNumber>
<OrderQuantity>3</OrderQuantity>
<OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
<ShipQuantity>5</ShipQuantity>
<ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
<UnitPrice>7</UnitPrice>
<UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
</OrderStatusDetail>
<OrderStatusDetail>
<LineNumber>1</LineNumber>
<ItemNumber>sample string 2</ItemNumber>
<OrderQuantity>3</OrderQuantity>
<OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
<ShipQuantity>5</ShipQuantity>
<ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
<UnitPrice>7</UnitPrice>
<UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
</OrderStatusDetail>
</OrderStatusDetails>
</OrderStatus>
</OrderStatuses>
</OrderStatusResponse>