> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assiny.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Offer

> Oferta, produto e order bumps envolvidos no evento

Informações referentes a oferta e produtos envolvidas no evento em questão. Entrada, upsell, downsell, orderbump...

Todas as informações referentes aos produtos e ofertas estão neste grupo.

```json Offer theme={null}
{
    //...
    "offer": {
        "id": "33a86ead-abcd-abcd-abcd-00af1c251add",
        "name": "Oferta interna de teste",
        "type": "ENTRY",
        "recurrence": null,
        "amount": 10000,
        "amount_client": 9412,
        "amount_assiny": 588,
        "amount_with_tax": 10000,
        "product": {
            "id": "b76d819b-abcd-abcd-abcd-31417189a2b4",
            "name": "Produto de teste interno",
            "producer_name": "Assiny"
        },
        "order_bumps": []
    }
    //...
}
```

| Nome | Tipo | Descrição |
| - | - | - |
| `id` | UUID | Id da oferta criada na Assiny |
| `name` | string | Nome da oferta criada na Assiny |
| `type` | string | Tipo da oferta na Assiny (ENTRY, UPSELL, DOWNSELL) |
| `recurrence` | string | Recorrencia em caso de oferta do tipo assinatura. Caso não seja uma assinatura, retornará "null". Valores possíveis: "MONTHLY" / mensal, "QUARTERLY" / trimestral, "SEMIANNUAL" / semestral, "YEARLY" / anual. |
| `amount` | integer | Valor da oferta configurado na Assiny |
| `amount_client` | integer | É o valor que foi para o produtor/vendedor |
| `amount_assiny` | integer | Valor da taxa da Assiny |
| `amount_with_tax` | integer | Valor da oferta com juros |
| `product.id` | UUID | Id do produto na Assiny |
| `product.name` | string | Nome do produto na Assiny |
| `product.producer_name` | string | Nome do produtor cadastrado no produto na Assiny |
| `order_bumps` | Array | Conjunto de produtos de orderbumps desta transação. Possui os mesmos campos do "offer" |

## Estrutura Order Bumps

É um grupo (Array) de produtos (objetos) com todos os dados do produto

```json Order bumps theme={null}
{
  //...
  "offer":{
    //...
    "order_bumps": [
        {
          "amount_assiny": 582,
          "amount_client": 9555,
          "amount_with_tax": 10137,
          "checkout_type": "ORDERBUMP",
          "id": "3e9fc781-abcd-abcd-abcd-c40cc7702423",
          "installments": 1,
          "name": "Nome da oferta teste",
          "payment_type": "TRANSACTION",
          "product": {
            "id": "60433c19-abcd-abcd-abcd-c213e21b6ba5",
            "name": "Nome do produto",
            "producer_name": "Assiny"
          },
          "product_price": 9700,
          "recurrence": null,
          "type": "TRANSACTION"
        }
    ]
    //...
  }
  //...
}
```

| Nome | Tipo | Descrição |
| - | - | - |
| `id` | UUID | Id da oferta criada na Assiny |
| `name` | string | Nome da oferta criada na Assiny |
| `type` e `payment_type` | string | Tipo de pagamento - Se é assinatura ou pagamento único (SUBSCRIPTION/TRANSACTION) |
| `checkout_type` | string | Se refere ao tipo da oferta - neste caso sempre será ORDERBUMP |
| `recurrence` | string | Recorrencia em caso de oferta do tipo assinatura. Caso não seja uma assinatura, retornará "null" |
| `product_price` | integer | Valor da oferta configurado na Assiny. É o equivalente ao `amount` no payload anterior. |
| `amount_client` | integer | É o valor que foi para o produtor/vendedor |
| `amount_assiny` | integer | Valor da taxa da Assiny |
| `amount_with_tax` | integer | Valor da oferta com juros |
| `product.id` | string | Id do produto na Assiny |
| `product.name` | string | Nome do produto na Assiny |
| `product.producer_name` | string | Nome do produtor cadastrado no produto na Assiny |

<CardGroup cols={2}>
  <Card title="Transaction" icon="receipt" href="/webhooks/estrutura/transaction">
    Valores, taxas, parcelas e status da transação.
  </Card>

  <Card title="Tabela completa" icon="table-list" href="/webhooks/estrutura-dos-dados">
    Todos os campos do payload em uma página.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.