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

Pedidos da Shopee

Importa os pedidos recentes da Shopee e lista os que já foram importados.

A importação consulta a Shopee pelos pedidos criados nos últimos 7 dias e grava cada um na tabela de pedidos Shopee da loja. Estas rotas só espelham os dados da Shopee: a importação não cria, por si só, um pedido na loja. Exigem a loja conectada, o módulo shopee ativo e manage_shopee ou manage_settings.

Importar pedidos

POST/api/v1/admin/shopee/sync-ordersAdmin

Importa os pedidos dos últimos 7 dias

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/shopee/sync-orders" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Importação feita
json
{
  "success": true,
  "orders_synced": 12
}

Campos da resposta

successboolean
Sempre true.
orders_syncedinteger
Pedidos gravados ou atualizados nesta chamada. Em homologação é sempre 0.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_shopee","manage_settings"]}
403O módulo shopee não está ativo nesta loja.{"error":"module_disabled","module":"shopee"}
410A loja usa exclusivamente o Hub de Marketplaces (markethub) e este conector antigo está bloqueado.{"error":"crs_markethub_only","moved_to":"markethub"}
400A loja ainda não está conectada à Shopee.{"error":"not_connected","detail":"Conecte-se ao Shopee antes de sincronizar pedidos."}
500A Shopee falhou ou respondeu erro.{"error":"Failed to sync orders: ..."}
Até 50 pedidos por chamada

Cada chamada lê só a primeira página de resultados da Shopee (50 pedidos). Um pedido já importado é atualizado, não duplicado (chave: shopee_order_sn). Em lojas com mais de 50 pedidos em 7 dias, chame com frequência para não perder pedidos.

Listar pedidos

GET/api/v1/admin/shopee/ordersAdmin

Pedidos já importados da Shopee

Parâmetros de consulta

pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página, de 1 a 100. Acima de 100 volta para 20.
statusstring
UNPAIDREADY_TO_SHIPINVOICE_PENDINGPROCESSEDRETRY_SHIPSHIPPEDTO_CONFIRM_RECEIVECOMPLETEDIN_CANCELCANCELLEDTO_RETURNPENDING
Status do pedido na Shopee.
searchstring
Texto contido no número do pedido na Shopee, no id do pedido da loja ou no usuário do comprador.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/shopee/orders?status=COMPLETED&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Pedidos
json
{
  "items": [
    {
      "id": "12",
      "shopee_order_sn": "2610115XYZ12AB",
      "platform_order_id": null,
      "status": "COMPLETED",
      "total_amount": 12990,
      "buyer_username": "maria_souza",
      "shopee_data": {
        "order_sn": "2610115XYZ12AB",
        "order_status": "COMPLETED"
      },
      "last_synced": "2026-10-11T20:00:00Z",
      "created_at": "2026-10-11T20:00:00Z"
    }
  ],
  "orders": [
    {
      "id": "12",
      "shopee_order_sn": "2610115XYZ12AB",
      "platform_order_id": null,
      "status": "COMPLETED",
      "total_amount": 12990,
      "buyer_username": "maria_souza",
      "shopee_data": {
        "order_sn": "2610115XYZ12AB",
        "order_status": "COMPLETED"
      },
      "last_synced": "2026-10-11T20:00:00Z",
      "created_at": "2026-10-11T20:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

Campos da resposta

items / ordersarray
O mesmo array nas duas chaves. Use items.
items[].idstring
Id do registro (inteiro como texto).
items[].shopee_order_snstring
Número do pedido na Shopee.
items[].platform_order_iduuid
Pedido correspondente na loja, quando existe. Ausente ou null se ainda não vinculado.
items[].statusstring
Status na Shopee. PENDING é tratado como sinônimo de UNPAID.
items[].total_amountinteger
Total em centavos.
items[].buyer_usernamestring
Usuário do comprador na Shopee.
items[].shopee_dataobject
Dados brutos do pedido, como a Shopee enviou.
items[].last_synced / created_atstring
Datas (RFC 3339, UTC).
total / page / per_page / total_pagesinteger
Paginação.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_shopee","manage_settings"]}
403O módulo shopee não está ativo nesta loja.{"error":"module_disabled","module":"shopee"}
410A loja usa exclusivamente o Hub de Marketplaces (markethub) e este conector antigo está bloqueado.{"error":"crs_markethub_only","moved_to":"markethub"}
500Falha ao listar.{"error":"Failed to list orders"}

Veja também

  • Conectar a loja
  • Produtos na Shopee
Anterior
Produtos na Shopee
Próxima
ERP de estoque do seller
Nesta página
  • Importar pedidos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Listar pedidos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também