List Products

List all products with name, category, and status filtering

GET /v1/products

Get All Products

cURL

curl --request GET \
  --url https://api.hit-pay.com/v1/products \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'

import requests

url = "https://api.hit-pay.com/v1/products"

headers = {"X-BUSINESS-API-KEY": "<x-business-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-BUSINESS-API-KEY': '<x-business-api-key>'}};

fetch('https://api.hit-pay.com/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hit-pay.com/v1/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BUSINESS-API-KEY: <x-business-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hit-pay.com/v1/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BUSINESS-API-KEY", "<x-business-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hit-pay.com/v1/products")
  .header("X-BUSINESS-API-KEY", "<x-business-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hit-pay.com/v1/products")

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

request = Net::HTTP::Get.new(url)
request["X-BUSINESS-API-KEY"] = '<x-business-api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "9a12fab4-d112-48af-9d6b-050d650b0a25",
      "business_id": "9130c422-bf97-4bd1-b370-07a3a6f40708",
      "category_id": [
        "9a12fab0-d282-4437-9460-c3d26662d11a"
      ],
      "name": "Beanie",
      "headline": null,
      "description": "<p>Stylish hat suitable for the winter.</p>",
      "currency": "SGD",
      "price": 15,
      "price_display": "SGD 15.00",
      "price_stored": 1500,
      "tax_id": null,
      "is_manageable": 1,
      "is_pinned": false,
      "status": "published",
      "product_weight": 250,
      "delivery_method_required": true,
      "has_variations": true,
      "is_shopify": false,
      "product_url": "<string>",
      "variations_count": 2,
      "variations": [
        {
          "id": "9a12fab4-d998-44ea-ad11-8753be88a1c9",
          "stock_keeping_unit": null,
          "description": "Medium",
          "weight": null,
          "length": null,
          "width": null,
          "depth": null,
          "price": 18,
          "price_display": "SGD 18.00",
          "price_stored": 1800,
          "quantity": 150,
          "quantity_alert_level": 10,
          "product_variation_weight": 250,
          "variation_value_1": "Medium",
          "variation_value_2": null,
          "variation_value_3": null
        },
        {
          "id": "9a12fab4-dd20-4f8f-9e74-de28629f863a",
          "stock_keeping_unit": null,
          "description": "Large",
          "weight": null,
          "length": null,
          "width": null,
          "depth": null,
          "price": 20,
          "price_display": "SGD 20.00",
          "price_stored": 2000,
          "quantity": 148,
          "quantity_alert_level": 10,
          "product_variation_weight": 255,
          "variation_value_1": "Large",
          "variation_value_2": null,
          "variation_value_3": null
        }
      ],
      "variation_key_1": "Size",
      "variation_key_2": null,
      "variation_key_3": null,
      "images": [
        {
          "id": "9a12fab6-1e76-448e-8c45-e84e2e38f294",
          "caption": "Beanie",
          "url": "<string>",
          "other_dimensions": [
            {
              "size": "icon",
              "path": "<string>"
            },
            {
              "size": "large",
              "path": "<string>"
            },
            {
              "size": "small",
              "path": "<string>"
            },
            {
              "size": "medium",
              "path": "<string>"
            },
            {
              "size": "thumbnail",
              "path": "<string>"
            }
          ]
        }
      ],
      "is_published": true,
      "created_at": "2023-09-07T13:04:22+08:00",
      "updated_at": "2023-09-18T14:36:54+08:00",
      "starts_at": null,
      "ends_at": null
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": null,
    "next": "h<string>"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 49,
    "links": [],
    "path": "<string>",
    "per_page": 25,
    "to": 25,
    "total": 1214
  }
}

Headers

X-BUSINESS-API-KEY · string · required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

statuses · enum<string>[]

Available options: draft, published

categories · string<uuid>[]

source · enum<string>[]

Available options: shopify, wooCommerce

inventory · enum<string>[]

Available options: in_stock, out_of_stock

location_ids · string<uuid>[]

channels · enum<string>[]

Available options: pos, invoice, online_store

keywords · string[]

page · number · default: 1

per_page · number · default: 10

Response

200 - application/json

200

data · object[]

Show child attributes

links · object

Show child attributes

meta · object

Show child attributes