OrderStatus - GET
Get the status for a specific order.
api/{role}/OrderStatus/{id}
Request Information
| Property | Note | Constraints |
|---|---|---|
| id : string |
Order Number URL encode reserved characters |
Required |
| role : string |
Response Information
Array<OrderStatusDTO>
| Property | Note | Constraints |
|---|---|---|
| Copy : integer |
Index Of The Item |
|
| DateShipped : date |
Date when shipped from the NWF facility |
|
| ItemNumber : string |
Your Item Number |
|
| OrderNumber : string |
Your Order Number |
|
| ShipTrackingNumber : string |
Identifier to track the shipment |
|
| Status : string |
Possible Values: [Held, New, Processing, Shipped, Received] |
|
| ShippingCharges : decimal number |
Amount charged for shipping |
|
| ItemCost : decimal number |
Sum of all costs for an item |
|
| BoxPrice : decimal number |
Price for boxing |
|
| GiftCardCharge : decimal number |
Price for a gift card |
|
| GiftWrapCharge : decimal number |
Price for gift wrapping |
|
| Site : string |
Production site location |
Response Formats
application/json, text/json
[
{
"copy": 1,
"dateShipped": "2024-11-15T07:54:48.6484181-08:00",
"itemNumber": "test 2",
"orderNumber": "test 3",
"shipTrackingNumber": "test 4",
"status": "test 5",
"shippingCharges": 6.0,
"itemCost": 7.0,
"boxPrice": 8.0,
"giftCardCharge": 9.0,
"giftWrapCharge": 10.0,
"site": "test 11"
},
{
"copy": 1,
"dateShipped": "2024-11-15T07:54:48.6484181-08:00",
"itemNumber": "test 2",
"orderNumber": "test 3",
"shipTrackingNumber": "test 4",
"status": "test 5",
"shippingCharges": 6.0,
"itemCost": 7.0,
"boxPrice": 8.0,
"giftCardCharge": 9.0,
"giftWrapCharge": 10.0,
"site": "test 11"
}
]application/xml, text/xml
<ArrayOfOrderStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
<OrderStatusDTO>
<BoxPrice>8</BoxPrice>
<Copy>1</Copy>
<DateShipped>2024-11-15T07:54:48.6484181-08:00</DateShipped>
<GiftCardCharge>9</GiftCardCharge>
<GiftWrapCharge>10</GiftWrapCharge>
<ItemCost>7</ItemCost>
<ItemNumber>test 2</ItemNumber>
<OrderNumber>test 3</OrderNumber>
<ShipTrackingNumber>test 4</ShipTrackingNumber>
<ShippingCharges>6</ShippingCharges>
<Site>test 11</Site>
<Status>test 5</Status>
</OrderStatusDTO>
<OrderStatusDTO>
<BoxPrice>8</BoxPrice>
<Copy>1</Copy>
<DateShipped>2024-11-15T07:54:48.6484181-08:00</DateShipped>
<GiftCardCharge>9</GiftCardCharge>
<GiftWrapCharge>10</GiftWrapCharge>
<ItemCost>7</ItemCost>
<ItemNumber>test 2</ItemNumber>
<OrderNumber>test 3</OrderNumber>
<ShipTrackingNumber>test 4</ShipTrackingNumber>
<ShippingCharges>6</ShippingCharges>
<Site>test 11</Site>
<Status>test 5</Status>
</OrderStatusDTO>
</ArrayOfOrderStatusDTO>