ListCollections1

Returns a list of all collections in the catalog.

Kind	Read API call
Method	GET or POST
URL	https://app.bubblehouse.com/api/v20230601/<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

• format TabularDataFormat1 optional

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

Output

• bhid bubbleflake required

  Internal Bubblehouse ID of the collection

• id string required

  ID of the collection in the ecommerce system

• slug string optional

  Secondary, URL-friendly identifier of the collection

• title string required

  The user-visible name of the collection

• some_image_url string optional

  URL of an image representing the collection

• created_at time optional

  Time when the collection was added to the ecommerce system

• updated_at time optional

  Time when the collection was last updated in the ecommerce system

• product_ids array of string optional

  A list of product IDs that belong to this collection

Global Errors

Status	Error	Reason & Examples
400	obsolete_global_api_version	The global API version you are trying to use is no longer supported.
400	inaccessible_global_api_version	The global API version you are trying to use is not enabled on your account.
401	invalid_token	The provided authentication token is invalid or 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.
400	invalid_global_api_version	The global API version you are trying to use has never existed.