AVB LINQ Public API

SaleRequest

Magento Sales

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

The following routes are available for this service:
GET, POST	/sales/search	The GET and POST methods of this service perform identically. Only one parameter (Id or start/end date) is required though all may be used together.

**SaleRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Ids	body	List<long>	No
StartDate	body	DateTime?	No
EndDate	body	DateTime?	No
Page	body	int	No	A positive integer - 0/1 will both return the first page. If not supplied, only the first page will be returned. If a page greater than the max page is specified, the max page will be returned.

**SaleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Orders	form	List<MagentoOrder>	No

**MagentoOrder** Parameters:
Name	Parameter	Data Type	Required
entity_id	form	string	No
status	form	string	No
customer_firstname	form	string	No
customer_middlename	form	string	No
customer_lastname	form	string	No
coupon_code	form	Object	No
shipping_description	form	string	No
customer_id	form	Object	No
base_discount_amount	form	string	No
base_grand_total	form	string	No
base_shipping_amount	form	string	No
base_shipping_tax_amount	form	string	No
base_subtotal	form	string	No
base_tax_amount	form	string	No
base_total_paid	form	Object	No
base_total_refunded	form	Object	No
discount_amount	form	string	No
grand_total	form	string	No
shipping_amount	form	string	No
shipping_tax_amount	form	string	No
store_to_order_rate	form	string	No
subtotal	form	string	No
tax_amount	form	string	No
total_paid	form	Object	No
total_refunded	form	Object	No
base_shipping_discount_amount	form	string	No
base_subtotal_incl_tax	form	string	No
base_total_due	form	string	No
shipping_discount_amount	form	string	No
subtotal_incl_tax	form	string	No
total_due	form	string	No
increment_id	form	string	No
base_currency_code	form	string	No
discount_description	form	string	No
remote_ip	form	string	No
store_currency_code	form	string	No
store_name	form	string	No
created_at	form	string	No
updated_at	form	string	No
shipping_incl_tax	form	string	No
base_customer_balance_amount	form	string	No
customer_balance_amount	form	string	No
payment_method	form	string	No
gift_message_from	form	Object	No
gift_message_to	form	Object	No
gift_message_body	form	Object	No
tax_name	form	string	No
tax_rate	form	string	No
store_code	form	string	No
addresses	form	List<Address>	No
order_items	form	List<OrderItem>	No
order_comments	form	List<OrderComment>	No
transaction_id	form	string	No
cc_type	form	string	No
cc_exp_month	form	int?	No
cc_exp_year	form	int?	No
cc_last4	form	string	No
cc_avs_status	form	string	No
cybersource_token	form	string	No
cybersource_reconciliation_id	form	string	No
cybersource_authorization_code	form	string	No
cybersource_merchant_reference_code	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
region	form	string	No
postcode	form	string	No
lastname	form	string	No
street	form	string	No
city	form	string	No
email	form	string	No
telephone	form	string	No
country_id	form	string	No
firstname	form	string	No
address_type	form	string	No
prefix	form	Object	No
middlename	form	Object	No
suffix	form	Object	No
company	form	string	No

**OrderItem** Parameters:
Name	Parameter	Data Type	Required
item_id	form	string	No
parent_item_id	form	Object	No
sku	form	string	No
name	form	string	No
qty_canceled	form	string	No
qty_invoiced	form	string	No
qty_ordered	form	string	No
qty_refunded	form	string	No
qty_shipped	form	string	No
price	form	string	No
base_price	form	string	No
original_price	form	string	No
base_original_price	form	string	No
tax_percent	form	string	No
tax_amount	form	string	No
base_tax_amount	form	string	No
discount_amount	form	string	No
base_discount_amount	form	string	No
row_total	form	string	No
base_row_total	form	string	No
price_incl_tax	form	string	No
base_price_incl_tax	form	string	No
row_total_incl_tax	form	string	No
base_row_total_incl_tax	form	string	No

**OrderComment** Parameters:
Name	Parameter	Data Type	Required
is_customer_notified	form	string	No
is_visible_on_front	form	string	No
comment	form	string	No
status	form	string	No
created_at	form	string	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 /sales/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,
	page: 0
}

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
		}
	},
	orders: 
	[
		{
			
		}
	]
}