Skip to main content
As listagens que podem crescer muito devolvem os resultados em páginas. A paginação é por cursor: cada resposta diz, nos headers, qual valor usar para buscar a próxima página ou a anterior.
Onde vale: GET /merchant/v3/{merchantId}/orders e GET /merchant/v3/{merchantId}/discounts. As listagens da Partner API V2 não são paginadas, e o polling de eventos tem a própria regra de lote (até 100 eventos, veja Consultar novos pedidos).

Como funciona

1

Busque a primeira página

Chame a listagem sem cursor. Os resultados vêm do mais recente para o mais antigo, 30 por página.
2

Leia os headers

Se houver mais páginas, a resposta traz X-Next-Cursor (e X-Previous-Cursor a partir da segunda página), além do header Link com as URLs prontas.
3

Peça a próxima página

Repita a chamada com ?next={X-Next-Cursor}, ou siga a URL rel="next" do Link. Quando a resposta não trouxer X-Next-Cursor, você chegou ao fim.

Parâmetros

string
Valor de X-Next-Cursor da resposta anterior. Traz a página seguinte.
string
Valor de X-Previous-Cursor. Traz a página anterior. Não envie junto com next: a combinação retorna 400 Bad Request.
integer
padrão:"30"
Itens por página, entre 30 e 250. Valores fora da faixa são ajustados para o limite mais próximo (per_page=10 devolve 30 itens).
Mantenha os mesmos filtros e o mesmo per_page em todas as páginas da mesma consulta. As URLs do header Link já fazem isso por você.

Headers da resposta

string
Cursor da próxima página. Ausente na última página.
string
Cursor da página anterior. Ausente na primeira página.
As mesmas páginas como URLs completas, com rel="next" e rel="prev". Ausente quando tudo cabe em uma página.
Use --include no cURL para ver os headers:
Headers da resposta
Trate o cursor como opaco: use o valor exatamente como veio, sem decodificar nem montar o seu. Na query, ele precisa estar codificado para URL (o = do final vira %3D). As bibliotecas de HTTP fazem isso quando você passa o valor como parâmetro.

Percorrendo todas as páginas

Uma listagem sem resultados responde 204 No Content, sem corpo e sem headers de paginação.