Build on the till

Hike's REST API reads and writes what happens behind the counter: the catalogue and its stock levels, the customers, and every sale as it is rung up. Any language that can make an HTTP request can use it.

Start the guideBrowse the reference

GET /api/v1/brands/get_all?page_size=2&Skip_count=0

Authorization: Bearer …

200 OK

{
"totalCount": 348,
"items": [
  { "id": 41, "name": "Allpress",  "isActive": true },
  { "id": 42, "name": "Ashgrove",  "isActive": true }
]
}

Step 1

Become a partner

A free Hike Partner account is what lets you register an app against the platform.

Step 2

Register your app

Adding your app in the Partner Dashboard issues the developer key every call depends on.

Step 3

Get a token

Exchange your key for an access token, then call any endpoint on a store's behalf.

Where to go next

• Getting startedBecome a partner, register your app, and get API access
• AuthorizationThe OAuth 2.0 handshake that connects your app to a store on Hike
• API limitsHow many calls your application may make, and the size limit on a POST
• PaginationHow Hike pages large result sets, and how to walk to the next page
• Status codesEvery HTTP status a Hike API endpoint can answer with
• Payments APIIntegrating a third-party payment terminal through a gateway URL
• API referenceAll 71 endpoints, their parameters and their responses