EMUN1 ASP.NET

<back to all web services

QueryOrders

The following routes are available for this service:
All Verbs/service/QueryOrders
QueryOrders Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
OrderNumberquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
OrderBase<TLine> Parameters:
NameParameterData TypeRequiredDescription
LinesformList<TLine>No
OrderBase Parameters:
NameParameterData TypeRequiredDescription
TagsformDictionary<string, HashSet<String>>No
IdformstringNo
OrderNumberformstringNo
OriginalOrderNumberformstringNo
RetailerIdformstringNo
ConsumerIdformstringNo
CustomerIdformstringNo
CompanyNameformstringNo
StatusformstringNo
ERPStatusformstringNo
ManufacturerIdformstringNo
ReviewReasonformstringNo
TransactionTypeformstringNo
SalesRepIDformstringNo
CurrentRepIDformstringNo
OrderDateformDateTimeNo
ShipDateformDateTimeNo
ExpectedToClearformDateTimeNo
OpenItemsformIEnumerable<OrderLine>No
ShippedItemsformIEnumerable<OrderLine>No
OrderTotalformdecimalNo
OpenTotalformdecimalNo
ShippedTotalformdecimalNo
BalanceformdecimalNo
ShippedAmountformdecimalNo
SourceformstringNo
ClientVersionformstringNo
IsEmunOrderformboolNo
ShippingMethdodformstringNo
ShippingLocationAddressformstringNo
ShippingLocationAddress2formstringNo
ShippingLocationCityformstringNo
ShippingLocationStateformstringNo
ShippingLocationZipformstringNo
ShippingLocationCountryformstringNo
ShippingLocationPhoneformstringNo
ShippingLocationNameformstringNo
BillAddressformstringNo
BillAddress2formstringNo
BillCityformstringNo
BillStateformstringNo
BillZipformstringNo
BillCountryformstringNo
BillPhoneformstringNo
PaymentTermsformstringNo
CreditCardTypeformstringNo
CreditCardNumberformstringNo
Custom11formstringNo
PrefixformstringNo
ParcelsformList<Parcel>No
ParcelCountformintNo
RetailerEmailformstringNo
PONumberformstringNo
ActiveformboolNo
UploadedformboolNo
ExportedformboolNo
NextFulfillmentformstringNo
LocationformstringNo
CustEmailformstringNo
MetaformDictionary<string, string>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
OrderLineBase Parameters:
NameParameterData TypeRequiredDescription
OrderNumberformstringNo
PositionformintNo
ProductIdformstringNo
DescriptionformstringNo
QtyPurchasedformintNo
QtyOpenformintNo
PriceformdecimalNo
ExtendedTotalformdecimalNo
PromoDiscountformdecimalNo
OptionsformList<ILineOption>No
ActiveformboolNo
XmlOptionsformstringNo
CostformstringNo
VendorIdformstringNo
CategoryIdformstringNo
ShipDateformDateTime?No
StatusformstringNo
ILineOption Parameters:
NameParameterData TypeRequiredDescription
FieldIdformstringNo
OrderNumberformstringNo
PositionformintNo
UpchargeformdoubleNo
UpchargeTypeformstringNo
ValueIdformstringNo
Parcel Parameters:
NameParameterData TypeRequiredDescription
CartonNumberformstringNo
OrderNumberformstringNo
OrderStatusformstringNo
OrderedOnformDateTimeNo
InvoiceNumberformstringNo
InvoicedOnformDateTimeNo
ManufacturerIdformstringNo
ShippingMethodformstringNo
TrackingNumberformstringNo
TrackingUrlformstringNo
WarehouseformstringNo
PONumberformstringNo
CartNameformstringNo
RetailerIdformstringNo
RetailerEmailformstringNo
ShippingLocationIdformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}