All Verbs | /service/QueryOrders |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
OrderNumber | 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 |
---|---|---|---|---|
Lines | form | List<TLine> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Tags | form | Dictionary<string, HashSet<String>> | No | |
Id | form | string | No | |
OrderNumber | form | string | No | |
OriginalOrderNumber | form | string | No | |
RetailerId | form | string | No | |
ConsumerId | form | string | No | |
CustomerId | form | string | No | |
CompanyName | form | string | No | |
Status | form | string | No | |
ERPStatus | form | string | No | |
ManufacturerId | form | string | No | |
ReviewReason | form | string | No | |
TransactionType | form | string | No | |
SalesRepID | form | string | No | |
CurrentRepID | form | string | No | |
OrderDate | form | DateTime | No | |
ShipDate | form | DateTime | No | |
ExpectedToClear | form | DateTime | No | |
OpenItems | form | IEnumerable<OrderLine> | No | |
ShippedItems | form | IEnumerable<OrderLine> | No | |
OrderTotal | form | decimal | No | |
OpenTotal | form | decimal | No | |
ShippedTotal | form | decimal | No | |
Balance | form | decimal | No | |
ShippedAmount | form | decimal | No | |
Source | form | string | No | |
ClientVersion | form | string | No | |
IsEmunOrder | form | bool | No | |
ShippingMethdod | form | string | No | |
ShippingLocationAddress | form | string | No | |
ShippingLocationAddress2 | form | string | No | |
ShippingLocationCity | form | string | No | |
ShippingLocationState | form | string | No | |
ShippingLocationZip | form | string | No | |
ShippingLocationCountry | form | string | No | |
ShippingLocationPhone | form | string | No | |
ShippingLocationName | form | string | No | |
BillAddress | form | string | No | |
BillAddress2 | form | string | No | |
BillCity | form | string | No | |
BillState | form | string | No | |
BillZip | form | string | No | |
BillCountry | form | string | No | |
BillPhone | form | string | No | |
PaymentTerms | form | string | No | |
CreditCardType | form | string | No | |
CreditCardNumber | form | string | No | |
Custom11 | form | string | No | |
Prefix | form | string | No | |
Parcels | form | List<Parcel> | No | |
ParcelCount | form | int | No | |
RetailerEmail | form | string | No | |
PONumber | form | string | No | |
Active | form | bool | No | |
Uploaded | form | bool | No | |
Exported | form | bool | No | |
NextFulfillment | form | string | No | |
Location | form | string | No | |
CustEmail | form | string | No | |
Meta | form | Dictionary<string, string> | 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 |
---|---|---|---|---|
CartonNumber | form | string | No | |
OrderNumber | form | string | No | |
OrderStatus | form | string | No | |
OrderedOn | form | DateTime | No | |
InvoiceNumber | form | string | No | |
InvoicedOn | form | DateTime | No | |
ManufacturerId | form | string | No | |
ShippingMethod | form | string | No | |
TrackingNumber | form | string | No | |
TrackingUrl | form | string | No | |
Warehouse | form | string | No | |
PONumber | form | string | No | |
CartName | form | string | No | |
RetailerId | form | string | No | |
RetailerEmail | form | string | No | |
ShippingLocationId | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryOrders HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
orderNumber: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { lines: [ { 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-01, status: String } ], tags: { String: [ String ] }, id: String, orderNumber: String, originalOrderNumber: String, retailerId: String, consumerId: String, customerId: String, companyName: String, status: String, erpStatus: String, manufacturerId: String, reviewReason: String, transactionType: String, salesRepID: String, currentRepID: String, orderDate: 0001-01-01, shipDate: 0001-01-01, expectedToClear: 0001-01-01, openItems: [], shippedItems: [], orderTotal: 0, openTotal: 0, shippedTotal: 0, balance: 0, shippedAmount: 0, source: String, clientVersion: String, isEmunOrder: True, shippingMethdod: String, shippingLocationAddress: String, shippingLocationAddress2: String, shippingLocationCity: String, shippingLocationState: String, shippingLocationZip: String, shippingLocationCountry: String, shippingLocationPhone: String, shippingLocationName: String, billAddress: String, billAddress2: String, billCity: String, billState: String, billZip: String, billCountry: String, billPhone: String, paymentTerms: String, creditCardType: String, creditCardNumber: String, custom11: String, prefix: String, parcels: [ { cartonNumber: String, orderNumber: String, orderStatus: String, orderedOn: 0001-01-01, invoiceNumber: String, invoicedOn: 0001-01-01, manufacturerId: String, shippingMethod: String, trackingNumber: String, trackingUrl: String, warehouse: String, poNumber: String, cartName: String, retailerId: String, retailerEmail: String, shippingLocationId: String, id: String } ], parcelCount: 1, retailerEmail: String, poNumber: String, active: False, uploaded: False, exported: False, nextFulfillment: String, location: String, custEmail: String, meta: { String: String } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }