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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Zipcode

> Formulário de cálculo de frete por CEP com exibição das opções de entrega disponíveis.

Exibe um campo de entrada de CEP e, após a consulta, lista as opções de frete disponíveis para o produto atual. O CEP informado é salvo na sessão do usuário.

## Uso

```vue theme={"system"}
<Zipcode :quantity="quantity" />
```

Com seletor de quantidade desabilitado:

```vue theme={"system"}
<Zipcode :quantity="1" :disabled="true" />
```

## Propriedades

| Propriedade |    Tipo   | Obrigatória | Valor padrão | Descrição                                                      |
| :---------- | :-------: | :---------: | :----------: | :------------------------------------------------------------- |
| `quantity`  |  `Number` |      ❌      |      `1`     | Quantidade do produto para o cálculo do frete.                 |
| `disabled`  | `Boolean` |      ❌      |    `false`   | Quando `true`, desabilita o campo de CEP e o botão de cálculo. |

## Comportamentos automáticos

* **CEP salvo:** o CEP informado é persistido na sessão e preenchido automaticamente em visitas futuras.
* **Modal de CEP:** exibe um modal para consulta de CEP quando o usuário não sabe o código.