POST
/
v1
/
products
/
{product_id}
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/products/{product_id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --form 'name=Product Beanie' \
  --form 'description=<string>' \
  --form 'headline=<string>' \
  --form quantity=1 \
  --form quantity_alert_level=1 \
  --form currency=sgd \
  --form price=123 \
  --form is_manageable=1 \
  --form is_pinned=0 \
  --form product_weight=123 \
  --form delivery_method_required=true \
  --form 'existing_variation=[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "price": 123,
    "quantity": 123,
    "quantity_alert_level": 123,
    "product_variation_weight": 123,
    "variation_value_1": "<string>",
    "variation_value_2": "<string>",
    "variation_value_3": "<string>"
  }
]' \
  --form 'images=[
  {}
]' \
  --form publish=1 \
  --form '_method=<string>'
{
  "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
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
product_id
string
required

Body

multipart/form-data
​
name
string
required

The name of the product

Example:

"Product Beanie"

​
price
number
required

The price of the product

​
description
string

The description of the product

​
headline
string

The headline of the product

​
quantity
number

The quantity of the product

Required range: x >= 0
Example:

1

​
quantity_alert_level
number

The quantity alert level of the product. It is required when quantity alert level is present.

Required range: x >= 0
Example:

1

​
currency
string

The currency of the product

Example:

"sgd"

​
is_manageable
enum<string>
default:1

The is manageable of the product

Available options:
1,
0
​
is_pinned
enum<string>
default:0

The is pinned of the product

Available options:
1,
0
​
product_weight
integer | null

Weight in gram

​
delivery_method_required
boolean | null
​
existing_variation
object[]
​
images
object[]
​
publish
enum<string>
default:1
Available options:
1,
0
​
_method
string

Response

200
application/json
200
​
id
string
required
​
business_id
string
required
​
category_id
string[]
required
​
name
string
required
​
description
string
required
​
currency
string
required
​
price
number
required
​
price_display
string
required
​
price_stored
integer
required
​
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
​
is_published
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
headline
string | null
​
tax_id
string | null
​
variation_key_1
string | null
​
variation_key_2
string | null
​
variation_key_3
string | null
​
images
object[]
​
starts_at
string | null
​
ends_at
string | null

Was this page helpful?