Retrieve a product

GET

/products/{product_id}

Authorizations

bearerToken|siteContext

bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)

+

siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)

or

siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters

Path Parameters

product_id*

Product identifier

Typestring

Required

Responses

product returned

Content-Type

application/json

{

"id": "string",

"url": "string",

"name": "string",

"slug": "string",

"description": "string",

"type": "string",

"status": "string",

"scope": "string",

"price": 0,

"on_sale": true,

"on_sale_price": 0,

"variants_enabled": true,

"keep_stock": true,

"current_stock": 0,

"amount_in_cart": 0,

"amount_sold": 0,

"vendor": "string",

"checkout_profile_id": "string",

"tax_scheme_id": "string",

"tags": [

"string"

],

"created_at": "string",

"updated_at": "string",

"additionalProperties": "string"

}

GET

/products/{product_id}

Playground

Authorization

bearerToken

siteContext

Variables

Key

Value

product_id*

Samples