Public
Documentation Settings

API Catalogo

Introdução

A API de integração de pedidos permite a edição e criação das configurações do catalogo da loja.

Token

A Autenticação das requisições é feita utilizando um token no Header gerado pelo painel do parceiro na plataforma (veja como fazer).

Error Codes

400 - Erro nas informações enviadas
429 - Limite de requisições excedido
401 - Autenticação falhou

Categories

Endpoints relacionados as categorias de itens

Capa

GETGet Categorie Cover

https://api.{{host}}/api/catalog/getcategoriecover?categoria_id=2092

Pega capa de uma categoria em específico.

Variáveis da capa

CampoDescrição
id_categoriaInt - id da categoria que a capa pertence
delivery_proprioInt - [0 - Não utilizar, 1 - Imagem, 2 - Cores]
delivery_proprio_infoString - Url ou cores utilizadas
HEADERS
Bearer

{{Token da loja}}

integrador-token

{{integrador-token}}

PARAMS
categoria_id

2092

POSTEdit Categorie Cover

https://api.{{host}}/api/catalog/editcategoriecover

Edita capa da categoria.

HEADERS
Bearer

{{Token da loja}}

integrador-token

{{integrador-token}}

Bodyraw
{
    "categoria_id": 2092,
    "atributos": {
        "delivery_proprio": 1
    }
}

GETGet Categorie

https://api.{{host}}/api/catalog/getcategorie?categoria_id=2092

Pega categoria com id específico.

Estrutura:

  • Categoria
    • Itens
      • Categoria de complementos
        • complementos

Variáveis da categoria

CampoDescrição
idInt - id da categoria
nomeString - Nome da categoria
ordemInt - Ordem em qual a categoria aparece na lista
statusBool - Informa se a categoria está disponível
descricaoString - Descrição da categoria
HEADERS
Bearer

{{Token da loja}}

integrador-token

{{integrador-token}}

PARAMS
categoria_id

2092

Loading