Customers
Get customer loyalty points
The points balance of a customer, and their last 50 movements.
GET/stores/{storeId}/v1/customers/{id}/loyalty
A customer who never earned a point has a balance of 0 and no movements. points in a movement is positive when points are added and negative when they are removed. See Customers and loyalty.
Path parameters
- idstringrequired
Response
- dataobjectrequired
- customer_idstringrequired
- balanceintegerrequired
- The points balance now.
- lifetime_earnedintegerrequired
- lifetime_spentintegerrequired
- transactionsarray<object>required
- The last 50 movements, newest first.
- typestring
earnwelcomeadjustmentreservereleaserefundreversalexpire- pointsinteger
- Positive adds points, negative removes them.
- balance_afterinteger
- order_idstring | null
- reasonstring
- created_atstring (date-time)
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | The ID does not exist in this store. |
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
| 503 | APPS_SCOPE_RUNTIME_NOT_READY | The resource is not enabled on this merchant's store yet. |
Shared codes are listed in Errors.