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

Shopee

Conector com o marketplace Shopee: conexão da loja, publicação de produtos e importação de pedidos.

A Shopee é um marketplace onde a loja pode anunciar os mesmos produtos do catálogo e receber pedidos. Este conector liga a loja à conta de vendedor na Shopee: o lojista autoriza a loja (OAuth), publica produtos e importa os pedidos feitos na Shopee.

Pontos principais
  • Exige o módulo shopee ativo e o privilégio manage_shopee (ou manage_settings).
  • Antes de tudo, configure Partner ID, Partner Key e Redirect URL nas configurações do módulo.
  • Publicar, retirar e importar pedidos só funcionam com a loja conectada; senão respondem 400 not_connected.
  • Em modo de homologação nada é enviado à Shopee de verdade.
  • Lojas que usam o Hub de Marketplaces recebem 410 neste conector.

Como funciona

  1. Configurar
    Preencha Partner ID, Partner Key e Redirect URL nas configurações do módulo Shopee.
  2. Autorizar
    Chame Link de autorização e abra a auth_url no navegador do lojista.
  3. Concluir
    A Shopee redireciona para a Redirect URL com code e shop_id; envie os dois para Concluir a conexão.
  4. Operar
    Publique produtos e importe pedidos.

Os anúncios têm quatro estados e os pedidos usam o vocabulário de status da Shopee:

AnúncioLetraSignificado
activeANo ar.
inactiveDRetirado ou pausado.
bannedBBanido pela Shopee.
reviewingPEm análise pela Shopee.

Conceitos principais

Sessão OAuth

Conectar guarda uma sessão com validade. refresh_token_status diz se está valid, expired ou none. Quando expira, refaça a autorização.

Modo de homologação

Com sandbox_mode ligado, sandbox/connect conecta sem OAuth, publicar gera um id local e a importação de pedidos retorna zero. Serve para testar o fluxo sem a Shopee.

Dinheiro

price e total_amount são inteiros em centavos.

Ids como texto

Os ids numéricos de vínculo e de item (id, shopee_item_id) vêm como texto para não perder precisão em linguagens que usam ponto flutuante.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/shopee/statusEstado da conexão (não exige credenciais configuradas)Conectar a loja
GET/api/v1/admin/shopee/authGera o link de autorização OAuthConectar a loja
POST/api/v1/admin/shopee/callbackTroca o código devolvido pela Shopee por uma sessãoConectar a loja
POST/api/v1/admin/shopee/sandbox/connectConexão de teste sem OAuth (só com o modo de homologação ligado)Conectar a loja
POST/api/v1/admin/shopee/disconnectApaga a sessão OAuth guardadaConectar a loja
GET/api/v1/admin/shopee/productsLista os anúncios (produtos publicados na Shopee)Produtos na Shopee
POST/api/v1/admin/shopee/products/{id}/publishPublica um produto do catálogo na ShopeeProdutos na Shopee
DELETE/api/v1/admin/shopee/products/{id}Retira um produto da ShopeeProdutos na Shopee
POST/api/v1/admin/shopee/sync-ordersImporta pedidos dos últimos 7 dias da ShopeePedidos da Shopee
GET/api/v1/admin/shopee/ordersLista os pedidos importadosPedidos da Shopee

Erros comuns

  • Chamar Link de autorização antes de configurar as credenciais: responde 422 not_configured.
  • Reusar um code ou deixá-lo expirar: a troca falha com 500.
  • Ler os dois arrays (items e products/orders) como se fossem listas diferentes.
  • Esperar que a importação traga mais de 50 pedidos por chamada.
  • Tratar 422/400 como falha do servidor: são estados esperados (not_configured, not_connected, sandbox_disabled).
  • Chamar este conector em uma loja que só usa o Hub de Marketplaces: responde 410 crs_markethub_only.

Próximos passos

Conectar a loja
OAuth passo a passo.
Produtos na Shopee
Publicar e retirar anúncios.
Pedidos da Shopee
Importar e consultar pedidos.
Anterior
Execuções de alerta
Próxima
Conectar a loja
Nesta página
  • Como funciona
  • Conceitos principais
  • Sessão OAuth
  • Modo de homologação
  • Dinheiro
  • Ids como texto
  • Endpoints
  • Erros comuns
  • Próximos passos