ListOrders2

Returns a list of orders processed by Bubblehouse.

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

Note that the output is in a tabular data format determined by the format parameter.

Input

• format TabularDataFormat1 optional

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

• after_id bubbleflake optional

  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.

• chrono boolean optional

  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.

• before_id bubbleflake optional

  The minimum order ID you have previously loaded, to only load records before that one.

• limit integer optional

  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

• bhid bubbleflake required

  Unique ID of the order in the Bubblehouse system

• shopid string required

  An online shop ID of the order.

• short string required but can be empty

  The short name assigned to the order by the online shop system, if any.

• pts integer required

  The number of loyalty points awarded for this order.

• multiplier permyriad required

  The point multiplier in effect for this order.

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.