EMUN1 ASP.NET

<back to all web services

QueryProductAvailability

The following routes are available for this service:
All Verbs/service/QueryProductAvailability
All Verbs/service/QueryProductAvailability/{ProductId*}
QueryProductAvailability Parameters:
NameParameterData TypeRequiredDescription
ProductIdInquerystring[]No
ProductIdpathstringNo
PriceListquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductAvailability Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
QtyAvailableformintNo
WarehouseIdformstringNo
WarehouseformWarehouseNo
VendorIdformstringNo
ProductIdformstringNo
StatusformstringNo
ActiveformboolNo
DefaultPriceformdecimalNo
FutureAvailabilityformList<ProductFutureAvailability>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
Warehouse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ProductFutureAvailability Parameters:
NameParameterData TypeRequiredDescription
QtyIncomingformdecimalNo
WarehouseIdformstringNo
PONumberformstringNo
ProductIdformstringNo
StatusformstringNo
AvailableOnformDateTimeNo
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/QueryProductAvailability HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	productIdIn: 
	[
		String
	],
	productId: String,
	priceList: 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: 
	[
		{
			qtyAvailable: 0,
			warehouseId: String,
			warehouse: 
			{
				id: String,
				name: String
			},
			vendorId: String,
			productId: String,
			status: String,
			active: False,
			defaultPrice: 0,
			futureAvailability: 
			[
				{
					qtyIncoming: 0,
					warehouseId: String,
					poNumber: String,
					productId: String,
					status: String,
					availableOn: 0001-01-01
				}
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}