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

# Obter cupom

> Obtenha os detalhes de um cupom específico.

**app\_id** `string` *required*

O ID da sua loja no Jelou Shop.

**coupon\_id** `string` *required*

ID do cupom.

```bash cURL theme={null}
curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/coupons/{coupon_id}?include=branches" \
  -H "x-api-key: YOUR_API_KEY"
```

```json 200 Success theme={null}
{
  "data": {
    "id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
    "code": "CENTRO20",
    "name": "Centro 20%",
    "description": "20% na filial Centro",
    "discount_type": "percentage",
    "discount_value": "20.000000",
    "status": true,
    "valid_from": null,
    "valid_until": null,
    "max_uses": null,
    "once_per_client": false,
    "applies_to_all_branches": false,
    "state": "active",
    "created_at": "2026-07-02T15:30:00.000000Z",
    "updated_at": "2026-07-02T15:30:00.000000Z",
    "branches": [
      {
        "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "name": "Filial Centro",
        "code": "SUC-CENTRO",
        "pivot": {
          "coupon_id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
          "branch_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "max_uses": 50,
          "status": true
        }
      }
    ]
  }
}
```

> [!NOTE]
>
> As filiais só aparecem se você solicitar a relação com `?include=branches`. O objeto `pivot` contém o `max_uses` e o `status` do cupom **para essa filial**.


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