HitPay Product Guide and API docs.

GET

product-category

Get All Product Category

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

{
  "data": [
    {
      "id": "9d8cbab5-13fe-4102-8bf5-3b13668ab811",
      "name": "mens hat example",
      "description": "mens hat example",
      "is_active": true,
      "order": 1,
      "children": [],
      "is_parent": true,
      "image": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "caption": "<string>",
        "alt_text": "<string>",
        "group": "<string>",
        "order": 123,
        "extension": "<string>",
        "status": "<string>",
        "disk": "<string>",
        "url": "<string>",
        "other_dimensions": [
          {
            "size": "<string>",
            "path": "<string>"
          }
        ],
        "urls": {
          "icon": "<string>",
          "large": "<string>",
          "small": "<string>",
          "medium": "<string>",
          "thumbnail": "<string>"
        }
      },
      "emoji": "?",
      "pos_color": "#4C689C"
    }
  ],
  "links": {
    "first": "https://api.sandbox.hit-pay.com/v1/product-category?page=1",
    "last": "https://api.sandbox.hit-pay.com/v1/product-category?page=4",
    "prev": null,
    "next": "https://api.sandbox.hit-pay.com/v1/product-category?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "https://api.sandbox.hit-pay.com/v1/product-category",
    "per_page": 20,
    "to": 20,
    "total": 66
  }
}

Headers

X-BUSINESS-API-KEY

string

required

Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Query Parameters

perPage

integer

default:20

Example:

20

page

integer

default:1

Example:

1

active

boolean

Filter by active status

Example:

true

parent_id

string

The parent category id, to list all subcategories of a parent category

Example:

"9a12fab0-d282-4437-9460-c3d26662d11a"

keywords

string

Filter by keywords, name

Example:

"Beanie"

Response

200 - application/json

Successful response

data

object[]

Show child attributes

data.id

string<uuid>

Example:

"9d8cbab5-13fe-4102-8bf5-3b13668ab811"

data.name

string

Example:

"mens hat example"

data.description

string | null

Example:

"mens hat example"

data.is_active

boolean

Example:

true

data.order

integer

Example:

1

data.children

object[]

Example:

[]

data.is_parent

boolean

Example:

true

data.image

object

Show child attributes

data.image.id

string<uuid>

data.image.caption

string

data.image.alt_text

string | null

data.image.group

string

data.image.order

integer

data.image.extension

string

data.image.status

string | null

data.image.disk

string

data.image.url

string

data.image.other_dimensions

object[]

Show child attributes

data.image.other_dimensions.size

string

data.image.other_dimensions.path

string

data.image.urls

object

Show child attributes

data.image.urls.icon

string

data.image.urls.large

string

data.image.urls.small

string

data.image.urls.medium

string

data.image.urls.thumbnail

string

data.emoji

string | null

Example:

"?"

data.pos_color

string | null

Example:

"#4C689C"

links

object

Show child attributes

links.first

string

Example:

"https://api.sandbox.hit-pay.com/v1/product-category?page=1"

links.last

string

Example:

"https://api.sandbox.hit-pay.com/v1/product-category?page=4"

links.prev

string | null

Example:

null

links.next

string

Example:

"https://api.sandbox.hit-pay.com/v1/product-category?page=2"

meta

object

Show child attributes

meta.current_page

integer

Example:

1

meta.from

integer

Example:

1

meta.last_page

integer

Example:

4

meta.links

object[]

Show child attributes

meta.links.url

string | null

meta.links.label

string

meta.links.active

boolean

meta.path

string

Example:

"https://api.sandbox.hit-pay.com/v1/product-category"

meta.per_page

integer

Example:

20

meta.to

integer

Example:

20

meta.total

integer

Example:

66

Get All CustomersThis endpoint allows you to retrieve all customers

⌘I

Get All Product Category

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

{
  "data": [
    {
      "id": "9d8cbab5-13fe-4102-8bf5-3b13668ab811",
      "name": "mens hat example",
      "description": "mens hat example",
      "is_active": true,
      "order": 1,
      "children": [],
      "is_parent": true,
      "image": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "caption": "<string>",
        "alt_text": "<string>",
        "group": "<string>",
        "order": 123,
        "extension": "<string>",
        "status": "<string>",
        "disk": "<string>",
        "url": "<string>",
        "other_dimensions": [
          {
            "size": "<string>",
            "path": "<string>"
          }
        ],
        "urls": {
          "icon": "<string>",
          "large": "<string>",
          "small": "<string>",
          "medium": "<string>",
          "thumbnail": "<string>"
        }
      },
      "emoji": "?",
      "pos_color": "#4C689C"
    }
  ],
  "links": {
    "first": "https://api.sandbox.hit-pay.com/v1/product-category?page=1",
    "last": "https://api.sandbox.hit-pay.com/v1/product-category?page=4",
    "prev": null,
    "next": "https://api.sandbox.hit-pay.com/v1/product-category?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "https://api.sandbox.hit-pay.com/v1/product-category",
    "per_page": 20,
    "to": 20,
    "total": 66
  }
}

API Reference

Headers

Query Parameters

Response