Skip to main content
GET
Get a product

Authorizations

Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Path Parameters

id
string
required

Response

The product

id
string
Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

merchantId
string
Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

name
string
Example:

"Camiseta Preta P"

description
string | null
price
number
Example:

89.9

currency
string
Example:

"BRL"

productType
enum<string>
Available options:
physical,
digital
sku
string | null
trackStock
boolean
stock
integer | null
weight
number | null
heightCm
number | null
widthCm
number | null
lengthCm
number | null
status
enum<string>
Available options:
active,
inactive
imageUrl
string | null

Signed, short-lived URL for the product image. null when no image was uploaded.

createdAt
string<date-time>
updatedAt
string<date-time>