Order Batches
Payment Methods
Commerce User Payment Methods
Workspaces
Schemas
List all collections
curl --request GET \
--url https://api.ongoody.com/v1/collections \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "d9cbc0f6-e39d-4868-9db2-4b2c0fabe452",
"workspace_id": "ad9b8983-8c02-4384-aa78-579026b66fc0",
"title": "Maximize Value Added Experiences",
"is_published": false,
"published_price": null,
"product": null,
"published_version": null
},
{
"id": "dbeba216-7e87-442d-917c-b34b0ac6d5bc",
"workspace_id": "ad9b8983-8c02-4384-aa78-579026b66fc0",
"title": "Office Favorites",
"is_published": true,
"published_price": null,
"product": null,
"published_version": {
"id": "d2324d4a-32d7-4d54-bb2f-6b6ee01600ca",
"title": "Office Favorites",
"subtitle": "Curated treats for the whole team",
"multiple_select_mode": "disabled",
"multiple_select_count": null,
"multiple_select_price": null,
"international_shipping_tier": "standard",
"international_gift_cards_enabled": false,
"header_image": null
}
}
],
"list_meta": {
"total_count": 2
}
}?published=true.Authorizations
Your Goody API key.
Query Parameters
Page number for pagination (starts at 1)
x >= 1Number of collections to return per page (maximum 100)
1 <= x <= 100Return only published collections when true
Response
Collections retrieved successfully
Show child attributes
Show child attributes
Workspace that owns this collection.
Indicates whether the collection currently has a published version.
Price for the published collection in cents, including shipping.
The product that represents the collection when published. Null for unpublished collections. To send this collection, send the product ID in the cart
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
The US states that this product cannot be shipped to.
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.
Show child attributes
Show child attributes
The name of the variant group, e.g. "Size" or "Color".
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Details about the published version of this collection. Null for unpublished collections.
Show child attributes
Show child attributes
Controls how many items recipients can select from the collection.
disabled, item_count, max_price Shipping tier applied to the collection (e.g. standard, full).
Whether international gift cards are available when swapping products.
When multiple_select_mode is item_count, the number of items recipients may choose.
When multiple_select_mode is max_price, the spending limit in cents.
Categories and their products included in this version, ordered by position.
Show child attributes
Show child attributes
Whether this category is considered the "featured" category.
Products assigned to this category in their display order.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
The US states that this product cannot be shipped to.
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.
Show child attributes
Show child attributes
The name of the variant group, e.g. "Size" or "Color".
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
For approved API partners only.
Show child attributes
Show child attributes
For approved API partners only. A custom price tier for this product.
curl --request GET \
--url https://api.ongoody.com/v1/collections \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "d9cbc0f6-e39d-4868-9db2-4b2c0fabe452",
"workspace_id": "ad9b8983-8c02-4384-aa78-579026b66fc0",
"title": "Maximize Value Added Experiences",
"is_published": false,
"published_price": null,
"product": null,
"published_version": null
},
{
"id": "dbeba216-7e87-442d-917c-b34b0ac6d5bc",
"workspace_id": "ad9b8983-8c02-4384-aa78-579026b66fc0",
"title": "Office Favorites",
"is_published": true,
"published_price": null,
"product": null,
"published_version": {
"id": "d2324d4a-32d7-4d54-bb2f-6b6ee01600ca",
"title": "Office Favorites",
"subtitle": "Curated treats for the whole team",
"multiple_select_mode": "disabled",
"multiple_select_count": null,
"multiple_select_price": null,
"international_shipping_tier": "standard",
"international_gift_cards_enabled": false,
"header_image": null
}
}
],
"list_meta": {
"total_count": 2
}
}