API atual/Referência completa/Mercados internacionais

Sortimento e métricas

Define o que cada mercado não vende (categorias e produtos excluídos) e consulta quantos pedidos e quanta receita ele gerou.

Definir o sortimento

O sortimento de um mercado é uma lista de exclusões: o que aquele mercado não mostra nem vende. Tudo que não está na lista continua disponível. A exclusão vale na busca, na listagem e na página de produto, para o comprador que foi associado a esse mercado.

Duas regras importam: excluir uma categoria exclui também todas as subcategorias dela, e a chamada substitui as exclusões anteriores (as listas vazias limpam tudo).

PUT/api/v1/admin/markets/{id}/assortmentAdmin

Substitui as exclusões de sortimento de um mercado

Parâmetros de caminho

iduuidobrigatório

Id do mercado.

Corpo da requisição

excluded_category_idsarray

Ids (UUID) de categorias a excluir, com todas as filhas. Omitido equivale a lista vazia.

excluded_product_idsarray

Ids (UUID) de produtos a excluir. Omitido equivale a lista vazia.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/markets/cec34bae-b229-4f42-b7a6-b93d4ef2c765/assortment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"excluded_category_ids": ["ae6f8f8b-7cbe-4725-84fa-247cce138143"], "excluded_product_ids": []}'

A resposta de sucesso é 204 No Content, sem corpo.

Consultar as métricas

Conta os pedidos que foram feitos naquele mercado e soma a receita. O mercado é gravado no pedido no momento do checkout, então o histórico não muda se você editar o mercado depois.

GET/api/v1/admin/markets/{id}/metricsAdmin

Pedidos e receita de um mercado

Parâmetros de caminho

iduuidobrigatório

Id do mercado.

200Métricas

json

{ "orders": 18, "revenue_cents": 1249900, "currency_code": "EUR" }

Campos da resposta

ordersinteger

Quantidade de pedidos do mercado, de qualquer status e de qualquer época. Não há filtro de período.

revenue_centsinteger

Soma do total dos pedidos, em centavos inteiros. Se a consulta falhar internamente, volta 0 em vez de erro.

currency_codestring

Moeda do mercado (a atual, não a de cada pedido).

Erros

Status	Quando	Corpo de exemplo
400	Corpo do `PUT` não é JSON válido.	`{"error":"invalid request body","detail":"..."}`
404	Mercado não existe (nas métricas).	`{"error":"market not found","detail":"market not found"}`
500	Algum id não é UUID.	`{"error":"market operation failed","detail":"o valor \"x\" não é um uuid válido. ..."}`
401 / 403	Sem token ou sem `manage_settings`.	`{"error":"missing authorization header"}`

Veja também

Sortimento e métricas

Define o que cada mercado não vende (categorias e produtos excluídos) e consulta quantos pedidos e quanta receita ele gerou.

Definir o sortimento

Duas regras importam: excluir uma categoria exclui também todas as subcategorias dela, e a chamada substitui as exclusões anteriores (as listas vazias limpam tudo).

PUT/api/v1/admin/markets/{id}/assortmentAdmin

Substitui as exclusões de sortimento de um mercado

Parâmetros de caminho

iduuidobrigatório

Id do mercado.

Corpo da requisição

excluded_category_idsarray

Ids (UUID) de categorias a excluir, com todas as filhas. Omitido equivale a lista vazia.

excluded_product_idsarray

Ids (UUID) de produtos a excluir. Omitido equivale a lista vazia.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/markets/cec34bae-b229-4f42-b7a6-b93d4ef2c765/assortment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"excluded_category_ids": ["ae6f8f8b-7cbe-4725-84fa-247cce138143"], "excluded_product_ids": []}'

A resposta de sucesso é 204 No Content, sem corpo.

Consultar as métricas

Conta os pedidos que foram feitos naquele mercado e soma a receita. O mercado é gravado no pedido no momento do checkout, então o histórico não muda se você editar o mercado depois.

GET/api/v1/admin/markets/{id}/metricsAdmin

Pedidos e receita de um mercado

Parâmetros de caminho

iduuidobrigatório

Id do mercado.

200Métricas

json

{ "orders": 18, "revenue_cents": 1249900, "currency_code": "EUR" }

Campos da resposta

ordersinteger

Quantidade de pedidos do mercado, de qualquer status e de qualquer época. Não há filtro de período.

revenue_centsinteger

Soma do total dos pedidos, em centavos inteiros. Se a consulta falhar internamente, volta 0 em vez de erro.

currency_codestring

Moeda do mercado (a atual, não a de cada pedido).

Erros

Status	Quando	Corpo de exemplo
400	Corpo do `PUT` não é JSON válido.	`{"error":"invalid request body","detail":"..."}`
404	Mercado não existe (nas métricas).	`{"error":"market not found","detail":"market not found"}`
500	Algum id não é UUID.	`{"error":"market operation failed","detail":"o valor \"x\" não é um uuid válido. ..."}`
401 / 403	Sem token ou sem `manage_settings`.	`{"error":"missing authorization header"}`