Skip to main content
GET
/
products
/
{id}
Get a product
curl --request GET \
  --url https://api.heffl.com/api/v2/products/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "price": 123,
  "type": "<string>",
  "isActive": true,
  "description": "<string>",
  "sku": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Product ID

Response

OK

id
string
required

Product ID

name
string
required

Product name

price
number
required

Product price

type
string
required

Product type (PRODUCT or SERVICE)

isActive
boolean
required

Whether the product is active

description
string | null

Product description

sku
string | null

SKU code