Endpoints

As rotas abaixo são relativas à base do serviço de integração do seu ambiente — referida nos exemplos como $GROCERS_API. Veja Credenciais e ambientes.

Salvo indicação em contrário, toda rota exige:


Authorization: Basic <base64(clientId:clientSecret)>
x-contractAccountId: <GUID do tenant>

Quatro rotas são exceção e não exigem Authorization:

Método	Rota	Por quê
`GET`	`/v1/Health`	monitoração
`GET`	`/v1/Health/ready`	monitoração
`GET`	`/v1/batch/Warehouses/stock`	consulta do estoque publicado
`POST`	`/v1/Webhooks/process-event`	reprocessamento operacional

As duas últimas continuam precisando de x-contractAccountId para saber de qual tenant é o dado; as de health não precisam de header nenhum.

Catálogo

Método	Rota	O que faz
`POST`	`/v1/batch/Brands`	cria ou atualiza marcas
`DELETE`	`/v1/batch/Brands`	remove marcas por `externalReference`
`POST`	`/v1/batch/Categories`	cria ou atualiza categorias (aceita árvore)
`DELETE`	`/v1/batch/Categories`	remove categorias
`POST`	`/v1/batch/Products`	cria ou atualiza produtos com seus SKUs
`GET`	`/v1/batch/Products/{externalReference}`	consulta um produto

Estoque

Método	Rota	O que faz
`POST`	`/v1/batch/Warehouses`	cria warehouses
`DELETE`	`/v1/batch/Warehouses`	remove warehouses
`POST`	`/v1/batch/Warehouses/sku`	publica estoque por SKU
`DELETE`	`/v1/batch/Warehouses/sku`	remove estoque
`GET`	`/v1/batch/Warehouses/stock?warehouseExternalReference=`	consulta o estoque publicado

Preços

Método	Rota	O que faz
`POST`	`/v1/batch/Pricing`	publica preços por SKU e política
`DELETE`	`/v1/batch/Pricing`	remove preços

Pedidos

Método	Rota	O que faz
`GET`	`/v1/Orders/{orderNumber}/status`	status atual
`PATCH`	`/v1/Orders/{orderNumber}/status`	atualiza status
`PUT`	`/v1/Orders/{orderNumber}`	altera itens e valor final — síncrona: o resultado vem no corpo da resposta, não por webhook
`POST`	`/v1/Orders/{orderNumber}/cancel`	cancela
`PUT`	`/v1/Orders/invoiced/{orderNumber}`	registra nota fiscal
`GET`	`/v1/Orders/by-date?date=`	pedidos de um dia
`GET`	`/v1/Orders/{orderNumber}/webhook-payload`	payload do webhook
`GET`	`/v2/Orders/{orderNumber}/webhook-payload`	mesmo payload, servido por outra fonte de dados (contingência)
`GET`	`/v1/Orders/webhook-history-order/{orderNumber}`	snapshots do pedido em `ORDER_INVOICED` — não são tentativas de entrega
`GET`	`/v1/Orders/webhook-history-date/{date}`	números de pedido com snapshot no dia

O nome webhook-history engana. Essas duas rotas não listam tentativas de entrega: elas devolvem snapshots do pedido filtrados por ORDER_INVOICED. Lista vazia não prova que a entrega falhou. A plataforma não expõe resultado de entrega em rota nenhuma — o diagnóstico começa no log do seu próprio endpoint.

Arquivos

Método	Rota	O que faz
`POST`	`/v1/Storages/image/upload?externalReference=`	imagens de produto
`DELETE`	`/v1/Storages/image/upload`	remove imagens enviadas
`GET`	`/v1/Storages/file/{externalReference}/{fileType}`	lista URLs das imagens
`POST`	`/v1/Storages/invoice/upload?orderId=`	arquivo da nota
`GET`	`/v1/Storages/invoice?orderId=`	recupera a nota
`DELETE`	`/v1/Storages/delete/{entityId}`	remove arquivos da entidade
`DELETE`	`/v1/Storages/file/{externalReference}`	remove arquivo específico

fileType: 1 SKU · 2 Categoria · 3 Badge · 4 Nota fiscal · 5 Produto

Webhooks

Método	Rota	O que faz
`POST`	`/v1/Webhooks`	registra endpoint e eventos

Clientes

Método	Rota	O que faz
`GET`	`/v1/Clients`	lista clientes e compras
`GET`	`/v1/Clients/{clientId}`	detalhe de um cliente
`PUT`	`/v1/Users`	cria ou atualiza um cadastro
`GET`	`/v1/Users/updated?updatedDate=`	usuários alterados desde uma data

Saúde

Método	Rota	Autenticação
`GET`	`/v1/Health`	nenhuma
`GET`	`/v1/Health/ready`	nenhuma