AVB LINQ Public API

ProductRequest

Products

The following routes are available for this service:
GET	/products	Returns a list of products that match the given parameters. Only minimal product data is returned, though each data item will contain a link to the endpoint for the complete product data.
POST	/products	Returns a list of products that match the given parameters. Only minimal product data is returned, though each data item will contain a link to the endpoint for the complete product data.

**ProductRequest** Parameters:
Name	Parameter	Data Type	Required
BrandId	body	int	No
BrandName	body	string	No
CategoryId	body	int	No
Sku	body	string	No
IncludeCustomFields	body	bool	No
IncludePrices	body	bool	No
ExcludePackages	body	bool?	No
IsActive	body	bool?	No

**ProductResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Products	form	List<ProductStub>	No

**ProductStub** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	int	No
Sku	form	string	No
BrandId	form	int	No
BrandName	form	string	No
ProductDetailUrl	form	string	No
BaseSystemReferencePrice	form	decimal?	No
Prices	form	ProductPricesStub	No
CustomFields	form	List<KeyValuePair<String,String>>	No

**ProductPricesStub** Parameters:
Name	Parameter	Data Type	Required
BaseSystemReferencePrice	form	decimal?	No
Price	form	decimal?	No
OverridePrice	form	decimal?	No

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 /products HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	brandId: 0,
	brandName: String,
	categoryId: 0,
	sku: String,
	includeCustomFields: False,
	includePrices: False,
	excludePackages: False,
	isActive: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	products: 
	[
		{
			productId: 0,
			sku: String,
			brandId: 0,
			brandName: String,
			productDetailUrl: String,
			baseSystemReferencePrice: 0,
			customFields: 
			[
				{
					key: String,
					value: String
				}
			]
		}
	]
}