---
title: "Simulates a reward redemption for a specified order value."
method: POST
path: "/api/v1alpha1/rewards:simulate"
tags: ["RewardsService"]
---

# Simulates a reward redemption for a specified order value.

`POST /api/v1alpha1/rewards:simulate`

This endpoint is designed to simulate a reward redemption with a authentication laywer.

The response includes pertinent information about the simulation operation.

## Headers

- `Brand` string, required

## Request body

- V1alpha1SimulateRedemptionRequest
  - `customerId` string, required — The customer identifier must be the same as that sent to Dito.
  - `orderValue` string, required — Total value of the customer order.
  - `storeId` string — The store identifier must be the same as that sent to Dito.
  - `sellerId` string — The seller identifier must be the same as that sent to Dito.
  - `source` string — The source represents where the redemption request comes from (e.g., pdv, ecommerce, mobile).
  - `orderVoucher` string — The order voucher is the code of the voucher used in the order.
  - `sellerVoucher` string — The seller voucher is the code of the voucher used in the order.
  - `orderDiscount` string — The order discount is the total discount applied to the order.
  - `products` Cashbackapiv1alpha1Product[] — The products represents the details of the products included in the order.
    - `sku` string
    - `ean` string
    - `name` string
    - `quantity` integer, required
    - `categories` string[]
    - `grossUnitValue` string, required
    - `netUnitValue` string, required
    - `discountUnitValue` string, required
    - `extraInformation` object

## Response `200`

A successful response.

- V1alpha1SimulateRedemptionResponse
  - `cashbackTotalValue` string — Amount available for cashback on the order.
  - `rewards` V1alpha1SimulateRedemptionResponseReward[] — List of rewards used for cashback value.
    - `reward` Corev1alpha1Reward
      - `id` integer — ID of the reward.
      - `dueDate` string, date-time — Reward expiration date.
      - `value` string — Maximum amount to be redeemed for the reward.
      - `rate` integer — Maximum percentage of the purchase value that the reward value can be applied to.
      - `status` string — Informs the status of the reward. It can be available, locked, used, expired and undefined.
      - `availableAt` string, date-time — Reward available date.
      - `createdAt` string, date-time — Reward create date.
      - `balance` string — Balance available to be redeemed.
      - `canceledAt` string, date-time — Reward cancel date.
      - `extraInformation` V1alpha1ExtraInformation
        - `orderId` string — OrderID is the ID that identifies the purchase transaction that generated the reward.
        - `storeId` string — StoreID is the ID of the store where the purchase comes from.
    - `campaign` V1alpha1Campaign
      - `id` integer — ID of the campaign that generated the reward.
      - `name` string — Name of the campaign that generated the reward.
      - `description` string — Description of the campaign that generated the reward.
    - `cashbackValue` string — Reward value that is available for redemption based on consumption criteria.

## Other responses

- `400` — When an invalid request is sent.
- `401` — When the authentication is failed.
- `403` — when it was not authorized.
- `default` — An unexpected error response.

---

[API](https://skmtc.dev/dito/apis/authentication-api.md) · [All operations](https://skmtc.dev/dito/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dito/authentication-api/revisions/de4a5e2a412f/schema)