> ## 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.

# /cancelarBonusEcom

API para cancelar um bônus gerado pelo e-commerce.

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

```json JSON
{
    "num_pedido": "CRM-TESTE-001",
    "used_bonus": false
}
```

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Campo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **num\_pedido**
      </td>

      <td>
        Identificador do pedido. Parâmetro "ticket" enviado no /finaliza\_compra ou /baixa\_bonus.
      </td>
    </tr>

    <tr>
      <td>
        **used\_bonus**
      </td>

      <td>
        * \*true\*\*: Indica se está sendo feito aoenas um cancelamento da reserva do bônus através (/baixa\_bonus).
        * \*false\*\*: Cancelamento de um bônus que foi gerado (após o /finaliza\_compra), mas que ainda não foi usado.
      </td>
    </tr>
  </tbody>
</Table>

## Dicionário de Dados | Resposta

```json JSON
{
    "status": true,
    "message": "Sucesso: Bonus cancelado com sucesso."
}
```

| Campo       | Descrição                           |
| :---------- | :---------------------------------- |
| **message** | Mensagem de sucesso ou erro da API. |

# 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": {
    "/cancelarBonusEcom": {
      "post": {
        "summary": "/cancelarBonusEcom",
        "description": "API para cancelar um bônus gerado pelo e-commerce.",
        "operationId": "cancelarbonusecom",
        "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.",
            "required": true,
            "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": [
                  "num_pedido",
                  "used_bonus"
                ],
                "properties": {
                  "num_pedido": {
                    "type": "string",
                    "description": "Identificador do pedido. Parâmetro \"ticket\" enviado no /finaliza_compra ou /baixa_bonus.",
                    "default": "CRM-TESTE-001"
                  },
                  "used_bonus": {
                    "type": "boolean",
                    "description": "Indica se foi realizado a reserva do bônus através do endpoint /baixa_bonus. Obs: Esse parâmetro não é um indicativo se o bônus foi utilizado ou não, mas sim se ele foi reservado no endpoint /baixa_bonus",
                    "default": false
                  }
                }
              },
              "examples": {
                "JSON": {
                  "value": {
                    "num_pedido": "CRM-TESTE-001",
                    "used_bonus": false
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": true,\n    \"message\": \"Sucesso: Bonus cancelado com sucesso.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Sucesso: Bonus cancelado com sucesso."
                    }
                  }
                }
              }
            }
          }
        },
        "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
}
```