Analytics API
Read CallExportOrders1
Returns Bubblehouse-side loyalty facts for orders in a shop.
This call is deprecated. We strive to avoid churn and maintain backward compatibility indefinitely, so there is no rush to upgrade, but please use ListOrders3 in new code whenever possible.
| Kind | Read API call |
|---|---|
| Method | GET or POST |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/ExportOrders1 |
| Authentication | Shop Token |
This export returns loyalty facts known on the Bubblehouse side. Line items, paid amounts, and other commerce fields stay on the shop.
Compared with ListOrders3, this older contract uses bh_id, shop_id, and name instead of bhid, shopid, and short, and it does not include canceled or multiplier.
Rows are sorted by the updated cursor. The default sort is updated_desc.
Only orders that already have a non-zero update ID appear. Historical rows that were never filled into the update index, and orders whose update ID is still zero, are not returned.
Polling with updated_after follows the last saved update ID. An order that is later written without going through the order save path keeps its old update ID, so a cursor poll can miss that mutation. A full list still returns the current row.
Input
-
The response format you want: JSON or JSONL.
Use
jsonorjsonl. Do not use CSV with this method. -
prettyboolean optionalIf true, pretty-prints JSON output.
-
Sort order for the
updatedcursor.Supported values are
updated_descandupdated_asc. The default isupdated_desc. -
Only return rows with update IDs strictly greater than this value.
-
Only return rows with update IDs strictly smaller than this value.
-
limitinteger optionalThe number of rows to return.
When omitted, zero, or negative, this method streams every matching order. If you picked JSON, be careful when processing a potentially huge response.
Output
The output is in a tabular data format. The exact format is determined by the format input parameter.
JSON and JSONL nest customer as an object (or null for guest orders).
-
Unique ID of the order in the Bubblehouse system.
-
Order update/version ID used for polling.
-
shop_idstring required but can be emptyThe online shop's order ID.
-
namestring required but can be emptyThe short name assigned to the order by the online shop, if any.
-
When the order was placed, if known.
-
pts_earnedinteger requiredLoyalty points awarded for this order.
-
pts_redeemedinteger requiredPoints redeemed toward this order.
This is the sum of points used on the order. It is not the shop's order total.
-
redemption_discount_codesarray of string requiredCoupon codes used to redeem points on this order.
Always an array; empty when there are none. Sorted for a stable order.
-
customerobject optionalCompact customer view for the order, or null for guest orders.
JSON and JSONL emit a nested object with these keys only:
bhid,shopid,email,phone,first_name,last_name,deleted. Guest orders emit JSONnull.A missing, wrong-tenant, or GDPR-deleted customer still produces an object with
bhidanddeleted: true, and no PII. Absent PII keys are omitted.
Global Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 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. |