Preview order
Preview the order as if the given rewards were redeemed
curl --request PUT \
--url https://app.masivo.ai/api/storefront/v1/events/redeem/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"brand_id": "<string>",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
}'{
"data": {
"customer_id": "<string>",
"brand_id": "<string>",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The customer unique identifier in your system
The brand id of the order
The order to apply the rewards
The id of a placed order in your system
The order total or subtotal
20.95
The order total or subtotal after discounts
10.95
The product sku
The quantity of the product
The total or subtotal of the product
The total or subtotal of the product after discounts
Include your conditions event tags here
Include any additional info here
The result of the redemptions over the product
The rewards that have been redeemed
The reward id to redeem
The amount of the reward to redeem. (Per product if applicable)
1
The error message if the reward was not redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE The payment method used in the order
CREDIT, DEBIT, CASH, BANK_TRANSFER, OTHER The channel unique identifier in your system
The store unique identifier in your system
The shipping information of the order
The shipping cost
3.25
The shipping cost after discounts
2.25
Include your conditions event tags here
Include any additional info here
The result of the redemptions over the shipping
The rewards that have been redeemed
The reward id to redeem
The amount of the reward to redeem. (Per product if applicable)
1
The error message if the reward was not redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE The metadata of the order
The result of the redemptions over the order
The rewards that have been redeemed
The reward id to redeem
The amount of the reward to redeem. (Per product if applicable)
1
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 error message if the reward was not redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE Response
The customer unique identifier in your system
The brand id of the order
The order with the rewards applied
The id of a placed order in your system
The order total or subtotal
20.95
The order total or subtotal after discounts
10.95
The product sku
The quantity of the product
The total or subtotal of the product
The total or subtotal of the product after discounts
Include your conditions event tags here
Include any additional info here
The result of the redemptions over the product
The rewards that have been redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE The payment method used in the order
CREDIT, DEBIT, CASH, BANK_TRANSFER, OTHER The channel unique identifier in your system
The store unique identifier in your system
The shipping information of the order
The shipping cost
3.25
The shipping cost after discounts
2.25
Include your conditions event tags here
Include any additional info here
The result of the redemptions over the shipping
The rewards that have been redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE The metadata of the order
The result of the redemptions over the order
The rewards that have been redeemed
The reward id to redeem
The amount of the reward to redeem. (Per product if applicable)
1
The error message if the reward was not redeemed
The amount of the reward redeemed
The total discount reduced from the original value
The percentage of the total discount reduced from the original value
0 <= x <= 1The updated value of the item after the discount
The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item
UPDATE, READ, CREATE, REMOVE curl --request PUT \
--url https://app.masivo.ai/api/storefront/v1/events/redeem/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "<string>",
"brand_id": "<string>",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
}'{
"data": {
"customer_id": "<string>",
"brand_id": "<string>",
"order": {
"purchase_id": "<string>",
"channel_id": "<string>",
"store_id": "<string>",
"value": 20.95,
"discounted_value": 10.95,
"products": [
{
"sku": "<string>",
"amount": 123,
"value": 123,
"discounted_value": 123,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
],
"shipping": {
"value": 3.25,
"discounted_value": 2.25,
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"tags": {},
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
},
"payment_method": "CREDIT",
"redeem": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1
}
],
"metadata": {},
"redemptions_result": {
"redeemed": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"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
}
},
"error": "<string>"
}
],
"amount": 123,
"discount_value": 123,
"discount_percent": 0.5,
"value": 123,
"action": "UPDATE"
}
}
}
}