Skip to main content
GET
/
v1
/
products
/
{product_id}
Get Product Detail
curl --request GET \
  --url https://api.sandbox.hit-pay.com/v1/products/{product_id} \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>'
{
  "id": "<string>",
  "business_id": "<string>",
  "category_id": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "price": 123,
  "price_display": "<string>",
  "price_stored": 123,
  "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>",
      "product_variation_weight": 123
    }
  ],
  "is_published": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "headline": "<string>",
  "tax_id": "<string>",
  "product_weight": 123,
  "delivery_method_required": true,
  "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>"
        }
      ]
    }
  ],
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z"
}

Headers

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

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
product_id
string
required

Response

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<date-time>
required
​
updated_at
string<date-time>
required
​
headline
string | null
​
tax_id
string | null
​
product_weight
integer | null

Weight in gram

​
delivery_method_required
boolean | null
​
variation_key_1
string | null
​
variation_key_2
string | null
​
variation_key_3
string | null
​
images
object[]
​
starts_at
string<date-time> | null
​
ends_at
string<date-time> | null