Skip to main content
Toda lista de /v1 retorna o mesmo envelope, paginada ou não:

Quais listas são paginadas

As listas não paginadas retornam todos os itens em uma única página com "hasMore": false e ignoram limit e cursor. Escreva o mesmo laço para todas as listas mesmo assim: se alguma delas passar a ser paginada, seu código continua funcionando sem mudanças.

Parâmetros de consulta

integer
padrão:"50"
Quantos itens retornar, de 1 a 200. Apenas dígitos são aceitos. Um 0, um número negativo, um decimal, um texto ou um número acima de 200 é recusado com 400 e o código common.invalid_request.
string
O nextCursor da página anterior, copiado exatamente. Um cursor que não pode ser lido é recusado com 400 e o código common.invalid_request; o servidor nunca volta silenciosamente à primeira página.
string
Apenas em GET /v1/orders e GET /v1/fulfillments. Precisa ser um dos valores de status listados para essa operação no grupo Endpoints (por exemplo pending_approval para pedidos ou dispatched para atendimentos). Qualquer outro valor é recusado com 400 e o código common.invalid_request.
string
Apenas em GET /v1/inventory/balances: mantém as caixas de um insumo do catálogo. Um id que não corresponde a nada retorna uma página vazia.
string
Apenas em GET /v1/inventory/balances: mantém as caixas de um depósito. Um id que não corresponde a nada retorna uma página vazia.

Percorra todas as páginas

Última página

Regras do cursor

  • O cursor é opaco. Trate-o como um token. Não o decodifique, não o construa nem o altere; o formato pode mudar sem aviso.
  • Um cursor marca uma posição, não um número de página. A próxima página começa logo depois do último item que você recebeu. Itens criados enquanto você percorre a lista não são pulados nem repetidos: pedidos e atendimentos novos aparecem no fim, porque essas listas vão do mais antigo para o mais recente.
  • Envie os mesmos filtros em todas as páginas. O cursor guarda apenas a posição. Se você mudar status, catalogItemId ou warehouseId no meio do caminho, a próxima página aplica os filtros novos a partir dessa posição.
  • Os filtros são aplicados em cada requisição. Se um pedido mudar de status enquanto você percorre GET /v1/orders?status=approved, ele pode sair do filtro antes de você chegar a ele.
  • Use um cursor apenas com a operação que o emitiu. Um cursor de uma lista não serve em outra.
  • Use limit=200 para varreduras completas. Menos páginas, maiores, consomem menos do seu limite de uso.

Erros

Páginas relacionadas