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

PropertyNoteTypeInfo
Order

OrderNumber When Type = Detail

string None
Status

Acts as a filter values : (All, New, Processing,Shipped,Held)

OrderViewStatus None
Name

Shipping Name

string None
StartDate

DateAdded when status = "All". DateShipped when status = "Shipped", otherwise ignored. Defaults to 60 days ago.

date None
EndDate

DateAdded when status = "All". DateShipped when status = "Shipped", otherwise ignored. Defaults to today.

date None
role string None

Response Information

PropertyNoteTypeInfo
DateAdded

The date the order was created.

date None
Description

Your description for the product ordered.

string None
DueDate

Date due for completion.

date None
FrameNumber

The ID assigned to an individual order item.

string None
OrderNumber

Index of an item within a group

string None
Copy

Index of an item within a group

integer None
ShippingMethod

The method of delivering item(s) ordered. I.E. "Ground".

string None
ShippingName

Name of the client who is receiving the product ordered.

string None
ShipVia

The outfit responsible for shipping. I.E. "FedEx".

string None
StoreNumber

The store number assigned to you by Northwest Framing.

string None
VendorSKU

The Sku you assigned to the product ordered.

string None

Response Formats

application/json, text/json

{
  "dateAdded": "2017-10-18T09:25:57.1123687-07:00",
  "description": "test 2",
  "dueDate": "2017-10-18T09:25:57.1279688-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"
}

application/xml, text/xml

<OrderSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <Copy>5</Copy>
  <DateAdded>2017-10-18T09:25:57.1123687-07:00</DateAdded>
  <Description>test 2</Description>
  <DueDate>2017-10-18T09:25:57.1279688-07:00</DueDate>
  <FrameNumber>test 3</FrameNumber>
  <OrderNumber>test 4</OrderNumber>
  <ShipVia>test 8</ShipVia>
  <ShippingMethod>test 6</ShippingMethod>
  <ShippingName>test 7</ShippingName>
  <StoreNumber>test 9</StoreNumber>
  <VendorSKU>test 10</VendorSKU>
</OrderSummaryDTO>