Hike Developer Hub | Hike APIs

Welcome to the Hike developer hub. You'll find comprehensive guides and documentation to help you start working with Hike as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
Suggest Edits

Authorization

 

OAuth 2.0

The Hike API uses OAuth 2.0 for API access and authorization.

Step 1: Request your App secret & Id

Login to your Partner Dashboard and add your application there by providing your application name and Return URI and click 'Add'. This will save your app in your 'My apps' list along with its newly generated 'App Secret' and 'App Id'. This is a primary requirement for making authenticated calls to Hike APIs.

Developer credentials

Your developer key is separate to retail store account for which you are developing this integration/app. Developer is the gateway for your application/integration into Hike's eco-system.

Step 2: Send authorization request to connect your app with a store on Hike

You'll send authorization request to connect your application with a retail store on Hike. Send your request to the following URL along with parameters mentioned below: https://api.hikeup.com/oauth/authorize

Pareameters to include in your reuqest

  • response_type- permissions to request 'code' (required)
  • client_id - issued when you created your app (required) [App Id]
  • scope - permissions to request (see below) (required)

  • redirect_uri - URL to redirect back to (required)

  • state - unique string to be passed back upon completion (optional)

Scope

The 'scope' parameter is a space-separated list of oAuth scopes, indicating what data your app will access from the retail store on Hike.Currently Hike only provides 'all' as a value for this parameter. We will be introducing more options later on.

Possible responses

If the user authorizes your app, Hikeup will redirect back to your specified redirect_uri with a temporary code in a code GET parameter, as well as a state parameter if you requested one in the previous step. If the states don't match, the request may have been created by a third party and you should abort the process.

Successful authorization response:

{redirect_uri}?code={code}&state={state}

Access denied

{redirect_uri}?error=access_denied

Authorization code valid for 10 minutes

Authorization codes may only be exchanged once and expire 10 minutes after issuance. Once it has expired, please send a new authorization request.

Step 3 - Exchange authorization code for an access token

Now that you have an authorization code, exchange it for an access token using the oauth/token API method: https://api.hikeup.com/oauth/token

  • client_id - issued when you created your app (required)
  • client_secret - issued when you created your app (required) [App secret]
  • code - Temporary authorization code received in step 2 (required)
  • redirect_uri - must match the originally submitted URI (if one was sent)
  • grant_type - this is always 'authorization_code'

Response

Receive a JSON response containing your access_token among other things.

{
    "access_token": "fdgdfg54df6g8df6g46d5fg46d5fg46d5fg4",
    "token_type": "Bearer",
    "expires": 498465465,
    "expires_in": 64646,
    "refresh_token": "Ksdfsd54fs65d4fs6d5f4s6d5f4s6d5f4s6d5f4"
}

These access tokens are also known as bearer tokens.

You can then use this token to call API on behalf of the user (Store). The token will continue functioning until the installing user either revokes the token and/or uninstalls your application.

User tokens issued on behalf of stores.

Step 4. Refresh the access token

Access tokens are valid for set amount of time. When an access token expires, get your application to request a new access token using the refresh token received in Step 3. Use the below-mentioned URL and parameters to request a new access token: https://api.hikeup.com/oauth/token

  • client_id - issued when you created your app (required)
  • client_secret - issued when you created your app (required)
  • refresh_token – from step 3
  • grant_type – this is always refresh_token

Response

Receive a JSON response containing refreshed new access_token along-with other details including its 'exires in' value.

{
    "access_token": "Artygbmwpekofkmlknufsdjnflopkdfgdfhgj",
    "token_type": "Bearer",
    "expires": 1387145621,
    "expires_in": 604800,
    "refresh_token": "J3F62YPIQdfJjJia1xJuaHp7NoQYtm9y0WadNBTh"
}

Why use OAuth?

At a first glance it might seem a bit too much, however, in reality OAuth makes things simpler for both you and the retailers using your application, Most importantly, it reduces security risks for everyone. Here are some of the most important benefits of using OAuth:

  • Your application doesn't need to store retail store admin’s passwords and it definitely shouldn’t!
  • Merchants don't need to sign in to Hike to every time your application send/receive data to/from Hike.
  • You can set which permissions to obtain from a retail store. In other words you can define the scope. For example, retail stores can grant your application access to their products list, without also needing to grant access to their sales history.
  • If needed, retail stores can revoke a possibly insecure application's access without affecting other applications or needing to change their own password.
 
Suggest Edits

API limits

 

API call limit

There are limits to the number of API calls that your application can make against a particular Hike store.

Call limits

Minute limit: 60 calls in a rolling 60 second window
Daily limit: 5000 calls in a rolling 24 hour window

If you exceed either rate limit you will receive a HTTP 429 (Too many requests) response with the following message in the http response body:

HTTP 429 - Too many requests

oauth_problem=rate limit exceeded&oauth_problem_advice=please wait before retrying the Hike api

You will also receive an X-Rate-Limit-Problem HTTP header with the value of Daily or Minute to indicate which rate limit you have hit.

If you encounter a limit, do not continue to make requests as this may continue to add to your limitation. The most common issue encountered is the 60 requests/min rate limit. If possible, queue requests and allow a few seconds before attempting to make another request.

Request size limit

A single POST to any of the Hike APIs has a size limit of 4MB. There is no limit to the number of elements within a request, provided the overall request size does not exceed 4MB. However, to ensure you receive a timely response from our APIs, we recommend you look to batch elements in bundles of up to 50.

 
Suggest Edits

Pagination

 

Why pagination?

A lot of the time, when you’re making calls to the Hike APIs, especially products and customers, there’ll be a lot of results to return. For that reason, we paginate the results to make sure responses are easier to handle.

Let’s say your initial call is asking for all the products in a Hike store; the result could be a massive response with thousands of products. That’s not a good place to start. Rather than that, we’ve built in a page_size limit on results where there is a chance of large data response. With this you can explicitly set the page_size parameter to ensure you can get as many results per page as you require.

Set the page_size parameter

For example, you might need to request all products in a Hike store, but you only want the 100 results at a time. The endpoint we’re going to hit here to specifically get the products in that store is /api/v1/products/get_all , with the type being product. Your GET would look something like this:

 --url 'https://api.hikeup.com/api/v1/customers/get_all?page_size=100'

Note: The page_size parameter in this call is set to 100, so the response will get you items 0 through 99.

Get the next page of results

If there is a next page available, the previous response would also include link for the the next page of results:

/api/v1/products/get_all?page_size=100&Skip_count=99'.

The next page link in previous response includes skip_count parameter value. The skip_count parameter is there to set the starting point for the next page result sets. For the purpose of this example, the Skip_count value is 99 and so the next page of results will show items 100 through 199.

--url 'https://api.hikeup.com/api/v1/products/get_all?page_size=100&Skip_count=99'

How do I know if there are more pages?

When the response doesn’t contain a link to the next page of results, you know that you’ve reached the end.

 
Suggest Edits

Status codes

 

Response status codes

When Hike receives a request to an API endpoint, a number of different HTTP status codes can be returned in the response depending on the original request.

200 OK
The request was successfully processed by Hike.
201 Created
The request has been fulfilled and a new resource has been created.
202 Accepted
The request has been fulfilled and an existing resource has been updated.
303 See Other
The response to the request can be found under a different URI in the Location header and can be retrieved using a GET method on that resource.
400 Bad Request

The request was not understood by the server, generally due to bad syntax or because the Content-Type header was not correctly set to application/json.

This status is also returned when the request provides an invalid code parameter during the OAuth token exchange process.

401 Unauthorized
The necessary authentication credentials are not present in the request or are incorrect.
403 Forbidden
The server is refusing to respond to the request. This is generally because you have not requested the appropriate scope for this action.
404 Not Found
The requested resource was not found but could be available again in the future.
422 Unprocessable Entity
The request body was well-formed but contains semantical errors. The response body will provide more details in the errors parameter.
429 Too Many Requests
The request was not accepted because the application has exceeded the rate limit. See the API Call Limit documentation for a breakdown of Hike's rate-limiting mechanism.
500 Internal Server Error
An internal error occurred in Hike. Please post to the API & support forum so that Hike staff can investigate.
501 Not Implemented
The requested endpoint is not available on that particular shop, e.g. requesting higher plan specific API on a shop running on a start-up plan. This response may also indicate that this endpoint is reserved for future use.
503 Service Unavailable
The server is currently unavailable. Check the status page for reported service outages.
504 Gateway Timeout
The request could not complete in time. Try breaking it down in multiple smaller requests.
Suggest Edits

Customers

 
 
 
Suggest Edits

Get all Customer in database

This will retrieve all customers from our database.

 
gethttps://api.hikeup.com/api/v1/customers/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by customer name, email and code

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/customers/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/customers/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/customers/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/customers/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/customers/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "first_name": "Aidan",
      "last_name": "Mileham",
      "company_name": "Great American Music",
      "phone": "(03) 5367 8324",
      "customer_group_id": 1,
      "loyalty_rewards_status": true,
      "gender": 1,
      "loyalty_balance": 0,
      "reward_points_used": 0,
      "credit_limit": 1000,
      "credit_balance": 0,
      "account_balance": 0,
      "lead_source": 0,
      "shipping_address": {
        "id": 0,
        "address1": "36 Crofts Road",
        "city": "GOONGERAH",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3888"
      },
      "billing_address": {
        "id": 0,
        "address1": "78 Acheron Road",
        "city": "MORWELL UPPER",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3840"
      },
      "created_date": "2018-05-11T13:21:02.1430471Z",
      "last_modified": "2018-05-11T13:21:02.1430471Z",
      "customer_group": {
        "name": "Social",
        "discount_status": true,
        "discount_percent": 5,
        "created_date": "2018-05-11T13:21:02.1430471Z",
        "last_modified": "2018-05-11T13:21:02.1430471Z",
        "isActive": false,
        "id": 1
      },
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific customer by Id

Retrieve particular customer by its customer ID.

 
gethttps://api.hikeup.com/api/v1/customers/get/id

Path Params

id
int32
required

Enter customer ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/customers/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/customers/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/customers/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/customers/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/customers/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "first_name": "Aidan",
  "last_name": "Mileham",
  "company_name": "Great American Music",
  "phone": "(03) 5367 8324",
  "customer_code": "Cust-001",
  "customer_group_id": 1,
  "loyalty_rewards_status": true,
  "gender": 1,
  "loyalty_balance": 0,
  "reward_points_used": 0,
  "credit_limit": 1000,
  "credit_balance": 0,
  "account_balance": 0,
  "lead_source": 0,
  "shipping_address": {
    "id": 0,
    "address1": "36 Crofts Road",
    "city": "GOONGERAH",
    "state": "Victoria",
    "country_code": "au",
    "country_name": "Australia",
    "postcode": "3888"
  },
  "billing_address": {
    "id": 0,
    "address1": "78 Acheron Road",
    "city": "MORWELL UPPER",
    "state": "Victoria",
    "country_code": "au",
    "country_name": "Australia",
    "postcode": "3840"
  },
  "created_date": "2018-05-11T13:21:02.1430471Z",
  "last_modified": "2018-05-11T13:21:02.1430471Z",
  "customer_group": {
    "name": "Social",
    "discount_status": true,
    "discount_percent": 5,
    "created_date": "2018-05-11T13:21:02.1430471Z",
    "last_modified": "2018-05-11T13:21:02.1430471Z",
    "isActive": false,
    "id": 1
  },
  "isActive": true,
  "id": 1
}
 
Suggest Edits

POST customer create or update

Retrieve product by its SKU.

 
posthttps://api.hikeup.com/api/v1/customers/createOrUpdate

Body Params

first_name
string

Customer first name

last_name
string

Customer last name

company_name
string

Customer's business name

phone
string

Customer's primary phone number

customer_code
string

Customer code in Hike

email
string

Customer's email address

delivery_address_id
int32

Customer's delivery address

billing_address_id
int32

Customer's billing address

customer_group_id
int32

Customer group id

notes
string

Internal notes

loyalty_rewards_status
boolean

Has this customer signed up for loyalty rewards?

birth_date
date-time

Customer's birth date

gender
int32

Customer's gender

loyalty_balance
double

Customer's current loyalty balance

reward_points_used
double

Reward points used so far

credit_limit
double

Credit limit approved for this customer's account

credit_balance
double

Customer's credit balance - balance of amount business owes to the customer

account_balance
double

Balance of amount customer is owing

lead_source
int32

Marketing question 'how did you hear about us?'

shipping_address
object

Customer's shipping address

 
shipping_address.id
int32

Address record id

shipping_address.address1
string

Address line 1

shipping_address.address2
string

Address line 2

shipping_address.city
string

Address city

shipping_address.state
string

Address state or province

shipping_address.country_code
string

Address country code

shipping_address.country_name
string

Address country name

shipping_address.postcode
string

Address postcode

billing_address
object

Customer's billing address

 
billing_address.id
int32

Address record id

billing_address.address1
string

Address line 1

billing_address.address2
string

Address line 2

billing_address.city
string

Address city

billing_address.state
string

Address state or province

billing_address.country_code
string

Address country code

billing_address.country_name
string

Address country name

billing_address.postcode
string

Address postcode

created_date
date-time

Customer profile created on

last_modified
date-time

Customer's profile last modified date

customer_group
object

Customer group e.g: VIP, staff, retail

 
customer_group.name
string

Customer group name

customer_group.discount_status
boolean

Does this customer group get any special discount? e.g.: Staff 10% off

customer_group.discount_percent
double

Percentage discount value for discount on all items

customer_group.created_date
date-time

Group created date

customer_group.last_modified
date-time

Record last modified date

customer_group.isActive
boolean
customer_group.id
int32
isActive
boolean
id
int32
 
curl --request POST \
  --url https://api.hikeup.com/api/v1/customers/createOrUpdate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.hikeup.com/api/v1/customers/createOrUpdate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/customers/createOrUpdate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.hikeup.com/api/v1/customers/createOrUpdate");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/customers/createOrUpdate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Get all Customer Group in database

This will retrieve all customer group from our database.

 
gethttps://api.hikeup.com/api/v1/customers/getCustomerGroup_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by customer group name

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/customers/getCustomerGroup_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/customers/getCustomerGroup_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/customers/getCustomerGroup_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/customers/getCustomerGroup_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/customers/getCustomerGroup_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "name": "Hike Group",
      "discount_status": true,
      "discount_percent": 10,
      "created_date": "2018-05-11T13:21:02.1440189Z",
      "last_modified": "2018-05-11T13:21:02.1440189Z",
      "isActive": true,
      "id": 1
    }
  ]
}
 
 
 
Suggest Edits

Get all offers in database

This will retrieve all offers from our database.

 
gethttps://api.hikeup.com/api/v1/offers/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by offer name

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/offers/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/offers/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/offers/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/offers/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/offers/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "name": "30% off discount",
      "priority": 1,
      "description": "30% off on this product",
      "offerType": 3,
      "buyX": 1,
      "isPercentage": true,
      "offerValue": 30,
      "validFrom": "2018-05-11T13:21:02.148903Z",
      "validTo": "2018-05-11T13:21:02.148903Z",
      "offerAmount": 0,
      "isOfferOnAllCustomer": true,
      "isOfferOnAllOutlet": true,
      "taxID": 1,
      "taxName": "No Tax",
      "taxRate": 0,
      "offerItems": [
        {
          "offerOn": 5,
          "offerOnId": 1,
          "name": "Caramel Ice Cream",
          "compositeQty": 0,
          "fixedPrice": 0,
          "buyAndGetType": 0,
          "isActive": true,
          "id": 1
        }
      ],
      "offerOutlets": [
        {
          "outletId": 1,
          "outletname": "melbourne",
          "isActive": false,
          "id": 0
        }
      ],
      "offerCustomerGroups": [
        {
          "customerGroupId": 1,
          "customerGroupName": "Social",
          "isActive": true,
          "id": 1
        }
      ],
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific offer by Id

Retrieve particular offer by its offer ID.

 
gethttps://api.hikeup.com/api/v1/offers/get/id

Path Params

id
int32
required

Enter offer ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/offers/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/offers/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/offers/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/offers/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/offers/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "30% off discount",
  "priority": 1,
  "description": "30% off on this product",
  "offerType": 3,
  "buyX": 1,
  "isPercentage": true,
  "offerValue": 30,
  "validFrom": "2018-05-11T13:21:02.148903Z",
  "validTo": "2018-05-11T13:21:02.148903Z",
  "offerAmount": 0,
  "isOfferOnAllCustomer": true,
  "isOfferOnAllOutlet": true,
  "taxID": 1,
  "taxName": "No Tax",
  "taxRate": 0,
  "offerItems": [
    {
      "offerOn": 5,
      "offerOnId": 1,
      "name": "Caramel Ice Cream",
      "compositeQty": 0,
      "fixedPrice": 0,
      "buyAndGetType": 0,
      "isActive": true,
      "id": 1
    }
  ],
  "offerOutlets": [
    {
      "outletId": 1,
      "outletname": "melbourne",
      "isActive": false,
      "id": 0
    }
  ],
  "offerCustomerGroups": [
    {
      "customerGroupId": 1,
      "customerGroupName": "Social",
      "isActive": true,
      "id": 1
    }
  ],
  "isActive": true,
  "id": 1
}
 
 
 
 
Suggest Edits

Get all Outlet in database

This will retrieve all outlets from our database.

 
gethttps://api.hikeup.com/api/v1/outlets/get_all
 
curl --request GET \
  --url https://api.hikeup.com/api/v1/outlets/get_all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/outlets/get_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/outlets/get_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/outlets/get_all");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/outlets/get_all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "items": [
    {
      "title": "Melbourne Store",
      "phone": "(03) 5367 8324",
      "address": {
        "id": 0,
        "address1": "36 Crofts Road",
        "city": "GOONGERAH",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3888"
      },
      "taxId": 1,
      "receiptTemplateId": 1,
      "outletRegisters": [
        {
          "name": "Cash Register 1",
          "outletID": 1,
          "outletName": "Melbourne Store",
          "defaultTax": 1,
          "defaultTaxName": "No Tax",
          "defaultTaxRate": 0,
          "receiptNumber": 100,
          "lastCloseDateTime": "2018-05-11T13:21:02.1528089Z",
          "prefix": "0000",
          "suffix": "1111",
          "emailReceipt": true,
          "printReceipt": true,
          "isOpened": true,
          "monthlyPeriod": true,
          "outletAddress": {
            "id": 0,
            "address1": "36 Crofts Road",
            "city": "GOONGERAH",
            "state": "Victoria",
            "country_code": "au",
            "country_name": "Australia",
            "postcode": "3888"
          },
          "isActive": true,
          "id": 1
        }
      ],
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific outlet by Id

Retrieve particular outlet by its outlet ID.

 
gethttps://api.hikeup.com/api/v1/outlets/get/id

Path Params

id
int32
required

Enter outlet ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/outlets/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/outlets/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/outlets/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/outlets/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/outlets/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "title": "Melbourne Store",
  "phone": "(03) 5367 8324",
  "address": {
    "id": 0,
    "address1": "36 Crofts Road",
    "city": "GOONGERAH",
    "state": "Victoria",
    "country_code": "au",
    "country_name": "Australia",
    "postcode": "3888"
  },
  "taxId": 1,
  "receiptTemplateId": 1,
  "outletRegisters": [
    {
      "name": "Cash Register 1",
      "outletID": 1,
      "outletName": "Melbourne Store",
      "defaultTax": 1,
      "defaultTaxName": "No Tax",
      "defaultTaxRate": 0,
      "receiptNumber": 100,
      "lastCloseDateTime": "2018-05-11T13:21:02.1528089Z",
      "prefix": "0000",
      "suffix": "1111",
      "emailReceipt": true,
      "printReceipt": true,
      "isOpened": true,
      "monthlyPeriod": true,
      "outletAddress": {
        "id": 0,
        "address1": "36 Crofts Road",
        "city": "GOONGERAH",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3888"
      },
      "isActive": true,
      "id": 1
    }
  ],
  "isActive": true,
  "id": 1
}
 
Suggest Edits

Get all Register in database

This will retrieve all products. If you have multiple outlets, you can retrieve products for all outlets at once and later you can filter or sort products by outlet. Hike stores pricing, markup and other relevant details by outlet which you will be able to retrieve from our database.

 
gethttps://api.hikeup.com/api/v1/outlets/get_Registers_all
 
curl --request GET \
  --url https://api.hikeup.com/api/v1/outlets/get_Registers_all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/outlets/get_Registers_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/outlets/get_Registers_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/outlets/get_Registers_all");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/outlets/get_Registers_all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "items": [
    {
      "name": "Cash Register 1",
      "outletID": 1,
      "outletName": "Melbourne Store",
      "defaultTax": 1,
      "defaultTaxName": "No Tax",
      "defaultTaxRate": 0,
      "receiptNumber": 100,
      "lastCloseDateTime": "2018-05-11T13:21:02.1537857Z",
      "prefix": "0000",
      "suffix": "1111",
      "emailReceipt": true,
      "printReceipt": true,
      "isOpened": true,
      "monthlyPeriod": true,
      "outletAddress": {
        "id": 0,
        "address1": "36 Crofts Road",
        "city": "GOONGERAH",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3888"
      },
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific Regsiter by Id

Retrieve particular item by its product ID.

 
gethttps://api.hikeup.com/api/v1/outlets/get_register/id

Path Params

id
int32
required

Enter product ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/outlets/get_register/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/outlets/get_register/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/outlets/get_register/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/outlets/get_register/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/outlets/get_register/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Cash Register 1",
  "outletID": 1,
  "outletName": "Melbourne Store",
  "defaultTax": 1,
  "defaultTaxName": "No Tax",
  "defaultTaxRate": 0,
  "receiptNumber": 100,
  "lastCloseDateTime": "2018-05-11T13:21:02.1537857Z",
  "prefix": "0000",
  "suffix": "1111",
  "emailReceipt": true,
  "printReceipt": true,
  "isOpened": true,
  "monthlyPeriod": true,
  "outletAddress": {
    "id": 0,
    "address1": "36 Crofts Road",
    "city": "GOONGERAH",
    "state": "Victoria",
    "country_code": "au",
    "country_name": "Australia",
    "postcode": "3888"
  },
  "isActive": true,
  "id": 1
}
 
Suggest Edits

PaymentTypes

 
 
 
Suggest Edits

Get all Payment type in database

This will retrieve all payment types from our database.

 
gethttps://api.hikeup.com/api/v1/payment_types/get_all
 
curl --request GET \
  --url https://api.hikeup.com/api/v1/payment_types/get_all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/payment_types/get_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/payment_types/get_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/payment_types/get_all");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/payment_types/get_all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "items": [
    {
      "payment_name": "Cash",
      "payment_option_type": 1,
      "payment_option_name": "Cash",
      "configuration_required": false,
      "is_configured": true,
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific Payment Type by Id

Retrieve particular patment type by its payment type ID.

 
gethttps://api.hikeup.com/api/v1/payment_types/get/id

Path Params

id
int32
required

Enter payment type ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/payment_types/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/payment_types/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/payment_types/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/payment_types/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/payment_types/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "payment_name": "Cash",
  "payment_option_type": 1,
  "payment_option_name": "Cash",
  "configuration_required": false,
  "is_configured": true,
  "isActive": true,
  "id": 1
}
 
 
 
 
Suggest Edits

Get all products in database

This will retrieve all products. If you have multiple outlets, you can retrieve products for all outlets at once and later you can filter or sort products by outlet. Hike stores pricing, markup and other relevant details by outlet which you will be able to retrieve from our database.

 
gethttps://api.hikeup.com/api/v1/products/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by SKU or Barcode

Sorting
string

Sort by any value including Date, SKU, ID, Barcode and Name

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/products/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/products/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/products/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/products/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/products/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "name": "Demo Jeans",
      "description": "<p>This is demo jeans example description here&nbsp;</p>\n",
      "sku": "demojeans",
      "barcode": "D5A516A3",
      "primary_image": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
      "brand_id": 6,
      "bran_name": "denim",
      "isPricingDifferentByOutlet": false,
      "has_variants": true,
      "track_inventory": true,
      "continue_selling_no_inventory": false,
      "additional_reward_points": 10,
      "created_date_time": "2018-05-11T13:21:02.1645281Z",
      "last_modified": "2018-05-11T13:21:02.1645281Z",
      "seO_feature": false,
      "product_tags": [
        {
          "tagId": 5,
          "name": "Simple"
        }
      ],
      "product_type": [
        {
          "type_id": 1,
          "type_name": "Demo Clothing",
          "parent_type_id": 0
        }
      ],
      "sales_channels": [
        {
          "sales_channels": 1
        }
      ],
      "product_outlets": [
        {
          "outlet_id": 1,
          "outlet_name": "Melbourne",
          "cost_price": 200,
          "markup": 0,
          "price_ex_tax": 200,
          "tax_id": 2,
          "tax_name": "GST",
          "tax_rate": 15,
          "price_inc_tax": 230,
          "on_hand_inventory": 100,
          "inventory_to_receive": 0,
          "reserved_inventory": 0,
          "available_inventory": 200,
          "reorder_level": 0,
          "reorder_qty": 100,
          "visible_or_not": true
        }
      ],
      "product_suppliers": [
        {
          "supplier_id": 4,
          "supplier_name": "AB Dealer",
          "is_primary": false
        }
      ],
      "product_attributes": [
        {
          "prod_attribute_id": 42,
          "master_attribute_id": 2,
          "attribute_name": "Size",
          "attribute_sequence": 1,
          "attribute_values": [
            {
              "productAttributeValueId": 91,
              "productAttributeId": 42,
              "attributeId": 2,
              "attributeValueId": 33,
              "value": "30"
            },
            {
              "productAttributeValueId": 92,
              "productAttributeId": 42,
              "attributeId": 2,
              "attributeValueId": 34,
              "value": "32"
            }
          ]
        }
      ],
      "product_variants": [
        {
          "prod_variant_id": 221,
          "variant_name": "Demo Jeans / 30",
          "sku": "10096",
          "barcode": "BB27C5E8",
          "priced_by_outlet": false,
          "cost_price": 0,
          "markup": 0,
          "variant_sub_values": [
            {
              "variant_attribute_id": 42,
              "variant_sub_value_id": 91,
              "attribute_master_id": 2,
              "sub_values_master_id": 33,
              "variant_attribute_name": "Size",
              "variant_sub_value_name": "30",
              "display_order": 1
            }
          ],
          "variant_outlets": [
            {
              "outlet_id": 1,
              "outlet_name": "Melbourne",
              "cost_price": 200,
              "markup": 0,
              "price_ex_tax": 200,
              "tax_id": 2,
              "tax_name": "GST",
              "tax_rate": 15,
              "price_inc_tax": 230,
              "on_hand_inventory": 100,
              "inventory_to_receive": 0,
              "reserved_inventory": 0,
              "available_inventory": 100,
              "reorder_level": 0,
              "reorder_qty": 100,
              "visible_or_not": true
            }
          ],
          "variant_images": [
            {
              "primary_pic_Id": 0,
              "is_primary": false
            }
          ]
        },
        {
          "prod_variant_id": 222,
          "variant_name": "Demo Jeans / 32",
          "sku": "10097",
          "barcode": "A0F4C03C",
          "priced_by_outlet": false,
          "cost_price": 0,
          "markup": 0,
          "variant_sub_values": [
            {
              "variant_attribute_id": 42,
              "variant_sub_value_id": 92,
              "attribute_master_id": 2,
              "sub_values_master_id": 33,
              "variant_attribute_name": "Size",
              "variant_sub_value_name": "32",
              "display_order": 1
            }
          ],
          "variant_outlets": [
            {
              "outlet_id": 1,
              "outlet_name": "Melbourne",
              "cost_price": 200,
              "markup": 0,
              "price_ex_tax": 200,
              "tax_id": 2,
              "tax_name": "GST",
              "tax_rate": 15,
              "price_inc_tax": 230,
              "on_hand_inventory": 100,
              "inventory_to_receive": 0,
              "reserved_inventory": 0,
              "available_inventory": 100,
              "reorder_level": 0,
              "reorder_qty": 100,
              "visible_or_not": true
            }
          ],
          "variant_images": [
            {
              "primary_pic_Id": 0,
              "is_primary": false
            }
          ]
        }
      ],
      "additional_images": [
        {
          "primary_pic_Id": 36,
          "primary_pic_name": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
          "50_thumbnail": "{Product image thumbnail 50X50}",
          "240_thumbnail": "{Product image thumbnail 240X240}",
          "500_thumbnail": "{Product image thumbnail 500X500}",
          "is_primary": true
        }
      ],
      "product_extras": [],
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific product by Id

Retrieve particular item by its product ID.

 
gethttps://api.hikeup.com/api/v1/products/get/id

Path Params

id
int32
required

Enter product ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/products/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/products/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/products/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/products/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/products/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Demo Jeans",
  "description": "<p>This is demo jeans example description here&nbsp;</p>\n",
  "sku": "demojeans",
  "barcode": "D5A516A3",
  "primary_image": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
  "brand_id": 6,
  "bran_name": "denim",
  "isPricingDifferentByOutlet": false,
  "has_variants": true,
  "track_inventory": true,
  "continue_selling_no_inventory": false,
  "additional_reward_points": 10,
  "created_date_time": "2018-05-11T13:21:02.1655047Z",
  "last_modified": "2018-05-11T13:21:02.1655047Z",
  "seO_feature": false,
  "product_tags": [
    {
      "tagId": 5,
      "name": "Simple"
    }
  ],
  "product_type": [
    {
      "type_id": 1,
      "type_name": "Demo Clothing",
      "parent_type_id": 0
    }
  ],
  "sales_channels": [
    {
      "sales_channels": 1
    }
  ],
  "product_outlets": [
    {
      "outlet_id": 1,
      "outlet_name": "Melbourne",
      "cost_price": 200,
      "markup": 0,
      "price_ex_tax": 200,
      "tax_id": 2,
      "tax_name": "GST",
      "tax_rate": 15,
      "price_inc_tax": 230,
      "on_hand_inventory": 100,
      "inventory_to_receive": 0,
      "reserved_inventory": 0,
      "available_inventory": 200,
      "reorder_level": 0,
      "reorder_qty": 100,
      "visible_or_not": true
    }
  ],
  "product_suppliers": [
    {
      "supplier_id": 4,
      "supplier_name": "AB Dealer",
      "is_primary": false
    }
  ],
  "product_attributes": [
    {
      "prod_attribute_id": 42,
      "master_attribute_id": 2,
      "attribute_name": "Size",
      "attribute_sequence": 1,
      "attribute_values": [
        {
          "productAttributeValueId": 91,
          "productAttributeId": 42,
          "attributeId": 2,
          "attributeValueId": 33,
          "value": "30"
        },
        {
          "productAttributeValueId": 92,
          "productAttributeId": 42,
          "attributeId": 2,
          "attributeValueId": 34,
          "value": "32"
        }
      ]
    }
  ],
  "product_variants": [
    {
      "prod_variant_id": 221,
      "variant_name": "Demo Jeans / 30",
      "sku": "10096",
      "barcode": "BB27C5E8",
      "priced_by_outlet": false,
      "cost_price": 0,
      "markup": 0,
      "variant_sub_values": [
        {
          "variant_attribute_id": 42,
          "variant_sub_value_id": 91,
          "attribute_master_id": 2,
          "sub_values_master_id": 33,
          "variant_attribute_name": "Size",
          "variant_sub_value_name": "30",
          "display_order": 1
        }
      ],
      "variant_outlets": [
        {
          "outlet_id": 1,
          "outlet_name": "Melbourne",
          "cost_price": 200,
          "markup": 0,
          "price_ex_tax": 200,
          "tax_id": 2,
          "tax_name": "GST",
          "tax_rate": 15,
          "price_inc_tax": 230,
          "on_hand_inventory": 100,
          "inventory_to_receive": 0,
          "reserved_inventory": 0,
          "available_inventory": 100,
          "reorder_level": 0,
          "reorder_qty": 100,
          "visible_or_not": true
        }
      ],
      "variant_images": [
        {
          "primary_pic_Id": 0,
          "is_primary": false
        }
      ]
    },
    {
      "prod_variant_id": 222,
      "variant_name": "Demo Jeans / 32",
      "sku": "10097",
      "barcode": "A0F4C03C",
      "priced_by_outlet": false,
      "cost_price": 0,
      "markup": 0,
      "variant_sub_values": [
        {
          "variant_attribute_id": 42,
          "variant_sub_value_id": 92,
          "attribute_master_id": 2,
          "sub_values_master_id": 33,
          "variant_attribute_name": "Size",
          "variant_sub_value_name": "32",
          "display_order": 1
        }
      ],
      "variant_outlets": [
        {
          "outlet_id": 1,
          "outlet_name": "Melbourne",
          "cost_price": 200,
          "markup": 0,
          "price_ex_tax": 200,
          "tax_id": 2,
          "tax_name": "GST",
          "tax_rate": 15,
          "price_inc_tax": 230,
          "on_hand_inventory": 100,
          "inventory_to_receive": 0,
          "reserved_inventory": 0,
          "available_inventory": 100,
          "reorder_level": 0,
          "reorder_qty": 100,
          "visible_or_not": true
        }
      ],
      "variant_images": [
        {
          "primary_pic_Id": 0,
          "is_primary": false
        }
      ]
    }
  ],
  "additional_images": [
    {
      "primary_pic_Id": 36,
      "primary_pic_name": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
      "50_thumbnail": "{Product image thumbnail 50X50}",
      "240_thumbnail": "{Product image thumbnail 240X240}",
      "500_thumbnail": "{Product image thumbnail 500X500}",
      "is_primary": true
    }
  ],
  "product_extras": [],
  "isActive": true,
  "id": 1
}
 
Suggest Edits

Get Product by SKU

Retrieve product by its SKU.

 
gethttps://api.hikeup.com/api/v1/products/by_sku

Query Params

SKU
string
required

Enter product's SKU.

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/products/by_sku?SKU=SKU'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/products/by_sku',
  qs: { SKU: 'SKU' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/products/by_sku?SKU=SKU")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/products/by_sku?SKU=SKU");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/products/by_sku"

querystring = {"SKU":"SKU"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Demo Jeans",
  "description": "<p>This is demo jeans example description here&nbsp;</p>\n",
  "sku": "demojeans",
  "barcode": "D5A516A3",
  "primary_image": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
  "brand_id": 6,
  "bran_name": "denim",
  "isPricingDifferentByOutlet": false,
  "has_variants": true,
  "track_inventory": true,
  "continue_selling_no_inventory": false,
  "additional_reward_points": 10,
  "created_date_time": "2018-05-11T13:21:02.1655047Z",
  "last_modified": "2018-05-11T13:21:02.1655047Z",
  "seO_feature": false,
  "product_tags": [
    {
      "tagId": 5,
      "name": "Simple"
    }
  ],
  "product_type": [
    {
      "type_id": 1,
      "type_name": "Demo Clothing",
      "parent_type_id": 0
    }
  ],
  "sales_channels": [
    {
      "sales_channels": 1
    }
  ],
  "product_outlets": [
    {
      "outlet_id": 1,
      "outlet_name": "Melbourne",
      "cost_price": 200,
      "markup": 0,
      "price_ex_tax": 200,
      "tax_id": 2,
      "tax_name": "GST",
      "tax_rate": 15,
      "price_inc_tax": 230,
      "on_hand_inventory": 100,
      "inventory_to_receive": 0,
      "reserved_inventory": 0,
      "available_inventory": 200,
      "reorder_level": 0,
      "reorder_qty": 100,
      "visible_or_not": true
    }
  ],
  "product_suppliers": [
    {
      "supplier_id": 4,
      "supplier_name": "AB Dealer",
      "is_primary": false
    }
  ],
  "product_attributes": [
    {
      "prod_attribute_id": 42,
      "master_attribute_id": 2,
      "attribute_name": "Size",
      "attribute_sequence": 1,
      "attribute_values": [
        {
          "productAttributeValueId": 91,
          "productAttributeId": 42,
          "attributeId": 2,
          "attributeValueId": 33,
          "value": "30"
        },
        {
          "productAttributeValueId": 92,
          "productAttributeId": 42,
          "attributeId": 2,
          "attributeValueId": 34,
          "value": "32"
        }
      ]
    }
  ],
  "product_variants": [
    {
      "prod_variant_id": 221,
      "variant_name": "Demo Jeans / 30",
      "sku": "10096",
      "barcode": "BB27C5E8",
      "priced_by_outlet": false,
      "cost_price": 0,
      "markup": 0,
      "variant_sub_values": [
        {
          "variant_attribute_id": 42,
          "variant_sub_value_id": 91,
          "attribute_master_id": 2,
          "sub_values_master_id": 33,
          "variant_attribute_name": "Size",
          "variant_sub_value_name": "30",
          "display_order": 1
        }
      ],
      "variant_outlets": [
        {
          "outlet_id": 1,
          "outlet_name": "Melbourne",
          "cost_price": 200,
          "markup": 0,
          "price_ex_tax": 200,
          "tax_id": 2,
          "tax_name": "GST",
          "tax_rate": 15,
          "price_inc_tax": 230,
          "on_hand_inventory": 100,
          "inventory_to_receive": 0,
          "reserved_inventory": 0,
          "available_inventory": 100,
          "reorder_level": 0,
          "reorder_qty": 100,
          "visible_or_not": true
        }
      ],
      "variant_images": [
        {
          "primary_pic_Id": 0,
          "is_primary": false
        }
      ]
    },
    {
      "prod_variant_id": 222,
      "variant_name": "Demo Jeans / 32",
      "sku": "10097",
      "barcode": "A0F4C03C",
      "priced_by_outlet": false,
      "cost_price": 0,
      "markup": 0,
      "variant_sub_values": [
        {
          "variant_attribute_id": 42,
          "variant_sub_value_id": 92,
          "attribute_master_id": 2,
          "sub_values_master_id": 33,
          "variant_attribute_name": "Size",
          "variant_sub_value_name": "32",
          "display_order": 1
        }
      ],
      "variant_outlets": [
        {
          "outlet_id": 1,
          "outlet_name": "Melbourne",
          "cost_price": 200,
          "markup": 0,
          "price_ex_tax": 200,
          "tax_id": 2,
          "tax_name": "GST",
          "tax_rate": 15,
          "price_inc_tax": 230,
          "on_hand_inventory": 100,
          "inventory_to_receive": 0,
          "reserved_inventory": 0,
          "available_inventory": 100,
          "reorder_level": 0,
          "reorder_qty": 100,
          "visible_or_not": true
        }
      ],
      "variant_images": [
        {
          "primary_pic_Id": 0,
          "is_primary": false
        }
      ]
    }
  ],
  "additional_images": [
    {
      "primary_pic_Id": 36,
      "primary_pic_name": "8c7bc24a-cd0e-40d7-a5a2-1b299e0c36d3",
      "50_thumbnail": "{Product image thumbnail 50X50}",
      "240_thumbnail": "{Product image thumbnail 240X240}",
      "500_thumbnail": "{Product image thumbnail 500X500}",
      "is_primary": true
    }
  ],
  "product_extras": [],
  "isActive": true,
  "id": 1
}
 
Suggest Edits

POST Update product inventory

Retrieve product by its SKU.

 
posthttps://api.hikeup.com/api/v1/products/inventory_update

Body Params

product_id
int32

Active outlet ID

outlet_id
int32

Active outlet ID

on_hand_inventory
double

Active outlet ID

inventory_to_receive
double

Active outlet ID

reserved_inventory
double

Active outlet ID

available_inventory
double

Active outlet ID

event_reference
string

Active outlet ID

 
curl --request POST \
  --url https://api.hikeup.com/api/v1/products/inventory_update
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.hikeup.com/api/v1/products/inventory_update' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/products/inventory_update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.hikeup.com/api/v1/products/inventory_update");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/products/inventory_update"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

ProductType

 
 
 
Suggest Edits

Get all Product Type in database

This will retrieve all product types from our database.

 
gethttps://api.hikeup.com/api/v1/product_types/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by product type name

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/product_types/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/product_types/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/product_types/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/product_types/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/product_types/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "name": "Demo Category 1",
      "parentName": "",
      "description": "Demo description",
      "sequence": 1,
      "creationTime": "2018-05-11T13:21:02.1684357Z",
      "lastModificationTime": "2018-05-11T13:21:02.1684357Z",
      "subCategories": [
        {
          "name": "sub Category 1",
          "parentId": 1,
          "parentName": "Demo Category 1",
          "description": "Sub Category Description",
          "sequence": 2,
          "creationTime": "2018-05-11T13:21:02.1684357Z",
          "lastModificationTime": "2018-05-11T13:21:02.1684357Z"
        }
      ],
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific product type by Id

Retrieve particular product type by its product type ID.

 
gethttps://api.hikeup.com/api/v1/product_types/get/id

Path Params

id
int32
required

Enter product type ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/product_types/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/product_types/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/product_types/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/product_types/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/product_types/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Demo Category 1",
  "parentName": "",
  "description": "Demo description",
  "sequence": 1,
  "creationTime": "2018-05-11T13:21:02.1684357Z",
  "lastModificationTime": "2018-05-11T13:21:02.1684357Z",
  "subCategories": [
    {
      "name": "sub Category 1",
      "parentId": 1,
      "parentName": "Demo Category 1",
      "description": "Sub Category Description",
      "sequence": 2,
      "creationTime": "2018-05-11T13:21:02.1684357Z",
      "lastModificationTime": "2018-05-11T13:21:02.1684357Z"
    }
  ],
  "isActive": true,
  "id": 1
}
 
 
 
Suggest Edits

Get all sales in database

This will retrieve all sales from our database.

 
gethttps://api.hikeup.com/api/v1/sales/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by invoice number

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/sales/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/sales/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/sales/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/sales/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/sales/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "number": "000629",
      "transactionDate": "2018-05-11T13:21:02.183084Z",
      "finalizeDate": "2018-05-11T13:21:02.183084Z",
      "customerId": 1,
      "customerName": "Karen hike",
      "customerGroupId": 1,
      "customerGroupDiscount": 5,
      "customerGroupDiscountNote": "Hike Group:5% off",
      "outletId": 1,
      "registerid": 1,
      "registerName": "Cash Register 1",
      "registerClosureId": 1,
      "barcode": "#1000629",
      "status": 2,
      "taxInclusive": true,
      "applyTaxAfterDiscount": true,
      "discountIsAsPercentage": true,
      "discountValue": 5,
      "discountNote": "",
      "tipIsAsPercentage": true,
      "tipValue": 0,
      "subTotal": 190,
      "giftCardTotal": 0,
      "totalDiscount": 9.5,
      "totalShippingCost": 0,
      "shippingTaxAmount": 0,
      "otherCharges": 0,
      "totalTax": 27.075,
      "totalTip": 0,
      "roundingAmount": 0.03,
      "netAmount": 207.6,
      "totalPaid": 207.6,
      "totalTender": 207.6,
      "changeAmount": 0,
      "currency": "AUD",
      "servedBy": 1,
      "servedByName": "Jack Hike",
      "note": "",
      "creationTime": "2018-05-11T13:21:02.183084Z",
      "isReStockWhenRefund": false,
      "trackURL": "",
      "trackDetails": "",
      "doNotUpdateInvenotry": false,
      "thirdPartySyncStatus": 1,
      "customerCurrentLoyaltyPoints": 329.3,
      "loyaltyPoints": 217.6,
      "loyaltyPointsValue": 2.18,
      "invoiceLineItems": [
        {
          "invoiceItemType": 0,
          "invoiceItemValue": 2,
          "invoiceItemValueParent": 1,
          "sequence": 1,
          "title": "Demo Jeans / 30",
          "sku": "10096",
          "category": "[{\"categoryId\":1,\"productId\":220,\"name\":\"Demo Clothing\",\"productName\":\"Demo Jeans\",\"sku\":\"demojeans\",\"parentCategoryId\":0}]",
          "brand": "6",
          "tags": "[{\"tagId\":5,\"name\":\"simple\"}]",
          "itemCost": 200,
          "quantity": 1,
          "refundedQuantity": 0,
          "soldPrice": 190,
          "retailPrice": 200,
          "totalAmount": 190,
          "taxExclusiveTotalAmount": 0,
          "taxId": 2,
          "taxName": "GST",
          "taxRate": 15,
          "taxAmount": 28.5,
          "effectiveAmount": 190,
          "discountIsAsPercentage": true,
          "discountValue": 0,
          "totalDiscount": 0,
          "actionType": 1,
          "loyaltyPoints": 10,
          "lineItemTaxes": [],
          "invoiceLineSubItems": [],
          "isActive": false,
          "id": 1
        }
      ],
      "invoicePayments": [
        {
          "paymentOptionId": 1,
          "paymentOptionName": "Cash",
          "paymentOptionType": 1,
          "tenderedAmount": 207.6,
          "roundingAmount": 0.03,
          "amount": 207.6,
          "isPaid": true,
          "outletId": 1,
          "registerId": 1,
          "registerClosureId": 1,
          "actionType": 1,
          "paymentDate": "2018-05-11T13:21:02.183084Z",
          "paymentFrom": 3,
          "servedBy": "Jack Hike",
          "invoicePaymentDetails": [],
          "isDeleted": false,
          "creationTime": "2018-05-11T13:21:02.183084Z",
          "creatorUserId": 1,
          "id": 1
        }
      ],
      "isActive": false,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific sale by Id

Retrieve particular sale by its sale ID.

 
gethttps://api.hikeup.com/api/v1/sales/get/id

Path Params

id
int32
required

Enter sale ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/sales/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/sales/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/sales/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/sales/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/sales/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "number": "000629",
  "transactionDate": "2018-05-11T13:21:02.183084Z",
  "finalizeDate": "2018-05-11T13:21:02.183084Z",
  "customerId": 1,
  "customerName": "Karen hike",
  "customerGroupId": 1,
  "customerGroupDiscount": 5,
  "customerGroupDiscountNote": "Hike Group:5% off",
  "outletId": 1,
  "registerid": 1,
  "registerName": "Cash Register 1",
  "registerClosureId": 1,
  "barcode": "#1000629",
  "status": 2,
  "taxInclusive": true,
  "applyTaxAfterDiscount": true,
  "discountIsAsPercentage": true,
  "discountValue": 5,
  "discountNote": "",
  "tipIsAsPercentage": true,
  "tipValue": 0,
  "subTotal": 190,
  "giftCardTotal": 0,
  "totalDiscount": 9.5,
  "totalShippingCost": 0,
  "shippingTaxAmount": 0,
  "otherCharges": 0,
  "totalTax": 27.075,
  "totalTip": 0,
  "roundingAmount": 0.03,
  "netAmount": 207.6,
  "totalPaid": 207.6,
  "totalTender": 207.6,
  "changeAmount": 0,
  "currency": "AUD",
  "servedBy": 1,
  "servedByName": "Jack Hike",
  "note": "",
  "creationTime": "2018-05-11T13:21:02.183084Z",
  "isReStockWhenRefund": false,
  "trackURL": "",
  "trackDetails": "",
  "doNotUpdateInvenotry": false,
  "thirdPartySyncStatus": 1,
  "customerCurrentLoyaltyPoints": 329.3,
  "loyaltyPoints": 217.6,
  "loyaltyPointsValue": 2.18,
  "invoiceLineItems": [
    {
      "invoiceItemType": 0,
      "invoiceItemValue": 2,
      "invoiceItemValueParent": 1,
      "sequence": 1,
      "title": "Demo Jeans / 30",
      "sku": "10096",
      "category": "[{\"categoryId\":1,\"productId\":220,\"name\":\"Demo Clothing\",\"productName\":\"Demo Jeans\",\"sku\":\"demojeans\",\"parentCategoryId\":0}]",
      "brand": "6",
      "tags": "[{\"tagId\":5,\"name\":\"simple\"}]",
      "itemCost": 200,
      "quantity": 1,
      "refundedQuantity": 0,
      "soldPrice": 190,
      "retailPrice": 200,
      "totalAmount": 190,
      "taxExclusiveTotalAmount": 0,
      "taxId": 2,
      "taxName": "GST",
      "taxRate": 15,
      "taxAmount": 28.5,
      "effectiveAmount": 190,
      "discountIsAsPercentage": true,
      "discountValue": 0,
      "totalDiscount": 0,
      "actionType": 1,
      "loyaltyPoints": 10,
      "lineItemTaxes": [],
      "invoiceLineSubItems": [],
      "isActive": false,
      "id": 1
    }
  ],
  "invoicePayments": [
    {
      "paymentOptionId": 1,
      "paymentOptionName": "Cash",
      "paymentOptionType": 1,
      "tenderedAmount": 207.6,
      "roundingAmount": 0.03,
      "amount": 207.6,
      "isPaid": true,
      "outletId": 1,
      "registerId": 1,
      "registerClosureId": 1,
      "actionType": 1,
      "paymentDate": "2018-05-11T13:21:02.183084Z",
      "paymentFrom": 3,
      "servedBy": "Jack Hike",
      "invoicePaymentDetails": [],
      "isDeleted": false,
      "creationTime": "2018-05-11T13:21:02.183084Z",
      "creatorUserId": 1,
      "id": 1
    }
  ],
  "isActive": false,
  "id": 1
}
 
Suggest Edits

Suppliers

 
 
 
Suggest Edits

Get all Supplier in database

This will retrieve all supplier from our database.

 
gethttps://api.hikeup.com/api/v1/suppliers/get_all

Query Params

page_size
int32
required

Result count in each batch

Skip_count
int32
required

This will depend on batch you define above

Filter
string

Filter by supplier name or company name

Sorting
string

Sort by any value

 
curl --request GET \
  --url 'https://api.hikeup.com/api/v1/suppliers/get_all?page_size=page_size&Skip_count=Skip_count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/suppliers/get_all',
  qs: 
   { page_size: 'page_size',
     Skip_count: 'Skip_count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/suppliers/get_all?page_size=page_size&Skip_count=Skip_count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/suppliers/get_all?page_size=page_size&Skip_count=Skip_count");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/suppliers/get_all"

querystring = {"page_size":"page_size","Skip_count":"Skip_count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "next": "?page_size=1&Skip_count=2",
  "totalCount": 5,
  "items": [
    {
      "supplier_name": "Supplier 1",
      "supplier_code": "Supp-001",
      "default_markup": 0,
      "company_name": "Great American Music",
      "first_name": "Aidan",
      "last_name": "Mileham",
      "phone": "(03) 5367 8324",
      "default_tax_id": 1,
      "default_tax": {
        "name": "No Tax",
        "rate": 0,
        "isDefault": true,
        "isGroup": false,
        "isActive": true,
        "id": 1
      },
      "address": {
        "id": 0,
        "address1": "36 Crofts Road",
        "city": "GOONGERAH",
        "state": "Victoria",
        "country_code": "au",
        "country_name": "Australia",
        "postcode": "3888"
      },
      "record_created": "2018-05-11T13:21:02.1879636Z",
      "last_modified": "2018-05-11T13:21:02.1879636Z",
      "isActive": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific supplier by Id

Retrieve particular supplier by its supplier ID.

 
gethttps://api.hikeup.com/api/v1/suppliers/get/id

Path Params

id
int32
required

Enter supplier ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/suppliers/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/suppliers/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/suppliers/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/suppliers/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/suppliers/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "supplier_name": "Supplier 1",
  "supplier_code": "Sup001",
  "default_markup": 0,
  "company_name": "Great American Music",
  "first_name": "Aidan",
  "last_name": "Mileham",
  "phone": "(03) 5367 8324",
  "default_tax_id": 1,
  "default_tax": {
    "name": "No Tax",
    "rate": 0,
    "isDefault": true,
    "isGroup": false,
    "isActive": true,
    "id": 1
  },
  "address": {
    "id": 0,
    "address1": "36 Crofts Road",
    "city": "GOONGERAH",
    "state": "Victoria",
    "country_code": "au",
    "country_name": "Australia",
    "postcode": "3888"
  },
  "record_created": "2018-05-11T13:21:02.1889429Z",
  "last_modified": "2018-05-11T13:21:02.1889429Z",
  "isActive": true,
  "id": 1
}
 
Suggest Edits

POST Supplier create or update

Retrieve product by its SKU.

 
posthttps://api.hikeup.com/api/v1/suppliers/createOrUpdate

Body Params

supplier_name
string

Supplier name

supplier_code
string

Supplier code

default_markup
double

Standard markup % for items received from this supplier

description
string

Description or addtional info about this supplier

company_name
string

Supplier's business name

first_name
string

Supplier's primary contact first name

last_name
string

Supplier's primary contact last name

email
string

Supplier's email address

phone
string

Supplier's phone number

mobile
string

Supplier's mobile/cellphone

fax
string

Supplier's fax number

website
string

Supplier's website address

address_id
int32

Supplier's business address id

mailing_address_id
int32

Supplier's mailing address id

default_tax_id
int32

Default payable tax rate id on purchases from this supplier

default_tax
object

Default tax rate on items purchased from this customer

 
default_tax.name
string

Customer first name

default_tax.rate
double

Customer first name

default_tax.description
string

Customer first name

default_tax.isDefault
boolean

Customer first name

default_tax.isGroup
boolean

Customer first name

default_tax.subTaxes
array of objects

Customer first name

groupTaxId
taxId
name
rate
isActive
id
default_tax.isActive
boolean
default_tax.id
int32
address
object

Supplier's business address

 
address.id
int32

Address record id

address.address1
string

Address line 1

address.address2
string

Address line 2

address.city
string

Address city

address.state
string

Address state or province

address.country_code
string

Address country code

address.country_name
string

Address country name

address.postcode
string

Address postcode

mailing_address
object

Supplier's mailing address

 
mailing_address.id
int32

Address record id

mailing_address.address1
string

Address line 1

mailing_address.address2
string

Address line 2

mailing_address.city
string

Address city

mailing_address.state
string

Address state or province

mailing_address.country_code
string

Address country code

mailing_address.country_name
string

Address country name

mailing_address.postcode
string

Address postcode

record_created
date-time

Supplier record created date

last_modified
date-time

Last modified date

isActive
boolean
id
int32
 
curl --request POST \
  --url https://api.hikeup.com/api/v1/suppliers/createOrUpdate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.hikeup.com/api/v1/suppliers/createOrUpdate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/suppliers/createOrUpdate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.hikeup.com/api/v1/suppliers/createOrUpdate");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/suppliers/createOrUpdate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
 
 
Suggest Edits

Get all tax in database

This will retrieve all tax from database.

 
gethttps://api.hikeup.com/api/v1/taxes/get_all
 
curl --request GET \
  --url https://api.hikeup.com/api/v1/taxes/get_all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/taxes/get_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/taxes/get_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/taxes/get_all");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/taxes/get_all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "items": [
    {
      "name": "GST",
      "rate": 10,
      "isDefault": true,
      "isGroup": false,
      "subTaxes": [
        {
          "groupTaxId": 1,
          "taxId": 1,
          "name": "No Tax",
          "rate": 0,
          "isActive": true,
          "id": 1
        }
      ],
      "isActive": true,
      "id": 2
    }
  ]
}
 
Suggest Edits

Get Specific tax by Id

Retrieve particular tax by its tax ID.

 
gethttps://api.hikeup.com/api/v1/taxes/get/id

Path Params

id
int32
required

Enter tax ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/taxes/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/taxes/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/taxes/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/taxes/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/taxes/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "GST",
  "rate": 10,
  "isDefault": true,
  "isGroup": false,
  "subTaxes": [
    {
      "groupTaxId": 1,
      "taxId": 1,
      "name": "No Tax",
      "rate": 0,
      "isActive": true,
      "id": 1
    }
  ],
  "isActive": true,
  "id": 2
}
 
 
 
Suggest Edits

Get all User in database

This will retrieve all users from our database.

 
gethttps://api.hikeup.com/api/v1/users/get_all
 
curl --request GET \
  --url https://api.hikeup.com/api/v1/users/get_all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/users/get_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/users/get_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/users/get_all");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/users/get_all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "items": [
    {
      "name": "Aidan",
      "surname": "Mileham",
      "userName": "Aidan",
      "displayName": "Aidan Mileham",
      "phoneNumber": "(03) 5367 8324",
      "isEmailConfirmed": true,
      "roles": [
        {
          "roleId": 1,
          "roleName": "Admin"
        },
        {
          "roleId": 2,
          "roleName": "Manager"
        },
        {
          "roleId": 3,
          "roleName": "Cashier"
        }
      ],
      "lastLoginTime": "2018-05-11T13:21:02.1918729Z",
      "isActive": true,
      "creationTime": "2018-05-11T13:21:02.1918729Z",
      "userPin": "0000",
      "isOwner": true,
      "id": 1
    }
  ]
}
 
Suggest Edits

Get Specific user by Id

Retrieve particular user by its user ID.

 
gethttps://api.hikeup.com/api/v1/users/get/id

Path Params

id
int64
required

Enter user ID.

 
curl --request GET \
  --url https://api.hikeup.com/api/v1/users/get/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.hikeup.com/api/v1/users/get/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.hikeup.com/api/v1/users/get/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.hikeup.com/api/v1/users/get/id");

xhr.send(data);
import requests

url = "https://api.hikeup.com/api/v1/users/get/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Aidan",
  "surname": "Mileham",
  "userName": "Aidan",
  "displayName": "Aidan Mileham",
  "phoneNumber": "(03) 5367 8324",
  "isEmailConfirmed": true,
  "roles": [
    {
      "roleId": 1,
      "roleName": "Admin"
    },
    {
      "roleId": 2,
      "roleName": "Manager"
    },
    {
      "roleId": 3,
      "roleName": "Cashier"
    }
  ],
  "lastLoginTime": "2018-05-11T13:21:02.1918729Z",
  "isActive": true,
  "creationTime": "2018-05-11T13:21:02.1918729Z",
  "userPin": "0000",
  "isOwner": true,
  "id": 1
}
 
Suggest Edits

Introduction

 

Hike APIs are for developers who want to integrate their application with Hike or develop a dedicated app designed to enhance capabilities of Hike admin. In this guide you'll learn about basic steps for getting started with Hike, including:

  • Sign up and become Hike partner
  • Create test store and access APIs to test out your Hike app or integration
  • Generating the required oAuth2 credentials for API access
  • API tutorials for making API calls to individual stores on Hike

Because the REST API is based on open standards, you can use any web development language to access our APIs.