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

Bulk Data Download

This group of APIs and URLs is for application developers that need to download data in bulk. It is not generally available to most API callers.

Direct Url

Data may be available on a direct Url with the following patterns

Https://server/OpenApi2_RmSystem/BulkData/SecurityToken/TableName [ /Optional Restrictions ] .Format

RmSystem

Retailer specific unique identifier

SecurityToken

An opaque value generated from security keys held by applications. How this is obtained is not documented online. These tokens will typically change every few hours so that data is not available in a single URL for any length of time.

Direct Proxy

This API is reserved for Fieldpine applications.

Https://server/OpenApi2_RmSystem$Key-of-the-Day/Proxy/Verb[ /Optional Restrictions ] .Format

The Optional Restrictions contain the GNAP packet encoded using the toHttpPath() function, including the use of encryption.