Orders - GET
Get a summary of all order items with the specified criteria.
api/{role}/Orders
?Order={Order}
&Status={Status}
&Name={Name}
&StartDate={StartDate}
&EndDate={EndDate}
Request Information
Property | Note | Constraints |
---|---|---|
Order : string |
OrderNumber When Type = Detail |
|
Status : OrderViewStatus |
Acts as a filter values : (All, New, Processing,Shipped,Held) |
|
Name : string |
Shipping Name |
|
StartDate : date |
DateAdded when status = "All". DateShipped when status = "Shipped", otherwise ignored. Defaults to 60 days ago. |
|
EndDate : date |
DateAdded when status = "All". DateShipped when status = "Shipped", otherwise ignored. Defaults to today. |
|
role : string |
Response Information
Property | Note | Constraints |
---|---|---|
DateAdded : date |
The date the order was created. |
|
Description : string |
Your description for the product ordered. |
|
DueDate : date |
Date due for completion. |
|
FrameNumber : string |
The ID assigned to an individual order item. |
|
OrderNumber : string |
Index of an item within a group |
|
Copy : integer |
Index of an item within a group |
|
ShippingMethod : string |
The method of delivering item(s) ordered. I.E. "Ground". |
|
ShippingName : string |
Name of the client who is receiving the product ordered. |
|
ShipVia : string |
The outfit responsible for shipping. I.E. "FedEx". |
|
StoreNumber : string |
The store number assigned to you by Northwest Framing. |
|
VendorSKU : string |
The Sku you assigned to the product ordered. |
|
DateShipped : date | ||
ShipTrackingNumber : string |
Response Formats
application/json, text/json
[
{
"dateAdded": "2024-09-25T23:48:51.5237703-07:00",
"description": "test 2",
"dueDate": "2024-09-25T23:48:51.5237703-07:00",
"frameNumber": "test 3",
"orderNumber": "test 4",
"copy": 5,
"shippingMethod": "test 6",
"shippingName": "test 7",
"shipVia": "test 8",
"storeNumber": "test 9",
"vendorSKU": "test 10",
"dateShipped": "2024-09-25T23:48:51.5237703-07:00",
"shipTrackingNumber": "test 11"
},
{
"dateAdded": "2024-09-25T23:48:51.5237703-07:00",
"description": "test 2",
"dueDate": "2024-09-25T23:48:51.5237703-07:00",
"frameNumber": "test 3",
"orderNumber": "test 4",
"copy": 5,
"shippingMethod": "test 6",
"shippingName": "test 7",
"shipVia": "test 8",
"storeNumber": "test 9",
"vendorSKU": "test 10",
"dateShipped": "2024-09-25T23:48:51.5237703-07:00",
"shipTrackingNumber": "test 11"
}
]
application/xml, text/xml
<ArrayOfOrderSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
<OrderSummaryDTO>
<Copy>5</Copy>
<DateAdded>2024-09-25T23:48:51.5237703-07:00</DateAdded>
<DateShipped>2024-09-25T23:48:51.5237703-07:00</DateShipped>
<Description>test 2</Description>
<DueDate>2024-09-25T23:48:51.5237703-07:00</DueDate>
<FrameNumber>test 3</FrameNumber>
<OrderNumber>test 4</OrderNumber>
<ShipTrackingNumber>test 11</ShipTrackingNumber>
<ShipVia>test 8</ShipVia>
<ShippingMethod>test 6</ShippingMethod>
<ShippingName>test 7</ShippingName>
<StoreNumber>test 9</StoreNumber>
<VendorSKU>test 10</VendorSKU>
</OrderSummaryDTO>
<OrderSummaryDTO>
<Copy>5</Copy>
<DateAdded>2024-09-25T23:48:51.5237703-07:00</DateAdded>
<DateShipped>2024-09-25T23:48:51.5237703-07:00</DateShipped>
<Description>test 2</Description>
<DueDate>2024-09-25T23:48:51.5237703-07:00</DueDate>
<FrameNumber>test 3</FrameNumber>
<OrderNumber>test 4</OrderNumber>
<ShipTrackingNumber>test 11</ShipTrackingNumber>
<ShipVia>test 8</ShipVia>
<ShippingMethod>test 6</ShippingMethod>
<ShippingName>test 7</ShippingName>
<StoreNumber>test 9</StoreNumber>
<VendorSKU>test 10</VendorSKU>
</OrderSummaryDTO>
</ArrayOfOrderSummaryDTO>