Order API
Read CallListProducts1
Returns a list of all products in the catalog.
| Kind | Read API call |
|---|---|
| Method | GET or POST |
| URL | https://app.bubblehouse.com/api/v20230601/<shop>/ListProducts1 |
| Authentication | Shop Token |
This API returns all active products from your catalog with their collection associations.
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
-
The response format you want: JSON, JSONL or CSV.
Output
-
Internal Bubblehouse ID of the product
-
idstring requiredID of the product in the ecommerce system
-
slugstring optionalSecondary, URL-friendly identifier of the product
-
titlestring requiredThe user-visible name of the product
-
inactiveboolean optionalWhether the product is unavailable
-
tagsarray of string optionalArbitrary tags associated with the product
-
Time when the product was added to the ecommerce system
-
Time when the product was last updated in the ecommerce system
-
collection_idsarray of string optionalA list of collection IDs the product belongs to
-
A list of variants the product has
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. |