ListOrders2 - Bubblehouse API

Returns a list of orders processed by Bubblehouse.

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

Note that we expect you to get most order data from your online shop system. This API only returns the information only known on the Bubblehouse side.

The returned order records are sorted by Bubblehouse ID.

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.
after_idbubbleflakeoptional
The maximum order ID you have previously loaded, to only load records after that one.
chronobooleanoptional
If true, returns the results in a chronological order, starting with the earliest record matching all the criteria you specify. If false (the default), results are returned in a reverse chronological order, starting with the latest one.
after_idbubbleflakeoptional
The maximum order ID you have previously loaded, to only load records after that one.
If you set after_id but not before_id, you likely also want to set chrono to true, otherwise you'll simply get the latest orders recorded for the shop.
before_idbubbleflakeoptional
The minimum order ID you have previously loaded, to only load records before that one.
limitintegeroptional
The number of objects to return.
The default limit is 1000, but feel free to use any number here. You can set the limit to -1 or a very large number to disable it; Bubblehouse will be happy to stream the entire list of orders. If you picked the JSON output format, be careful when processing a potentially huge response this generates.

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.

idbubbleflakerequired
Unique ID of the order in the Bubblehouse system
shopidstringrequired
An online shop ID of the order.
shortstringrequired but can be empty
The short name assigned to the order by the online shop system, if any.
ptsintegerrequired
The number of loyalty points awarded for this order.
multiplierpermyriadrequired
The point multiplier in effect for this order.

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"}`