List all active products
curl --request GET \
--url https://api.ongoody.com/v1/products \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "358bfc9b-0749-4dbe-95ce-465891acd7fc",
"name": "Dozen Cookies",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 3,
"variants": [
{
"id": "924c85dd-a619-4304-ace6-8df4de3178cd",
"name": "Chocolate Chip",
"subtitle": "Classic chocolate chip.",
"image_large": null
},
{
"id": "6027c968-f8d5-4e78-9627-484293fb37fa",
"name": "Oatmeal",
"subtitle": "Delicious oatmeal.",
"image_large": null
},
{
"id": "812911ff-fb98-428b-8896-8be50859b92d",
"name": "Sugar",
"subtitle": "Tasty sugar.",
"image_large": null
}
],
"variant_groups": [],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [],
"updated_at": "2025-01-21T19:20:56Z",
"status": "active"
},
{
"id": "536cf1bf-a89a-47e3-b190-0e1283341788",
"name": "Cookie Box",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 1,
"variants": [
{
"id": "83541dd1-08cd-47f8-a65a-9ca08f32e419",
"name": "Grey / Chocolate Chip",
"subtitle": null,
"image_large": null
},
{
"id": "78ef7039-0698-43b3-9344-b53b7ef17cd8",
"name": "Grey / Oatmeal",
"subtitle": null,
"image_large": null
},
{
"id": "5199b096-1001-4b2b-89f8-770d646c2c07",
"name": "Grey / Sugar",
"subtitle": null,
"image_large": null
},
{
"id": "eed051b6-504b-4ef2-9e63-8d5effe3d743",
"name": "Purple / Chocolate Chip",
"subtitle": null,
"image_large": null
},
{
"id": "a26da78f-6cec-41b7-af5c-92b7d972cf47",
"name": "Purple / Oatmeal",
"subtitle": null,
"image_large": null
},
{
"id": "b6e4c4b6-3655-49bd-be49-fec20b4f56bf",
"name": "Purple / Sugar",
"subtitle": null,
"image_large": null
}
],
"variant_groups": [
{
"id": "59339914-df64-49e0-ad79-25e200287964",
"name": "Box Color",
"options": [
{
"id": "1d54578d-29de-40ee-a32a-9504a9c69a27",
"name": "Grey",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "a124d375-8278-49bb-9432-6c16ada3cdc9",
"name": "Purple",
"subtitle": null,
"color": null,
"image_large": null
}
]
},
{
"id": "7a3f1f3b-1670-48b6-af80-1d6c73b63ee1",
"name": "Flavor",
"options": [
{
"id": "dea76195-d04c-40de-b7ea-c9adeebb4522",
"name": "Chocolate Chip",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "eb2d73a1-9d39-4510-a79d-d817ced590bb",
"name": "Oatmeal",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "3283d889-75b4-489f-a342-d51dfe127940",
"name": "Sugar",
"subtitle": null,
"color": null,
"image_large": null
}
]
}
],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [],
"updated_at": "2025-01-21T19:20:57Z",
"status": "active"
},
{
"id": "851b6cf6-bb6a-4f8d-9be1-26d88742e28d",
"name": "Six Cookies",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 3,
"variants": [
{
"id": "9f80ab26-e74c-44a1-b8d0-2e5972069d4e",
"name": "Chocolate Chip",
"subtitle": "Classic chocolate chip.",
"image_large": null
},
{
"id": "32dc57d3-3d15-431e-b4ff-9ac8d28ebc72",
"name": "Oatmeal",
"subtitle": "Delicious oatmeal.",
"image_large": null
},
{
"id": "8db9096e-03e4-476f-8bcd-3eb3c7201fd0",
"name": "Sugar",
"subtitle": "Tasty sugar.",
"image_large": null
}
],
"variant_groups": [],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [
{
"label": "Where it's made",
"content": "Made in Miami, FL"
}
],
"updated_at": "2025-01-21T19:20:57Z",
"status": "active"
}
],
"list_meta": {
"total_count": 3
}
}Authorizations
Your Goody API key.
Query Parameters
Page for pagination, starting at 1
x > 1Items per page for pagination
1 < x < 100Limit to custom catalog only (for approved API partners)
Filter by a specific shipping country code
Show inactive products in the custom catalog. Only for Commerce API customers with a custom catalog.
Response
The price of shipping for this brand, in cents.
When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold.
Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app.
An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded.
The price of the product, in cents.
Whether the price of this product is variable. If true, then the price can be set by the sender.
A description of this product.
An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.
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.
The label for the variants of this product, e.g. "Size" or "Color".
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.
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.
The name of the variant group, e.g. "Size" or "Color".
The name of the variant group option, e.g. "Small" for the "Size" variant group.
The hex color code for this option, e.g. "#000000", if any.
The minimum price of the product, in cents. Only used if price_is_variable is true.
The maximum price of the product, in cents. Only used if price_is_variable is true.
An array of attributes that describe this product.
The label for this attribute, e.g. "Materials".
The content for this attribute, e.g. "80% cotton, 20% elastane". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr.
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.
active, inactive 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.
curl --request GET \
--url https://api.ongoody.com/v1/products \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "358bfc9b-0749-4dbe-95ce-465891acd7fc",
"name": "Dozen Cookies",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 3,
"variants": [
{
"id": "924c85dd-a619-4304-ace6-8df4de3178cd",
"name": "Chocolate Chip",
"subtitle": "Classic chocolate chip.",
"image_large": null
},
{
"id": "6027c968-f8d5-4e78-9627-484293fb37fa",
"name": "Oatmeal",
"subtitle": "Delicious oatmeal.",
"image_large": null
},
{
"id": "812911ff-fb98-428b-8896-8be50859b92d",
"name": "Sugar",
"subtitle": "Tasty sugar.",
"image_large": null
}
],
"variant_groups": [],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [],
"updated_at": "2025-01-21T19:20:56Z",
"status": "active"
},
{
"id": "536cf1bf-a89a-47e3-b190-0e1283341788",
"name": "Cookie Box",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 1,
"variants": [
{
"id": "83541dd1-08cd-47f8-a65a-9ca08f32e419",
"name": "Grey / Chocolate Chip",
"subtitle": null,
"image_large": null
},
{
"id": "78ef7039-0698-43b3-9344-b53b7ef17cd8",
"name": "Grey / Oatmeal",
"subtitle": null,
"image_large": null
},
{
"id": "5199b096-1001-4b2b-89f8-770d646c2c07",
"name": "Grey / Sugar",
"subtitle": null,
"image_large": null
},
{
"id": "eed051b6-504b-4ef2-9e63-8d5effe3d743",
"name": "Purple / Chocolate Chip",
"subtitle": null,
"image_large": null
},
{
"id": "a26da78f-6cec-41b7-af5c-92b7d972cf47",
"name": "Purple / Oatmeal",
"subtitle": null,
"image_large": null
},
{
"id": "b6e4c4b6-3655-49bd-be49-fec20b4f56bf",
"name": "Purple / Sugar",
"subtitle": null,
"image_large": null
}
],
"variant_groups": [
{
"id": "59339914-df64-49e0-ad79-25e200287964",
"name": "Box Color",
"options": [
{
"id": "1d54578d-29de-40ee-a32a-9504a9c69a27",
"name": "Grey",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "a124d375-8278-49bb-9432-6c16ada3cdc9",
"name": "Purple",
"subtitle": null,
"color": null,
"image_large": null
}
]
},
{
"id": "7a3f1f3b-1670-48b6-af80-1d6c73b63ee1",
"name": "Flavor",
"options": [
{
"id": "dea76195-d04c-40de-b7ea-c9adeebb4522",
"name": "Chocolate Chip",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "eb2d73a1-9d39-4510-a79d-d817ced590bb",
"name": "Oatmeal",
"subtitle": null,
"color": null,
"image_large": null
},
{
"id": "3283d889-75b4-489f-a342-d51dfe127940",
"name": "Sugar",
"subtitle": null,
"color": null,
"image_large": null
}
]
}
],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [],
"updated_at": "2025-01-21T19:20:57Z",
"status": "active"
},
{
"id": "851b6cf6-bb6a-4f8d-9be1-26d88742e28d",
"name": "Six Cookies",
"brand": {
"id": "71690f1c-196c-45f7-97ea-6e2813db1365",
"name": "Cecilia Ziemann",
"shipping_price": 1000,
"free_shipping_minimum": null,
"brand_values": [
"Sustainable"
]
},
"subtitle": null,
"subtitle_short": null,
"recipient_description": "",
"variants_label": "option",
"variants_num_selectable": 3,
"variants": [
{
"id": "9f80ab26-e74c-44a1-b8d0-2e5972069d4e",
"name": "Chocolate Chip",
"subtitle": "Classic chocolate chip.",
"image_large": null
},
{
"id": "32dc57d3-3d15-431e-b4ff-9ac8d28ebc72",
"name": "Oatmeal",
"subtitle": "Delicious oatmeal.",
"image_large": null
},
{
"id": "8db9096e-03e4-476f-8bcd-3eb3c7201fd0",
"name": "Sugar",
"subtitle": "Tasty sugar.",
"image_large": null
}
],
"variant_groups": [],
"images": [],
"price": 1000,
"price_is_variable": false,
"restricted_states": [],
"attributes": [
{
"label": "Where it's made",
"content": "Made in Miami, FL"
}
],
"updated_at": "2025-01-21T19:20:57Z",
"status": "active"
}
],
"list_meta": {
"total_count": 3
}
}