Library OpenApi Overview About these APIs Architecture Authentication Error Responses Locating a Server Sessions Design Guides Guides and Hints Examples Pricing for Websites Accepting Vouchers PreAuth Payment Replication Common Apis The most used APIs Create New Sale Payment Completion Multiple Locations Delivery Addresses Create New Sale v2 Customers Locations Products Staff WebHooks eCommerce Apis These APIs are often used with eCommerce website integrations Get Pricing Card Inquiry Report & Analysis Grouped or analysed report data. Typically used to build reports and dashboards Today Login Access Pinboard ReportRequest Advanced Information More indepth information Caller Handling HTTP Protocol Bulk Data Downloads Document Uploading RetailConfig Under Development Details of APIs that will be available shortly. Documentation provided is for early adopters Get Receipt

Locations API

Simple Examples

Storing details of a new store location

    "Name": "Queen St"

POST /Locations

This API functions as both an insert and edit API. When the field "Locid" is present in the payload, then the location with this key value is either created (if it doesn't exist) or editted. If you call this API without specifying the Locid field then it will be taken as an insert of a new location

If you wish to create a new location and specify the Locid parameter, rather than letting the system choose a value, then you can provide a Locid field with a value that is greater than zero and less than 2 billion.

Using /Locations/{Key} API

While the /Location/{Key} API is commonly used to retrieve a single location record by internal ID# (aka Locid) it can also return a single locations details when searching by other criteria.

Returns a single location with the externalid 1343536
/Location/name=Queen St

Each of the above will only return a single record. However, this may change in a future release to retrun all matching records. Currently, if multiple records match then no records will be returned.