For AI agents: visit https://developers.convertize.com.br/v2/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
| Campo | Requerido | Único | Tipo de campo | Max Caracteres | Descrição |
|---|
| id | | ✅ | Int4 | | ID da lista (somente leitura) |
| uuid | | ✅ | UUID | | Identificador público, gerado automaticamente (somente leitura) |
| title | ✅ | | Varchar | 500 | Título da lista |
| customer | ✅ | | Int4 | | ID do cliente dono da lista |
| type_list | | | Int4 | | ID do Tipo da Lista |
| reference_code | | | Varchar | 150 | Código de referência (integrações/ERP) |
| publish | | | Boolean | | Deixar a lista disponível no site (default false) |
| date | | | Date | | Data do evento (YYYY-MM-DD) |
| description | | | Text | 155 | Descrição da lista |
| image | | | Text | | URL da foto/imagem da lista |
| background | | | Text | | URL da imagem de capa |
| giftcard | | ✅ | Int4 | | Vale-presente vinculado, gerado automaticamente (somente leitura) |
| extra_fields | | | Array(Text) | | Valores dos campos extras do tipo de lista |
| seller | | | Int4 | | ID do vendedor |
| receive_gifts | | | Boolean | | Receber presentes em casa (default false) |
| shipping_zipcode | | | Varchar | 9 | CEP de entrega |
| shipping_address | | | Varchar | 100 | Endereço de entrega |
| shipping_number | | | Varchar | 100 | Número de entrega |
| shipping_neighborhood | | | Varchar | 100 | Bairro de entrega |
| shipping_complement | | | Varchar | 100 | Complemento de entrega |
| shipping_city | | | Varchar | 100 | Cidade de entrega |
| shipping_state | | | Varchar | 2 | Estado (UF) de entrega |
| shipping_phone | | | Varchar | 20 | Telefone de entrega |
| shipping_city_id | | | Varchar | 50 | Código do município |
| shipping_code_ibge | | | Varchar | 50 | Código IBGE |
| items | | | Array | | Itens desejados da lista — objeto GiftListItem (somente leitura) |
| fields_data | | | Array | | Campos extras resolvidos do tipo de lista (somente leitura) |
| totals | | | Object | | Totais agregados: quantity e received (somente leitura) |
| add_date | | | Date | | Data de criação (somente leitura) |
| change_date | | | Date | | Data de alteração (somente leitura) |