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": "2018-04-20T07:15:42.3117097-07:00",
  "description": "test 2",
  "dueDate": "2018-04-20T07:15:42.3117097-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>2018-04-20T07:15:42.3117097-07:00</DateAdded>
  <Description>test 2</Description>
  <DueDate>2018-04-20T07:15:42.3117097-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>