API Admin › Referência
Referência da API Admin
Versão 2026-10. Todo endereço começa em https://api.denaryx.com/admin/2026-10 e leva o token da integração em Authorization: Bearer dnxa_... (ver Autenticação). Esta página sai da mesma especificação que a API serve em /openapi.json, sem token, para gerar clientes e importar em ferramentas.
A especificação OpenAPI
Importe num cliente HTTP para chamar a API com o seu token, ou gere um cliente na sua linguagem (ver Testar no Postman ou no Insomnia).
O token e a loja
| Rota | O que faz | Escopo |
|---|---|---|
GET /token | O token que faz a chamada | Qualquer token da loja |
GET /shop | A loja do token | Qualquer token da loja |
Temas
| Rota | O que faz | Escopo |
|---|---|---|
GET /themes | Os temas da biblioteca da loja | read_themes |
POST /themes | Acrescenta um tema à biblioteca | write_themes |
POST /themes/import | Cria um tema a partir de um zip | write_themes |
GET /themes/{id} | Um tema | read_themes |
PATCH /themes/{id} | Renomeia um tema | write_themes |
DELETE /themes/{id} | Exclui um tema | write_themes |
GET /themes/{id}/files | Os arquivos de um tema | read_themes |
PUT /themes/{id}/files | Grava arquivos de texto, tudo ou nada | write_themes |
GET /themes/{id}/files/content | O conteúdo de um arquivo | read_themes |
POST /themes/{id}/assets | Envia arquivos para assets/ | write_themes |
GET /themes/{id}/versions | As versões do código | read_themes |
POST /themes/{id}/versions | Guarda o código de agora como versão | write_themes |
POST /themes/{id}/versions/{version_id}/restore | Volta o código a uma versão | write_themes |
POST /themes/{id}/import | Troca os arquivos de um tema pelos de um zip | write_themes |
GET /themes/{id}/export | O zip do código de um tema | read_themes |
POST /themes/{id}/previews | Uma prévia do tema na vitrine | write_themes |
GET /themes/{id}/check | O que muda se o tema for publicado | read_themes |
POST /themes/{id}/publish | Publica o tema | publish_themes |
Produtos e variantes
| Rota | O que faz | Escopo |
|---|---|---|
GET /products | Os produtos da loja | read_products ou read_content |
POST /products | Cria um produto | write_products |
GET /products/count | Quantos produtos casam com os filtros | read_products ou read_content |
GET /products/{id} | Um produto | read_products ou read_content |
PATCH /products/{id} | Muda campos de um produto | write_products ou write_content |
DELETE /products/{id} | Exclui um produto | write_products |
POST /products/{id}/variants | Acrescenta uma variante | write_products |
PATCH /products/{id}/variants/{variant_id} | Muda campos de uma variante | write_products |
DELETE /products/{id}/variants/{variant_id} | Exclui uma variante | write_products |
GET /variants | As variantes da loja | read_products |
POST /products/{id}/images | Acrescenta uma foto | write_products |
PATCH /products/{id}/images/{image_id} | Muda o texto de uma foto | write_products ou write_content |
DELETE /products/{id}/images/{image_id} | Exclui uma foto | write_products |
GET /products/{id}/try_on | O provador virtual do produto | read_products |
PUT /products/{id}/try_on | Grava o provador virtual do produto | write_products |
DELETE /products/{id}/try_on | Tira o provador virtual do produto | write_products |
GET /products/{id}/variants/{variant_id}/try_on | O provador virtual da variante | read_products |
PUT /products/{id}/variants/{variant_id}/try_on | Grava o provador virtual da variante | write_products |
DELETE /products/{id}/variants/{variant_id}/try_on | Tira o provador virtual da variante | write_products |
Coleções e marcas
| Rota | O que faz | Escopo |
|---|---|---|
GET /collections | As coleções da loja | read_products ou read_content |
POST /collections | Cria uma coleção | write_products |
GET /collections/{id} | Uma coleção | read_products ou read_content |
PATCH /collections/{id} | Muda campos de uma coleção | write_products ou write_content |
DELETE /collections/{id} | Exclui uma coleção | write_products |
GET /brands | As marcas da loja | read_products ou read_content |
POST /brands | Cria uma marca | write_products |
GET /brands/{id} | Uma marca | read_products ou read_content |
PATCH /brands/{id} | Muda campos de uma marca | write_products ou write_content |
DELETE /brands/{id} | Exclui uma marca | write_products |
Montagens
| Rota | O que faz | Escopo |
|---|---|---|
GET /assemblies | As montagens da loja | read_products |
POST /assemblies | Cria uma montagem | write_products |
GET /assemblies/{id} | Uma montagem | read_products |
PATCH /assemblies/{id} | Muda campos de uma montagem | write_products |
DELETE /assemblies/{id} | Exclui uma montagem | write_products |
Páginas
| Rota | O que faz | Escopo |
|---|---|---|
GET /pages | As páginas da loja | read_content |
POST /pages | Cria uma página | write_content |
GET /pages/{id} | Uma página | read_content |
PATCH /pages/{id} | Muda campos de uma página | write_content |
Propostas
| Rota | O que faz | Escopo |
|---|---|---|
GET /proposals | As propostas desta integração | write_products ou write_content |
GET /proposals/{id} | Uma proposta | write_products ou write_content |
Estoque e preço
| Rota | O que faz | Escopo |
|---|---|---|
POST /inventory/adjust | Soma ao estoque, em lote | write_products |
POST /inventory/set | Grava o estoque, em lote | write_products |
POST /prices/set | Grava preços, em lote | write_products |
Pedidos
| Rota | O que faz | Escopo |
|---|---|---|
GET /orders | Os pedidos da loja | read_orders |
GET /orders/count | Quantos pedidos casam com os filtros | read_orders |
GET /orders/{id} | Um pedido | read_orders |
POST /orders/{id}/mark_paid | Marca o pedido como pago | write_orders |
POST /orders/{id}/prepare | Começa a separar o pedido | write_orders |
POST /orders/{id}/ship | Marca o pedido como enviado | write_orders |
POST /orders/{id}/deliver | Marca o pedido como entregue | write_orders |
POST /orders/{id}/cancel | Cancela o pedido | write_orders |
PUT /orders/{id}/invoice | Informa a nota fiscal do pedido | write_orders |
PUT /orders/{id}/line_items/{line_id}/prescription | Informa a receita de um item | write_orders |
POST /orders/{id}/line_items/{line_id}/prescription/check | Marca a receita de um item como conferida | write_orders |
Clientes
| Rota | O que faz | Escopo |
|---|---|---|
GET /customers | Os clientes da loja | read_customers |
GET /customers/{id} | Um cliente | read_customers |
Relatórios
| Rota | O que faz | Escopo |
|---|---|---|
GET /reports/sales | As vendas do período | read_reports |
GET /reports/searches | As buscas da vitrine no período | read_products ou read_content |
Eventos
| Rota | O que faz | Escopo |
|---|---|---|
GET /events | Os eventos da loja dos últimos 30 dias | read_products ou read_orders ou read_themes ou read_customers |
Webhooks
| Rota | O que faz | Escopo |
|---|---|---|
GET /webhooks | Os webhooks da integração | Qualquer token da loja |
POST /webhooks | Cadastra um webhook | Qualquer token da loja |
GET /webhooks/{id} | Um webhook | Qualquer token da loja |
PATCH /webhooks/{id} | Muda um webhook | Qualquer token da loja |
DELETE /webhooks/{id} | Exclui um webhook | Qualquer token da loja |
POST /webhooks/{id}/test | Envia um evento de teste | Qualquer token da loja |
Eventos dos webhooks
O POST que chega ao endereço do webhook, assinado. Ver Webhooks.