API ReferenceReward Grants
Issue an eligible reward grant
Evaluate one customer and issue a reward exactly once.
The customer and reward rule must belong to the selected store. A 201 response means the grant was created; a 200 response means the same customer already had that rule's grant. Ineligible customers receive a validation error.
AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
In: header
Header Parameters
X-STORE?string
Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/reward-grants" \ -H "X-STORE: launch-lab" \ -H "Content-Type: application/json" \ -d '{ "reward_rule_id": 10, "customer_id": 77 }'{
"data": {
"id": 0,
"reward_rule_id": 10,
"customer_id": 77,
"customer": {
"id": 0,
"email": "maya@example.com"
},
"granted_at": "2019-08-24T14:15:22Z",
"trigger_type": "PURCHASE_COUNT",
"trigger_value": 0,
"trigger_threshold": 0,
"outputs": [
{
"id": 0,
"type": "WALLET_CREDIT",
"payload": {},
"coupon_id": 0,
"wallet_ledger_entry_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z"
}
}{
"data": {
"id": 0,
"reward_rule_id": 10,
"customer_id": 77,
"customer": {
"id": 0,
"email": "maya@example.com"
},
"granted_at": "2019-08-24T14:15:22Z",
"trigger_type": "PURCHASE_COUNT",
"trigger_value": 0,
"trigger_threshold": 0,
"outputs": [
{
"id": 0,
"type": "WALLET_CREDIT",
"payload": {},
"coupon_id": 0,
"wallet_ledger_entry_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z"
}
}{
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request could not be understood.",
"status": 400,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#bad-request"
}{
"type": "authentication_error",
"code": "unauthenticated",
"message": "Unauthenticated.",
"status": 401,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}{
"type": "authorization_error",
"code": "forbidden",
"message": "This action is unauthorized.",
"status": 403,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#forbidden"
}{
"type": "validation_error",
"code": "validation_failed",
"message": "The selected product variant id is invalid.",
"status": 422,
"param": "product_variant_id",
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#validation-failed",
"errors": {
"product_variant_id": [
"The selected product variant id is invalid."
]
}
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too Many Attempts.",
"status": 429,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}{
"type": "api_error",
"code": "api_error",
"message": "Server Error",
"status": 500,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#api-error"
}