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

# /baixa_bonus

API responsável por reservar os bônus que serão utilizados.

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

```c JSON
{
    "loja_id": 100164,
    "user_id":27056298,
    "valor_bruto": 500.50,
    "bonus_resgatado": 125.50,	
    "ids_bonus": "136473650,136473651",
    "ticket": "CRM-TESTE-001"
}
```

| Campo                | Descrição                                             |
| :------------------- | :---------------------------------------------------- |
| **loja\_id**         | ID da loja na CRMBonus.                               |
| **user\_id**         | ID do cliente na CRMBonus.                            |
| **valor\_bruto**     | Valor da compra antes da aplicação do saldo de bônus. |
| **bonus\_resgatado** | Valor de bônus que será utilizado nessa compra.       |
| **ticket**           | Identificador da compra ou pedido no sistema.         |

## Dicionário de Dados | Resposta

```json json
{
    "status": true,
    "data": {
        "title": "Sucesso!",
        "message": "Foi dada a baixa nos bônus utilizados."
    }
}
```

| 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": {
    "/baixa_bonus": {
      "post": {
        "summary": "/baixa_bonus",
        "description": "API responsável por reservar os bônus que serão utilizados.",
        "operationId": "baixa_bonus",
        "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": [
                  "loja_id",
                  "user_id",
                  "valor_bruto",
                  "bonus_resgatado",
                  "ticket"
                ],
                "properties": {
                  "loja_id": {
                    "type": "integer",
                    "description": "ID da loja na CRMBonus.",
                    "default": 100164,
                    "format": "int32"
                  },
                  "user_id": {
                    "type": "integer",
                    "description": "ID do cliente na CRMBonus.",
                    "default": 27056298,
                    "format": "int32"
                  },
                  "valor_bruto": {
                    "type": "number",
                    "description": "Valor da compra antes da aplicação do saldo de bônus.",
                    "default": 500.5,
                    "format": "float"
                  },
                  "bonus_resgatado": {
                    "type": "number",
                    "description": "Valor de bônus que será utilizado nessa compra.",
                    "default": 125.5,
                    "format": "float"
                  },
                  "ticket": {
                    "type": "string",
                    "description": "Identificador da compra ou pedido no sistema.",
                    "default": "CRM-TESTE-001"
                  },
                  "ids_bonus": {
                    "type": "string",
                    "description": "Ids dos bônus que estão sendo reservados",
                    "default": "\"136473650,136473651\""
                  }
                }
              },
              "examples": {
                "JSON": {
                  "value": {
                    "loja_id": 100164,
                    "user_id": 27056298,
                    "valor_bruto": 500.5,
                    "bonus_resgatado": 125.5,
                    "ids_bonus": "136473650,136473651",
                    "ticket": "CRM-TESTE-001"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": true,\n    \"data\": {\n        \"title\": \"Sucesso!\",\n        \"message\": \"Foi dada a baixa nos bônus utilizados.\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string",
                          "example": "Sucesso!"
                        },
                        "message": {
                          "type": "string",
                          "example": "Foi dada a baixa nos bônus utilizados."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "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
}
```