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

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

decimal number None
GiftMessage

Gift message to the recipient

string None

Response Formats

application/json, text/json

{
  "businessName": "test 2",
  "copy": 3,
  "customerDueDate": "2017-12-11T03:03:44.0624636-08:00",
  "dateAdded": "2017-12-11T03:03:44.0624636-08:00",
  "dateShipped": "2017-12-11T03:03:44.0624636-08:00",
  "description": "test 4",
  "dueDate": "2017-12-11T03:03:44.0624636-08: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"
}

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>2017-12-11T03:03:44.0624636-08:00</CustomerDueDate>
  <DateAdded>2017-12-11T03:03:44.0624636-08:00</DateAdded>
  <DateShipped>2017-12-11T03:03:44.0624636-08:00</DateShipped>
  <Description>test 4</Description>
  <DueDate>2017-12-11T03:03:44.0624636-08:00</DueDate>
  <FrameNumber>test 5</FrameNumber>
  <GiftMessage>test 28</GiftMessage>
  <ImageURL>test 6</ImageURL>
  <ItemCost>27</ItemCost>
  <OrderNumber>test 7</OrderNumber>
  <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>