Skip to main content
GET

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.0 de app instalado na CW App Store. Escopo: orders.

Parâmetros de consulta

start_date
string<date-time>
obrigatório

Data de início do período para filtrar os pedidos com base na data de criação, com a possibilidade de retroceder no máximo 3 anos a partir da data atual.

Exemplo:

"2023-01-01T00:00:00-03:00"

end_date
string
obrigatório

Data de término do período para filtrar os pedidos com base na data de criação, assegurando que o intervalo não ultrapasse 6 meses.

Exemplo:

"2023-06-30T23:59:59-03:00"

status[]
enum<string>

Retorna apenas os pedidos com os status específicados. Para filtrar mais de um status na mesma requisição faça: status[]=closed&status[]=canceled.

Opções disponíveis:
closed,
canceled
page
number
padrão:1
Intervalo obrigatório: x >= 1
per_page
number
padrão:100
Intervalo obrigatório: 1 <= x <= 100

Resposta

Retorna um array com os pedidos encontrados.

Para obter mais detalhes sobre a estrutura de um pedido, consulte nossa seção exclusiva sobre o assunto.

orders
Pedido resumido · object[]
obrigatório
pagination
object
obrigatório

Informações sobre a paginação

Última modificação em 30 de junho de 2026