Readers of this page should have already read the RetailAPI overview and understand the fundamentals of calling this API

/database endpoints

End point names that begin with /database are read only endpoints that return information that might generally be held in a database. You can use GET or POST verbs to read these endpoints. POST requests are still read only data requests and do not change the database, the POST verb is allowed so that complex and long requests are possible without the limitations on maximum URL length.

All endpoints, and especially /database endpoints, may return different information to callers using different Api Keys. A list of /database/products may return only eCommerce publised products to a shopping website, whilst if called by a supplier will typically only show details of products relevant to that supplier. Technically, the endpoints implement both vertical (what fields/values you can see) and horizontal security (are you permitted to see product X?)

URL Path	Price	Description
/database/products	Standard	Details of products
/request/card_inquiry	Standard	Information about a prepay (gift card) or discount voucher held by a customer. Allows eCommerce sites to fetch the current worth to support online redemption

/database/products

Returns the list of products available.

Attributes
Typically Public	No
Query parameters obeyed	limit, search
Response formats	JSON, XML, binary
Price	Standard

/RetailAPI_1_2_3_4/database/products.json?limit=5&search=abc

/database/publicmessages

Returns an array of current messages intended for shoppers

Attributes
Typically Public	Yes
Query parameters obeyed	limit, search
Response formats	JSON, XML, binary
Price	Standard

/RetailAPI_1_2_3_4/database/publicmessages.json  View JSON Sample
/RetailAPI_1_2_3_4/database/publicmessages.xml  View XML Sample

/database/locations

Returns the list of locations or stores available.

Attributes
Typically Public	Yes (subset of fields)
Query parameters obeyed	limit, search
Response formats	JSON, XML, binary
Price	Standard

/RetailAPI_1_2_3_4/database/locations.json?limit=500&search=abc

/request endpoints

/request endpoints are typically API requests that would logically expect some level of processing or action by the server. This might be a report extraction, specialised searching, storing sales and transactions or requesting changes to /database rows (eg, update a customers name)

/request/addsale

Receive a completed sale from an external source and store it in the retailers database.

Attributes
Typically Public	No
Query parameters obeyed
Response formats	JSON, XML, binary
Price	Standard

/request/card_inquiry

Validates a prepay or discount voucher card number and returns the available balance and other details. This API is typically used by eCommerce websites to allow customers to pay online using prepay cards issued instore.

Attributes
More documentation	Card Inquiry Info
Typically Public	No
Query parameters obeyed
Filters	card pass
Response formats	JSON, XML, binary
Price	Standard
Security	High

/RetailAPI_1_2_3_4/request/card_inquiry.json?filter=card(34513)&filter=pass(abc) 
	View JSON Sample (Prepay Card)
	View JSON Sample (Discount Voucher)

/RetailAPI_1_2_3_4/request/card_inquiry.xml?filter=card(34513)&filter=pass(abc) 
	View XML Sample (Prepay Card)
	View XML Sample (Discount Voucher)

Where this endpoint is called from a web server on behalf of a client browser (ie a shopper has entered their card# and password into a web page, and the web server processing that web page issues the call to the RetailAPI endpoint), then the API call will generally require details about the user session in order to implement anti fraud measures. The information required is all HTTP headers from a request (any recent request is acceptable, the requested URL is not important) and details of the remote users IP address.

/request/currentbill

Return summary information about the current months charges that have been applied from using RetailAPI.

Attributes
Typically Public	No
Query parameters obeyed
Response formats	JSON, XML, binary
Price	Free (if not called excessively)

/RetailAPI_1_2_3_4/request/currentbill.json View JSON Sample
/RetailAPI_1_2_3_4/request/currentbill.xml View XML Sample

/request/upload_pricebook

Allows a pricebook (list of products, barcodes, descriptions, prices and ordering information) from a supplier for a retailer. This provides an automated way for authorised suppliers to update their pricing information in a retailers system.

Attributes
Typically Public	No
Query parameters obeyed
Response formats	JSON, XML, binary
HTTP verbs	POST
Price	Standard

This API requires a payload containing the pricebook. Several formats are supported for this payload such as XML, JSON, CSV, XLSX.

RetailAPI index