> ## Documentation Index
> Fetch the complete documentation index at: https://crmbonus-api.readme.io/llms.txt
> Use this file to discover all available pages before exploring further.

# /bonus/execute

Endpoint para resgate e/ou geração de bônus

## Dicionário de Dados | Requisição

```json
{
    "user": {
        "phone": "11999864382",
        "name": "Ned Nix",
        "email": "ned.nix@crmbonus.com",
        "cpf": "07656553304"
    },
    "gross_value": 200,
    "generated_bonus": {
        "expiration_date_start": "2022-01-01T00:00:00",
        "expiration_date_end": "2022-01-01T00:00:00",
        "value": 50
    },
    "redeemed_bonus": {
        "bonus_ids": ["9873432", "2373134"],
        "value": 10
    },
    "internal_order_id": "60a3f6dc-01d4-4da5-81de-b43acb067504"
}
```

| Campo                   | Descrição                                             |
| :---------------------- | :---------------------------------------------------- |
| **user**                | Dados do cliente (Nome, Celular E-mail, Cpf).         |
| **gross\_value**        | Valor da compra antes da aplicação do saldo de bônus. |
| **generated\_bonus**    | Dados para geração do bônus.                          |
| **redeemed\_bonus**     | Dados para resgate do bônus.                          |
| **internal\_order\_id** | Identificador da compra ou pedido no sistema.         |

## Dicionário de Dados | Resposta

```json JSON
{
  "status": true,
  "message": "Successfully generated bonus",
  "data": {
    "bonus_id": "6m6AU/VuGMZablszkpr8/w==",
    "order_id": "N1zy1v2v+p4BdT/TyHCRAg=="
  }
}
```

| Campo         | Descrição                                              |
| :------------ | :----------------------------------------------------- |
| **bonus\_id** | ID do bônus gerado a partir deste pedido;              |
| **order\_id** | ID do pedido gerado na CRMBonus a partir deste pedido. |

> 📘 Observação
>
> A requisição deve conter os dados de **"generated\_bonus" e/ou "redeemed\_bonus"**

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-e-commerce-v2",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://giftback-sandbox.crmbonus.com/apiEcommerce"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/bonus/execute": {
      "post": {
        "summary": "/bonus/execute",
        "description": "Endpoint para resgate e/ou geração de bônus",
        "operationId": "bonus_execute",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Token de autenticação.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "base64"
            }
          },
          {
            "name": "CodEmpresa",
            "in": "header",
            "description": "Código da empresa enviado pela CRMBonus.",
            "schema": {
              "type": "string",
              "default": "base64"
            }
          },
          {
            "name": "Content-Type",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          },
          {
            "name": "System-Name",
            "in": "header",
            "description": "Nome do sistema que está realizando a requisição.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "{systemName}"
            }
          },
          {
            "name": "User-Agent",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "user",
                  "gross_value",
                  "internal_order_id"
                ],
                "properties": {
                  "user": {
                    "type": "object",
                    "description": "Dados do cliente",
                    "required": [
                      "phone"
                    ],
                    "properties": {
                      "phone": {
                        "type": "string",
                        "description": "Celular do cliente sem máscara Exemplos: 11999998888",
                        "default": "11999998888"
                      },
                      "name": {
                        "type": "string",
                        "description": "Nome do cliente",
                        "default": "Ned Nix"
                      },
                      "email": {
                        "type": "string",
                        "description": "Email do cliente",
                        "default": "ned.nix@teste.com"
                      },
                      "cpf": {
                        "type": "string",
                        "description": "CPF do cliente sem máscara. Exemplo: 49594126078",
                        "default": "49594126078"
                      }
                    }
                  },
                  "gross_value": {
                    "type": "number",
                    "description": "Valor da compra antes da aplicação do saldo de bônus.",
                    "default": 500.5,
                    "format": "float"
                  },
                  "generated_bonus": {
                    "type": "object",
                    "description": "Dados para geração do bônus",
                    "properties": {
                      "expiration_date_start": {
                        "type": "string",
                        "description": "Data inicial de validade inicial do bônus. Exemplo: \"2025-01-01T00:00:00\"",
                        "default": "2025-01-01T00:00:00"
                      },
                      "expiration_date_end": {
                        "type": "string",
                        "description": "Data inicial de validade final do bônus. Exemplo: \"2025-01-01T00:00:00\"",
                        "default": "2025-02-01T00:00:00"
                      },
                      "value": {
                        "type": "number",
                        "description": "Valor do bônus gerado",
                        "default": 100.5,
                        "format": "float"
                      }
                    }
                  },
                  "redeemed_bonus": {
                    "type": "object",
                    "description": "Dados para resgate do bônus",
                    "properties": {
                      "bonus_ids": {
                        "type": "array",
                        "description": "Ids dos bônus que estão sendo resgatados",
                        "items": {
                          "type": "string"
                        }
                      },
                      "value": {
                        "type": "number",
                        "description": "Valor dos bônus que estão sendo resgatadois",
                        "default": 50.1,
                        "format": "float"
                      }
                    }
                  },
                  "internal_order_id": {
                    "type": "string",
                    "description": "Identificador da compra ou pedido no sistema."
                  }
                }
              },
              "examples": {
                "JSON": {
                  "value": {
                    "user": {
                      "phone": "11999864382",
                      "name": "Ned Nix",
                      "email": "ned.nix@crmbonus.com",
                      "cpf": "07656553304"
                    },
                    "gross_value": 200,
                    "generated_bonus": {
                      "expiration_date_start": "2022-01-01T00:00:00",
                      "expiration_date_end": "2022-01-01T00:00:00",
                      "value": 50
                    },
                    "redeemed_bonus": {
                      "bonus_ids": [
                        "9873432",
                        "2373134"
                      ],
                      "value": 10
                    },
                    "internal_order_id": "60a3f6dc-01d4-4da5-81de-b43acb067504"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": true,\n    \"message\": \"sucesso\",\n    \"data\": {\n        \"bonus_id\": 136473654,\n        \"order_id\": 129898024,\n        \"ticket\": \"CRM-TESTE-001\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "sucesso"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "bonus_id": {
                          "type": "integer",
                          "example": 136473654,
                          "default": 0
                        },
                        "order_id": {
                          "type": "integer",
                          "example": 129898024,
                          "default": 0
                        },
                        "ticket": {
                          "type": "string",
                          "example": "CRM-TESTE-001"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Código fornecido pelo T.I. do CRM&Bônus;"
      },
      {
        "key": "CodEmpresa",
        "value": "Código fornecido pelo T.I. do CRM&Bônus;"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```