Order API
UpdateOrders4
Push new or updated orders for Bubblehouse to process.
| Method | POST |
|---|---|
| Kind | Write |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/UpdateOrders4 |
| Authentication | Shop Token |
This func will not return an error unless the incoming data is wildly syntactically incorrect. The actual processing may be delayed until a later time, and the errors might only be visible via error emails later. Use debug option to receive more errors immediately during development.
When pushing multiple orders, Bubblehouse will process all of them, even if some fail. This means that, if this function returns 200 OK or 4xx, you should not retry pushing the same orders. If the call results in 5xx or a network error, though, retry all of them. (It is always safe to push the same order multiple times; would be just like a no-op update.)
There is no separate deletion call, but you can delete orders by updating them with "deleted": true flag. For safety reasons, deletion is not normally enabled on ordinary API keys, talk to support if you want it. In most cases, though, you should rather use "status": "canceled".
Input
A list of orders to process.
debugbooleanoptionalTrue to make it easier to debug this call
Normally, we do not guarantee that updates are processed synchronously. We might do that, or we might return success from this function immediately and queue processing until a later time. Passing
"debug": trueensures that processing is immediate and synchronous, and will also fail the call on any warnings, making it easier to diagnose problems.Please ensure to never enable debug mode in production, or even during high-volume testing.
Output
A successful response has no meaningful properties and only contains an ok property always set to true:
{"ok": true}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"} |