HIhitpayapp

Create a Product

This endpoint allows you to create a product.

post/v1/products

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/products
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body multipart/form-data

namestring required

The name of the product

descriptionstring

The description of the product

barcodestring

The barcode of the product

headlinestring

The headline of the product

stock_keeping_unitstring

The stock keeping unit of the product

quantitynumber

The quantity of the product

quantity_alert_levelnumber

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

currencystring

The currency of the product

pricenumber required

The price of the product

category_idsstring[]

The list of business product category ids of the product

channelsstring[]
location_idsstring[]
open_amount'1' | '0'

The open amount of the product

is_manageable'1' | '0'

The is manageable of the product

is_pinned'1' | '0'

The is pinned of the product

product_weightinteger

Weight in gram

delivery_method_requiredboolean
publish'1' | '0'

Example request

{
  "name": "Product Beanie",
  "description": "<p>Stylish hat suitable for the winter.</p>",
  "barcode": "1234567890128",
  "headline": "Stylish hat suitable for the winter.",
  "stock_keeping_unit": "SKU123456",
  "currency": "sgd",
  "price": 15,
  "category_ids": [
    "9a12fab0-d282-4437-9460-c3d26662d11a"
  ],
  "location_ids": [
    "9a12fab4-d112-48af-9d6b-050d650b0a25"
  ],
  "locations": [
    {
      "id": "9a12fab4-d112-48af-9d6b-050d650b0a25"
    }
  ],
  "product_weight": 250
}

Response

201

idstring required
business_idstring required
category_idstring[] required
namestring required
headlinestring nullable
descriptionstring required
currencystring required
pricenumber required
price_displaystring required
price_storedinteger required
tax_idstring nullable
is_manageableinteger required
is_pinnedboolean required
statusstring required
product_weightinteger

Weight in gram

delivery_method_requiredboolean
has_variationsboolean required
is_shopifyboolean required
product_urlstring required
variations_countinteger required
variation_key_1string nullable
variation_key_2string nullable
variation_key_3string nullable
is_publishedboolean required
created_atstring date-time required
updated_atstring date-time required
starts_atstring date-time nullable
ends_atstring date-time nullable

Changes

No recorded changes to this operation across all 8 revisions of this API.