GET
/
v1
/
products
/
{id}

Authorizations

Authorization
string
headerrequired

Your Goody API key.

Path Parameters

id
string
required

Product ID

Query Parameters

use_custom_catalog
boolean

Limit to custom catalog only (for approved API partners)

Response

200 - application/json
id
string
required
name
string
required
brand
object
required
variants
object[]
required
images
object[]
required
price
integer
required

The price of the product, in cents.

price_is_variable
boolean
required

Whether the price of this product is variable. If true, then the price can be set by the sender.

restricted_states
string[]
required
subtitle
string | null

A description of this product.

subtitle_short
string | null

An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.

recipient_description
string | null

An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.

variants_label
string | null

The label for the variants of this product, e.g. "Size" or "Color".

variants_num_selectable
integer | null

The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.

variant_groups
object[]

For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by /, e.g. Medium / Black when the groups are Size and Color.

price_min
integer | null

The minimum price of the product, in cents. Only used if price_is_variable is true.

price_max
integer | null

The maximum price of the product, in cents. Only used if price_is_variable is true.

attributes
object[]

An array of attributes that describe this product.

status
enum<string>

Whether this product is active. Since the product catalog only returns active products by default, this is always true, except if you are a Commerce API customer using a custom catalog, and are pulling products with the custom_catalog_show_inactive flag.

Available options:
active,
inactive
updated_at
string

The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated.

reserved_options
object | null

For approved API partners only.