POST
/
v1
/
products
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/products \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "name": "Beanie",
  "headline": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "price": 123,
  "price_display": "<string>",
  "price_stored": 123,
  "tax_id": "<string>",
  "is_manageable": 123,
  "is_pinned": true,
  "status": "<string>",
  "has_variations": true,
  "is_shopify": true,
  "product_url": "<string>",
  "variations_count": 123,
  "variations": [
    {
      "id": "<string>",
      "stock_keeping_unit": "<string>",
      "description": "<string>",
      "weight": "<string>",
      "length": "<string>",
      "width": "<string>",
      "depth": "<string>",
      "price": 123,
      "price_display": "<string>",
      "price_stored": 123,
      "quantity": 123,
      "quantity_alert_level": 123,
      "variation_value_1": "<string>",
      "variation_value_2": "<string>",
      "variation_value_3": "<string>"
    }
  ],
  "variation_key_1": "<string>",
  "variation_key_2": "<string>",
  "variation_key_3": "<string>",
  "images": [
    {
      "id": "<string>",
      "caption": "<string>",
      "url": "<string>",
      "other_dimensions": [
        {
          "size": "<string>",
          "path": "<string>"
        }
      ]
    }
  ],
  "publish": true,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z"
}'
{
  "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",
  "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,
      "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,
      "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
}

Headers

X-BUSINESS-API-KEY
string
required

Body

application/json
name
string
required

The name of the product

headline
string
required

The headline of the product

description
string
required

The description of the product

currency
string
required

The currency of the product

price
number
required

The price of the product

price_display
string
required

The price display of the product

price_stored
integer
required

The price stored of the product

tax_id
string

The tax id of the product

is_manageable
integer
required

The is manageable of the product

is_pinned
boolean
required

The is pinned of the product

status
string
required

The status of the product

has_variations
boolean
required

The has variations of the product

is_shopify
boolean
required

The is shopify of the product

product_url
string
required

The product url of the product

variations_count
integer
required

The variations count of the product

variations
object[]
required
variation_key_1
string | null
required
variation_key_2
string | null
required
variation_key_3
string | null
required
images
object[]
required
publish
boolean
required
starts_at
string | null
ends_at
string | null

Response

201 - application/json
id
string
required
business_id
string
required
category_id
string[]
required
name
string
required
headline
string | null
description
string
required
currency
string
required
price
number
required
price_display
string
required
price_stored
integer
required
tax_id
string | null
is_manageable
integer
required
is_pinned
boolean
required
status
string
required
has_variations
boolean
required
is_shopify
boolean
required
product_url
string
required
variations_count
integer
required
variations
object[]
required
variation_key_1
string | null
variation_key_2
string | null
variation_key_3
string | null
images
object[]
is_published
boolean
required
created_at
string
required
updated_at
string
required
starts_at
string | null
ends_at
string | null