Redeem coupon
Redeem a coupon code
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/coupons/redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"code": "<string>",
"brand_id": "<string>",
"store_id": "<string>",
"channel_id": "<string>"
}'{
"data": {
"customer": {
"id": "<string>",
"status": "ACTIVE",
"name": "John Smith",
"email": "jsmith@example.com",
"gender": "MALE",
"dob": "2023-11-07T05:31:56Z",
"registration_date": "2023-11-07T05:31:56Z",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metrics": {},
"metadata": {}
},
"wallet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"totals": [
{
"total": 127.6,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration_date": "2023-11-07T05:31:56Z",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
}
}
]
},
"accumulations": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"redemptions": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The customer unique identifier in your system
The coupon code to redeem
The id of the brand offering the rewards
The id of the store where the coupon was redeemed
The id of the channel where the coupon was redeemed
Response
The updated customer and wallet
Your customer unique identifier
The full name of the customer
"John Smith"
The email of the customer
The date when the customer was registered
The status of the customer
ACTIVE, INACTIVE The gender of the customer
MALE, FEMALE The date of birth of the customer
The id of the tier the customer currently belongs to
The metrics of the customer
The metadata of the customer
The wallet internal unique identifier
The customer internal unique identifier
Each line represents a batch of a given reward_id that expires at the same time
The amount of the line
The reward id of the line
The campaign id of the line
The id of the brand that originated the line
The date when the line was issued
The expiration date of the line
The reservation expiration date of the line
The wallet totals by reward
The total amount of the reward
127.6
The reward id of the total
The expiration date of the total
The reward internal unique identifier
The brand id of the reward, null if is a global reward
The name of the reward
The description of the reward
The type of the reward
POINTS, DISCOUNT, GIFT_CARD, PRODUCT OR conditions
AND conditions
The attributes of the reward
The amount of the line
The reward id of the line
The campaign id of the line
The id of the brand that originated the line
The date when the line was issued
The expiration date of the line
The reservation expiration date of the line
The amount of the line
The reward id of the line
The campaign id of the line
The id of the brand that originated the line
The date when the line was issued
The expiration date of the line
The reservation expiration date of the line
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/coupons/redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"code": "<string>",
"brand_id": "<string>",
"store_id": "<string>",
"channel_id": "<string>"
}'{
"data": {
"customer": {
"id": "<string>",
"status": "ACTIVE",
"name": "John Smith",
"email": "jsmith@example.com",
"gender": "MALE",
"dob": "2023-11-07T05:31:56Z",
"registration_date": "2023-11-07T05:31:56Z",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metrics": {},
"metadata": {}
},
"wallet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"totals": [
{
"total": 127.6,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration_date": "2023-11-07T05:31:56Z",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
}
}
]
},
"accumulations": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"redemptions": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
]
}
}