VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Mercados internacionais

Como os mercados ligam países a idioma, moeda, ajuste de preço e sortimento, e o mapa das rotas do administrador.

Um mercado é a regra de venda de um grupo de países: qual idioma e moeda o visitante vê, quanto o preço sobe ou desce, e quais produtos ficam de fora. É a ideia de "Markets" de outras plataformas. Um comprador de Portugal pode ver a loja em português europeu, em euros, com preço 12% maior e sem os produtos que a loja não envia para lá.

Pontos-chave
  • Todas as rotas exigem o privilégio manage_settings.
  • Um país pertence a no máximo um mercado ativo. Salvar um mercado ativo com um país que outro já usa devolve 409.
  • Cada loja tem um mercado padrão (is_default) que atende os países sem mercado. Não há rota para definir o padrão: ele é definido fora desta API, e o padrão não pode ser excluído.
  • O ajuste de preço usa pontos-base (bp): 1200 = +12%, -500 = -5%. O ajuste vale sobre o preço base, antes de qualquer conversão de moeda.
  • PATCH substitui o mercado inteiro: o que você não enviar volta ao valor vazio. Sempre mande o corpo completo.

Como funciona

Visitante chega→Mercado resolvido→Idioma, moeda e preço aplicados→Sortimento filtrado

O comprador é associado a um mercado nesta ordem: o cookie venddor_market (escolha explícita), o país informado pelo CDN (CF-IPCountry), o primeiro país do Accept-Language, e por fim o mercado padrão. O pedido grava o market_id no momento da compra, e é por isso que as métricas continuam contando pedidos antigos mesmo que você mude o mercado depois.

  1. Crie o mercado

    Cadastre nome, idioma (lang_code), moeda (currency_code), países e ajuste de preço.

  2. Defina o que ele não vende

    Com o sortimento, exclua categorias (com todas as filhas) e produtos específicos daquele mercado.

  3. Acompanhe

    Veja pedidos e receita de cada mercado.

Conceitos-chave

Incoterm

Define quem paga os impostos de importação. DDU: o comprador paga na chegada e a estimativa é só informativa. DDP: os impostos entram no total cobrado. Qualquer valor diferente de DDP vira DDU.

Países

country_codes são códigos ISO de 2 letras (PT, US). A API converte para maiúsculas, remove espaços e duplicatas.

Dinheiro

price_adjust_bp é inteiro em pontos-base. revenue_cents nas métricas é inteiro em centavos da moeda do mercado.

Exclusão

Excluir um mercado é lógico (ele some das listas). Os pedidos que o usaram mantêm o market_id.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/marketsListar mercadosadmin
POST/api/v1/admin/marketsCriar mercadoadmin
GET/api/v1/admin/markets/{id}Consultar mercadoadmin
PATCH/api/v1/admin/markets/{id}Atualizar mercadoadmin
DELETE/api/v1/admin/markets/{id}Excluir mercadoadmin
PUT/api/v1/admin/markets/{id}/assortmentDefinir o sortimentoadmin
GET/api/v1/admin/markets/{id}/metricsPedidos e receitaadmin

Erros comuns

  • Usar PATCH como parcial. Ele reescreve o mercado todo. Enviar só {"name":"X"} zera idioma, moeda, países e ajuste, e devolve o status para active.
  • Criar sem validar. A API aceita {} e cria um mercado vazio (nome, idioma e moeda em branco). Valide no seu lado.
  • País repetido. Dois mercados ativos com o mesmo país: 409. Inative o antigo ou tire o país dele antes.
  • Tentar definir o padrão. is_default não é aceito no corpo; o campo é ignorado.
  • Id inválido. Um id que não é UUID devolve 500 com a mensagem do banco, não 400. Um UUID inexistente devolve 404.
  • Excluir o padrão. Devolve 404 market not found, igual a um id que não existe.

Próximos passos

Criar e editar mercados
Cadastro completo, com o aviso do PATCH.
Sortimento e métricas
O que cada mercado não vende e quanto vendeu.
IDs, dinheiro e datas
Convenções de formato da API.
Anterior
Candidaturas de sellers
Próxima
Cadastro de mercados
Nesta página
  • Como funciona
  • Conceitos-chave
  • Incoterm
  • Países
  • Dinheiro
  • Exclusão
  • Endpoints
  • Erros comuns
  • Próximos passos