All Verbs | /service/QueryOrdersSearch |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
RetailerId | form | string | No | |
PurchaseOrder | form | string | No | |
OrderedOn | form | DateTime | No | |
ShipOn | form | DateTime | No | |
GrandTotal | form | float | No | |
WritingRep | form | string | No | |
SalesRepId | form | string | No | |
Vendor | form | string | No | |
Status | form | string | No | |
Items | form | IEnumerable<OrderLine> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrderNumber | form | string | No | |
Position | form | int | No | |
ProductId | form | string | No | |
Description | form | string | No | |
QtyPurchased | form | int | No | |
QtyOpen | form | int | No | |
Price | form | decimal | No | |
ExtendedTotal | form | decimal | No | |
PromoDiscount | form | decimal | No | |
Options | form | List<ILineOption> | No | |
Active | form | bool | No | |
XmlOptions | form | string | No | |
Cost | form | string | No | |
VendorId | form | string | No | |
CategoryId | form | string | No | |
ShipDate | form | DateTime? | No | |
Status | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldId | form | string | No | |
OrderNumber | form | string | No | |
Position | form | int | No | |
Upcharge | form | double | No | |
UpchargeType | form | string | No | |
ValueId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryOrdersSearch HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Length: length
{"search":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Content-Length: length {"offset":0,"total":0,"results":[{"id":"String","companyName":"String","retailerId":"String","purchaseOrder":"String","orderedOn":"0001-01-01T00:00:00.0000000Z","shipOn":"0001-01-01T00:00:00.0000000Z","grandTotal":0,"writingRep":"String","salesRepId":"String","vendor":"String","status":"String","items":[{"orderNumber":"String","position":0,"productId":"String","description":"String","qtyPurchased":0,"qtyOpen":0,"price":0,"extendedTotal":0,"promoDiscount":0,"options":[],"active":false,"xmlOptions":"<Options></Options>","cost":"String","vendorId":"String","categoryId":"String","shipDate":"0001-01-01T00:00:00.0000000Z","status":"String"}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}