Order - GET

Get details on a single order.

api/{role}/Order/{id}

Request Information

PropertyNoteTypeInfo
id

Order Number

string

Required

role string

none

Response Information

PropertyNoteTypeInfo
BusinessName

Name of The Business

string

none

Copy

Index of an item within a group

integer

none

CustomerDueDate

The date to be in the customer's hands

date

none

DateAdded

The date the order was created.

date

none

DateShipped

The date the item was shipped to the customer

date

none

Description

Your description for the product ordered

string

none

DueDate

Date due for completion.

date

none

FrameNumber

A unique identifier for an order item. There can be multiple copies of a single frame number.

string

none

ImageURL

URL for the product's image file

string

none

OrderNumber

Your order number.

string

none

ShippingAddress1

Shipping Address

string

none

ShippingAddress2

Shipping Address Extended

string

none

ShippingCity

Shipping City

string

none

ShippingCountry

Shipping Country

string

none

ShippingMethod

Shipping Method

string

none

ShippingName

Shipping Name

string

none

ShippingName1

Shipping Name Extended

string

none

ShippingName2

Shipping Name Extended

string

none

ShippingPhone

Shipping Phone Number

string

none

ShippingState

Shipping State Or Province

string

none

ShippingEmail

Shipping Email

string

none

ShippingZip

Shipping Zipcode

string

none

ShipTrackingNumber

Number to Track The Shipment

string

none

ShipVia

Carrier who does the shipping. Options: FedEx, USPS, UPS, DHL

string

none

StoreNumber

Identifier for your entity

string

none

VendorSKU

Your item id for the part being ordered.

string

none

TrackURI

URL To Track Your Shipment

string

none

Status

Status of your order Possible Values: [Held, New, Processing, Shipped]

string

none

ShippingCharges

Status of your order Possible Values: [Held, New, Processing, Shipped]

decimal number

none

ItemCost

Cost For An Item

decimal number

none

GiftMessage

Gift message to the recipient

string

none

Qty

The count of units within this item

integer

none

Response Formats

application/json, text/json

{
  "businessName": "test 2",
  "copy": 3,
  "customerDueDate": "2018-06-16T21:36:25.731855-07:00",
  "dateAdded": "2018-06-16T21:36:25.731855-07:00",
  "dateShipped": "2018-06-16T21:36:25.731855-07:00",
  "description": "test 4",
  "dueDate": "2018-06-16T21:36:25.731855-07:00",
  "frameNumber": "test 5",
  "imageURL": "test 6",
  "orderNumber": "test 7",
  "shippingAddress1": "test 8",
  "shippingAddress2": "test 9",
  "shippingCity": "test 10",
  "shippingCountry": "test 11",
  "shippingMethod": "test 12",
  "shippingName": "test 13",
  "shippingName1": "test 14",
  "shippingName2": "test 15",
  "shippingPhone": "test 16",
  "shippingState": "test 17",
  "shippingEmail": "test 18",
  "shippingZip": "test 19",
  "shipTrackingNumber": "test 20",
  "shipVia": "test 21",
  "storeNumber": "test 22",
  "vendorSKU": "test 23",
  "trackURI": "test 24",
  "status": "test 25",
  "shippingCharges": 26.0,
  "itemCost": 27.0,
  "giftMessage": "test 28",
  "qty": 29
}

application/xml, text/xml

<OrderDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <BusinessName>test 2</BusinessName>
  <Copy>3</Copy>
  <CustomerDueDate>2018-06-16T21:36:25.731855-07:00</CustomerDueDate>
  <DateAdded>2018-06-16T21:36:25.731855-07:00</DateAdded>
  <DateShipped>2018-06-16T21:36:25.731855-07:00</DateShipped>
  <Description>test 4</Description>
  <DueDate>2018-06-16T21:36:25.731855-07:00</DueDate>
  <FrameNumber>test 5</FrameNumber>
  <GiftMessage>test 28</GiftMessage>
  <ImageURL>test 6</ImageURL>
  <ItemCost>27</ItemCost>
  <OrderNumber>test 7</OrderNumber>
  <Qty>29</Qty>
  <ShipTrackingNumber>test 20</ShipTrackingNumber>
  <ShipVia>test 21</ShipVia>
  <ShippingAddress1>test 8</ShippingAddress1>
  <ShippingAddress2>test 9</ShippingAddress2>
  <ShippingCharges>26</ShippingCharges>
  <ShippingCity>test 10</ShippingCity>
  <ShippingCountry>test 11</ShippingCountry>
  <ShippingEmail>test 18</ShippingEmail>
  <ShippingMethod>test 12</ShippingMethod>
  <ShippingName>test 13</ShippingName>
  <ShippingName1>test 14</ShippingName1>
  <ShippingName2>test 15</ShippingName2>
  <ShippingPhone>test 16</ShippingPhone>
  <ShippingState>test 17</ShippingState>
  <ShippingZip>test 19</ShippingZip>
  <Status>test 25</Status>
  <StoreNumber>test 22</StoreNumber>
  <TrackURI>test 24</TrackURI>
  <VendorSKU>test 23</VendorSKU>
</OrderDetailDTO>