Loyalty API
QueryOrderDetails1
Retrieves loyalty point details for an existing order by ID.
| Method | GET or POST |
|---|---|
| Kind | Read-Only |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/QueryOrderDetails1 |
| Authentication | AnonymousCustomer TokenShop Token |
This function allows you to get detailed information about points earned for an existing order. It returns the same data structure as EstimateAccrual1, but works with placed orders using their order ID instead of requiring an Order2 object.
This is useful for displaying point earning details to customers after an order has been placed.
Input
order_idstringrequiredThe ID of the existing order to retrieve point details for.
Output
ptsintegerrequiredThe number of points earned for this order.
Detailed breakdown of point calculations for each order line item.
Each line item includes information about the subtotal, accrual amount, points, and any applicable multipliers or discounts.
accrual_debug_infostringrequiredDebug information about how the points were calculated.
This is intended for development and troubleshooting, not for displaying to end users.
Specific Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 404 | {} |
API-wide Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 400 | missing_customer_identity | The customer identity ('customer' input parameter) has not been specified when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token. {"id":"missing_customer_identity"} |
| 404 | empty_customer_identity | All fields of the customer identity ('customer' input parameter) have been empty when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token. {"id":"empty_customer_identity"} |
| 404 | no_customers_match_customer_identity | The customer identity ('customer' input parameter) does not match a known customer. {"id":"no_customers_match_customer_identity"} |
| 404 | customer_identity_partially_mismatches_matched_customer | A customer has been matched by one of the fields of the customer identity ('customer' input parameter), but some non-empty fields do not match Bubblehouse data on that customer. {"id":"customer_identity_partially_mismatches_matched_customer"} |
| 403 | customer_identity_does_not_match_token | API call is using a customer token, but the customer identity in API params does not match the customer from the token. {"id":"customer_identity_does_not_match_token"} |
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"} |