🔐 Autenticação

Documentação oficial: affiliate.shopee.com.br/open_api

Todas as requisições devem incluir o header Authorization com as credenciais.

Estrutura do Header

Authorization: SHA256 Credential={AppId}, Timestamp={Timestamp}, Signature={SHA256(AppId+Timestamp+Payload+Secret)}

Etapas para cálculo do Signature:

1. Obtenha o payload da requisição (corpo em JSON).
2. Obtenha o timestamp atual (ex: unixtimestamp.com).
3. Construa a string de assinatura: AppId + Timestamp + Payload + Secret.
4. Aplique o algoritmo SHA256.
5. Monte o header completo de autorização.

Exemplo:

Authorization: SHA256 Credential=123456, 
Timestamp=1577836800, 
Signature=dc88d72feea70c80c52c3399751a7d34966763f51a7f056aa070a5e9df64

📡 Requisições e Respostas

• Método: POST
• Content-Type: application/json
• Endpoint: https://open-api.affiliate.shopee.com.br/graphql

Formato da Requisição

{
  "query": "...",
  "operationName": "...",
  "variables": {
    "myVariable": "someValue"
  }
}

operationName e variables são opcionais, a menos que haja múltiplas operações na query.

Formato da Resposta

{
  "data": { ... },
  "errors": [ ... ]
}

❗ Estrutura de Erros

Códigos de Erro

📦 Shopee Offer List

Consulta para obter a lista de ofertas da Shopee disponíveis para afiliados.

🔍 Query

Query Name: shopeeOfferV2
Result Type: ShopeeOfferConnectionV2!

🧾 Parâmetros da Query

🧾 Estrutura da Resposta

📂 Estrutura ShopeeOfferV2

🏬 Shop Offer List

Consulta para obter ofertas específicas de lojas na Shopee.

🔍 Query

Query Name: shopOfferV2
Result Type: ShopOfferConnectionV2

Esta seção inclui informações sobre filtros por tipo de loja, key sellers, e muito mais. Para detalhes completos, consulte o playground interativo.

🛒 Product Offer List

Consulta para obter ofertas específicas de produtos na Shopee.

🔍 Query

Query Name: productOffer
Result Type: ProductOfferConnectionV2

Permite buscar produtos por categoria, loja, palavra-chave e muito mais. Use o playground para explorar todas as opções.

🔗 Short Link

Funcionalidade para gerar links curtos com rastreamento para ofertas, produtos ou lojas.

🔁 Mutation

Mutation Name: generateShortLink
Result Type: ShortLinkResult!

🧾 Parâmetros da Mutation

📦 Exemplo de Requisição (cURL)

curl -X POST 'https://open-api.affiliate.shopee.com.br/graphql' \
-H 'Authorization: SHA256 Credential=123456, Signature=x9bc0bd3ba6c41d98a591976bf95db97a58720a9e6d7788' \
-H 'Content-Type: application/json' \
-d '{
  "query": "mutation { generateShortLink(originUrl: \"https://shopee.com/product/123\", subIds: [\"campanhaA\", \"bannerB\"]){ shortLink } }"
}'

📈 Conversion Report

Consulta os dados de conversão: cliques, pedidos realizados, status de compras e comissões estimadas.

🔍 Query

Query Name: conversionReport
Result Type: ConversionReportConnection!

Permite filtrar por período de compra, loja, status de pedido, tipo de comprador e muito mais.

✅ Validated Report

Consulta os dados validados das conversões, com as comissões definitivas após verificação e aplicação de taxas.

🔍 Query

Query Name: validatedReport
Result Type: ValidatedReportConnection!

O scrollId é usado para paginação contínua. A primeira requisição retorna até 500 registros e um scrollId válido por 30 segundos. Requisições subsequentes devem utilizar esse scrollId dentro do prazo.

⚠️ Error Codes

Lista de códigos de erro retornados pela API da Shopee com suas descrições.

📌 Observações

• Muitos erros relacionados ao código 10020 estão associados a problemas de autenticação, como assinatura incorreta, timestamps inconsistentes ou app desabilitado.
• Para todos os erros 1003x, verifique sua configuração de autorização, uso de headers e limites de requisições.
• O scrollId para paginação em alguns endpoints tem validade de apenas 30 segundos. Evite reusá-lo fora desse intervalo.
• Em caso de bloqueio ou congelamento da conta, entre em contato diretamente com a Shopee através do link acima.