ListCollections1 - Bubblehouse API

Returns a list of all collections in the catalog.

Method	GET or POST
Kind	Read-Only
URL	`https://app.bubblehouse.com/api/v2023061/<shop>/ListCollections1`
Authentication	Shop Token

This API returns all active collections from your catalog. Deleted collections are automatically excluded from the results.

This API returns a JSON response by default, but that JSON could be huge. We recommend that you pick JSONL format via the format parameter.

Input

formatTabularDataFormat1optional
The response format you want: JSON, JSONL or CSV.

Output

JSON output format: the response is a JSON array of objects, each object having the following format.

JSONL output format: the response is a text file with one JSON object per line, each object having the following format.

CSV: the response is a CSV file with the following columns. (Column names correspond exactly to the JSON property names.)

You MUST ignore extra/undocumented properties, unless instructed otherwise by customer support. We can and will introduce new properties without notice, we can and will return extra undocumented properties, we can and will change undocumented properties without notice.

bhidbubbleflakerequired
Internal Bubblehouse ID of the collection
idstringrequired
ID of the collection in the ecommerce system
slugstringoptional
Secondary, URL-friendly identifier of the collection
titlestringrequired
The user-visible name of the collection
some_image_urlstringoptional
URL of an image representing the collection
created_attimeoptional
Time when the collection was added to the ecommerce system
updated_attimeoptional
Time when the collection was last updated in the ecommerce system
product_idsarray of stringoptional
A list of product IDs that belong to this collection

Specific Errors

Status	Error	Reason & Examples
None.

API-wide Errors

Status	Error	Reason & Examples
None.

Global Errors

Status	Error	Reason & Examples
401	invalid_token	The provided authentication token is invalid or has expired. `{"id":"invalid_token","message":"The token has expired"}`
429	rate_limit_exceeded	Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase. `{"id":"rate_limit_exceeded","message":"You are over the read limit per second for this customer"}`
400	obsolete_global_api_version	The global API version you are trying to use is no longer supported. `{"id":"obsolete_global_api_version"}`
400	invalid_global_api_version	The global API version you are trying to use has never existed. `{"id":"invalid_global_api_version"}`
400	inaccessible_global_api_version	The global API version you are trying to use is not enabled on your account. `{"id":"inaccessible_global_api_version"}`