Orders
inquiry.json
method: GET
secured: true
url: /v1/office/orders/inquiry/[Filter].json
Returns a list of any orders that match the filter
| Field | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|
filter |
Type: String |
||||||||
scope |
The number of sales periods to go looking back
Type: Integer (optional - default is 3) |
If sucessfull you will see a response like this:
{
"Sheets": [
{
"SalesPeriod": "Dec - 2014",
"SalesPeriodValue": 1380,
"PVAmount": "56",
"BVAmount": "106.65",
"Balance": "-",
"Records": [
{
"ShipTo": "Jason Sperske
3500 Gateway Blvd
Fremont, CA 94538-6584",
"Date": "12/8/2014",
"FullRefNo": "32-4510",
"RefNo": "1165510",
"AccessToken": "HENxuTVOtSPscqLvwfAaqP44B4O2w4Ee",
"Url": "/office/order/inquiry/32-1-1370/Ehs7mvSIwvC1FsRpgC185mzuY2PdExose.json",
"StatusDescription": "Shipped ",
"CanTrack": true,
"PVAmount": "56",
"BVAmount": "106.65",
"Balance": "-"
}
]
},
{
"SalesPeriod": "Nov - 2014",
"SalesPeriodValue": 1379,
"PVAmount": "68",
"BVAmount": "116.40",
"Balance": "-",
"Records": [
{
"ShipTo": "Jason Sperske
3500 Gateway Blvd
Fremont, CA 94538-6584",
"Date": "11/13/2014",
"FullRefNo": "32-1-1370",
"RefNo": "1161370",
"AccessToken": "Ehs7mvSIwvC1FsRpgC185mzuY2PdExose",
"Url": "/office/order/inquiry/32-1-1370/Ehs7mvSIwvC1FsRpgC185mzuY2PdExose.json",
"StatusDescription": "Shipped ",
"CanTrack": true,
"PVAmount": "68",
"BVAmount": "116.40",
"Balance": "-"
}
]
}
],
"DataLoadTime": "23 Jan 2015 03:01 PST ",
"AjaxDataLoadTime": "213 ms",
"success": true,
"error": null
}