Informações sobre o endpoint de convênios
INFO
/
Campos:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| code | varchar | Sim | Identificador único do convênio |
| token | varchar | Sim | Token do convênio |
| name | varchar | Sim | Nome do convênio que será exibido na loja |
| description | text | Não | Descrição do convênio |
| logo | text | Não | Url para download da imagem de logo do convênio |
| phone | varchar | Não | Telefone para contato |
| automatic_freight | integer | Não | Flag que indica se o convênio terá frete automático, deve ser enviado "1" para Sim e "0" para Não |
| automatic_freight_option | varchar | Não | Opção a ser utilizada pelo frete automático, valores permitidos: "rapido", "barato" |
| active | integer | Sim | Define se o convênio está ativo ou inativo. (0 = Inativo e 1 = Ativo) |
| payment | array | N/A | Node onde serão enviados os dados de pagamento do convênio |
| delivery_method | array | N/A | Node onde serão enviados os dados das forma de entrega do convênio |
| categories | array | N/A | Node onde serão enviadas a estrutura de categorias do convênio |
Campos node payment
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| discount_percent | decimal | Sim | Percentual de desconto |
| discount_all_items_percent | decimal | Sim | Percentual de desconto para todos os itens |
| comission_percent | decimal | Sim | Percentual de comissão |
| min_installment | decimal | Sim | Valor minimo para parcela |
Campos node delivery_method
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| enable_institution_delivery | integer | Sim | Permite entrega pela instituição (0 ou 1) |
| enable_exclusive_institution_delivery | integer | Sim | Permite entrega exclusivamente pela instituição (0 ou 1) |
| shipping_description | text | Não | Descrição da forma de entrega |
| shipping_value | decimal | Sim | Valor da entrega |
| delivery_time | integer | Sim | Tempo em dias da entrega |
| free_shipping_minimum_value | decimal | Sim | Valor minimo para entrega grátis |
| freight_code | varchar | Não | Código da forma de frete |
| zipcode | varchar | Sim | CEP |
| street | varchar | Sim | Logradouro |
| number | varchar | Sim | Número |
| complement | varchar | Sim | Complemento |
| neighborhood | varchar | Sim | Bairro |
| city | varchar | Sim | Cidade |
| state | varchar | Sim | Estado (UF) |
| country | varchar | Sim | País |
Campos node categories
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| code | decimal | Sim | Código identificador da categoria |
| parent_code | decimal | Sim | Código identificador da categoria pai |
| name | decimal | Sim | Nome da categoria |
| token | decimal | Sim | Token da categoria |
| start_date | date | Não | Data de inicio (formato: AAAA-MM-DD) |
| end_date | date | Não | Data do encerramento (formato: AAAA-MM-DD) |
| products | array | N/A | Node para o envio dos dados dos produtos relacionados ao convênio |
Campos node products dentro do node categories
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| product_code | varchar | Sim | Código identificador do produto |
| quantity | integer | Sim | Quantidade do produto para esta categoria |
| discount_percent | decimal | Sim | Desconto do produto para esta categoria |
| product_value | decimal | Não | Caso informado, sera utilizado o valor informado no lugar do valor do produto para o convênio |
Requisição
Nenhum
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request INFO '/'Response Response Example
{}Modificado em 2025-07-07 14:44:01