AVB LINQ Public API

AvbSaleSearch

Avb Sales

This service allows you to search sales by a variety of parameters.

The following routes are available for this service:
GET, POST	/avbsales/search	The GET and POST methods of this service perform identically. Only one parameter is required though all may be used together.

**AvbSaleSearch** Parameters:
Name	Parameter	Data Type	Required
Ids	body	List<long>	No
StartDate	body	DateTime?	No
EndDate	body	DateTime?	No
Sources	body	List<SaleSource>	No
StartDateCreated	body	DateTime?	No
EndDateCreated	body	DateTime?	No

**SaleSource** Enum:
Undefined
LINQ
POS
Website

**AvbSaleSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Sales	form	List<SaleModel>	No

**SaleModel** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	long	No
ExternalOrderNumber	form	string	No
AvbId	form	string	No
SaleDate	form	DateTime	No
CustomerName	form	string	No
CustomerPhone	form	string	No
CustomerEmail	form	string	No
CustomerZipcode	form	string	No
SalesRep	form	string	No
StoreLocation	form	string	No
GrandTotal	form	decimal	No
Subtotal	form	decimal	No
Discount	form	decimal	No
Misc	form	decimal	No
Tax	form	decimal	No
Shipping	form	decimal	No
Source	form	SaleSource	No	Source is: 'LINQ','POS', or 'Website'
ShippingAddressLine1	form	string	No
ShippingAddressLine2	form	string	No
ShippingAddressCity	form	string	No
ShippingAddressState	form	string	No
ShippingAddressZip	form	string	No
ShippingMethod	form	string	No
PaymentType	form	string	No
CustomerID	form	string	No
DeliveredDate	form	DateTime?	No
SaleItems	form	List<SaleItemModel>	No
CreatedDate	form	DateTime	No

**SaleItemModel** Parameters:
Name	Parameter	Data Type	Required
MfgSku	form	string	Yes
Brand	form	string	Yes
SellerSku	form	string	No
Name	form	string	No
ItemQty	form	decimal	Yes
ItemCost	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 /avbsales/search HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ids: 
	[
		0
	],
	startDate: 0001-01-01,
	endDate: 0001-01-01,
	sources: 
	[
		Undefined
	],
	startDateCreated: 0001-01-01,
	endDateCreated: 0001-01-01
}

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
		}
	},
	sales: 
	[
		{
			id: 0,
			externalOrderNumber: String,
			avbId: String,
			saleDate: 0001-01-01,
			customerName: String,
			customerPhone: String,
			customerEmail: String,
			customerZipcode: String,
			salesRep: String,
			storeLocation: String,
			grandTotal: 0,
			subtotal: 0,
			discount: 0,
			misc: 0,
			tax: 0,
			shipping: 0,
			source: Undefined,
			shippingAddressLine1: String,
			shippingAddressLine2: String,
			shippingAddressCity: String,
			shippingAddressState: String,
			shippingAddressZip: String,
			shippingMethod: String,
			paymentType: String,
			customerID: String,
			deliveredDate: 0001-01-01,
			saleItems: 
			[
				{
					id: 0,
					sellerSku: String,
					mfgSku: String,
					name: String,
					brand: String,
					itemCost: 0,
					itemQty: 0
				}
			],
			createdDate: 0001-01-01
		}
	]
}