Use Token Code API
Redeem token codes to apply discounts or receive benefits
Use Token Code API
Redeem token codes to apply discounts or receive special benefits. Token codes are single-use and become inactive after redemption.
Redeem Tokens
Apply token benefits.
Get Discounts
Receive percentage off.
Single Use
One-time redemption.
Endpoint Overview
/graphqlRedeem a token code to apply its associated discount or benefit. The token is marked as used after successful redemption.
Request Parameters
codeString!RequiredThe token code to redeem.
GraphQL Mutation
mutation useTokenCode($code: String!) {
useTokenCode(code: $code) {
id
userId
tokenCode
discountRate
isActive
usedTimestamp
createdAt
}
}Variables:
{
"code": "TKN-ABCD-1234-EFGH"
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"query": "mutation useTokenCode($code: String!) { useTokenCode(code: $code) { id tokenCode discountRate isActive usedTimestamp } }",
"variables": {
"code": "TKN-ABCD-1234-EFGH"
}
}'Response
{
"data": {
"useTokenCode": {
"id": "token_456",
"userId": "12345",
"tokenCode": "TKN-ABCD-1234-EFGH",
"discountRate": 25,
"isActive": false,
"usedTimestamp": "2024-01-15T14:30:00Z",
"createdAt": "2024-01-10T10:00:00Z"
}
}
}{
"errors": [
{
"message": "Token code has already been used",
"path": ["useTokenCode"],
"extensions": {
"code": "ALREADY_USED",
"usedAt": "2024-01-15T14:30:00Z"
}
}
],
"data": null
}{
"errors": [
{
"message": "Token code has expired",
"path": ["useTokenCode"],
"extensions": {
"code": "EXPIRED",
"expiredAt": "2024-01-14T00:00:00Z"
}
}
],
"data": null
}{
"errors": [
{
"message": "Token code belongs to a different user",
"path": ["useTokenCode"],
"extensions": {
"code": "USER_MISMATCH"
}
}
],
"data": null
}Redemption Flow
Verify Token
Confirm Details
Redeem Token
Apply Discount
Error Handling
Not Found
Token code doesn't exist in system.
Already Used
Token was previously redeemed.
Expired
Token validity period has ended.
Wrong User
Token assigned to different user.
Best Practices
Validate First
Always check token before using.
Handle Errors
Show clear messages for failures.
Confirm Success
Display confirmation to user.
Show Discount
Display applied discount amount.
Related Endpoints
One-Time Use
Token codes can only be redeemed once. After successful use, the code becomes permanently inactive.
Need a Token Code?
Contact support to receive a discount token for your account.