Reserve points for a checkout
Holds points while the customer completes checkout so they cannot be spent twice. Release them with points/release, or confirm them by calling transactions/create with the same order_id.
/{locale}/shop/points/reserveHolds points while the customer completes checkout so they cannot be spent twice. Release them with points/release, or confirm them by calling transactions/create with the same order_id.
Authorization
apiKey apiSecret Partner API key from the Partners Portal. Always sent together with X-API-Secret.
In: header
Partner API secret. Always sent together with X-API-Key.
In: header
Path Parameters
Locale code
Value in
- "lt"
- "en"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/lt/shop/points/reserve" \ -H "Content-Type: application/json" \ -d '{ "points": 50, "order_id": "ORD-2024-001" }'{ "success": true, "code": 200, "request_id": "550e8400-e29b-41d4-a716-446655440000", "message": "Success message", "data": {}}Release reserved points POST
Returns a held reservation to the customer's balance. Call this when checkout is abandoned or cancelled.
Register a purchase and award points POST
The main integration call. Records a purchase for a customer and awards loyalty points. Identify the customer by user_id or user_email. Points are calculated from order_total unless points is given explicitly. Use type=cancellation or refund to reverse an earlier transaction for the same order_id.