API Reference

Listagem de Pedidos

get
https://homologation.oms.nexaas.com/api/v1/orders

Retorna todos os pedidos de uma conta:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Pagina atual

int32

Total por pagina

string

Coluna da tabela do pedido a ser usada como referência para ordenação de listagem. Ex: "created_at", "id", etc

string

Referência para ordenação da listagem. Ex: "ASC" ou "DESC"

string

Pedidos realizados a partir de (Os formatos de data pt-BR 20/02/2019 ou URL encoded, tambem pt-BR 20%2F02%2F2019 e 20/02/2019T12:30)

string

Pedidos realizados a partir de (Os formatos de data pt-BR 20/02/2019 ou URL encoded, tambem pt-BR 20%2F02%2F2019 e 20/02/2019T12:30)

string

Status atual do pedido

int32

Identificador do estabelecimento

string

Número do pedido de venda, código gerado pelo cliente

string

Filtra pedidos pelo nexaas_orders_code

int32

Número da nota fiscal

string

CPF ou CNPJ do cliente vinculado ao pedido

string

Status que não deve ser retornado na busca

string

Filtrar a listagem por 'criado em', Data inicial da filtragem Ex: 2022/06/09

string

Filtrar a listagem por 'criado em', Data finalda filtragem Ex: 2022/06/09

string

Filtrar a listagem por 'atualizado em, Data inicial da filtragem Ex: 2022/06/09

string

Filtrar a listagem por 'atualizado em', Data final da filtragem Ex: 2022/06/09

int32

Filtrar a listagem por 'organização de origem'

boolean

Filtra a listagem pelo atributo 'retire na loja'

string

Permite buscar por termos encontrados em "ID do pedido, código do pedido, código externo, número da nota"

string

Permite buscar por termos encontrados em "Nome, email, número do documento e número de telefone do cliente"

string

Filtrar a listagem por "tipo" do pedido.

int32

Filtrar a listagem por ID do canal de venda

int32

Filtrar a listagem por ID do canal de aquisição

string

Filtra pedidos por email do vendedor

int32

Filtrar a listagem por ID do customer

search[status_in]
array of strings

Filtra pelos status do pedido fornecidos

search[status_in]
search[payment_status_in]
array of strings

Filtra pelos status do pagamento do pedido fornecidos

search[payment_status_in]
boolean

Filtra pedidos com cliente (Customer) se o valor for "True" ou sem clientes se valor for "False"

int32

Filtra pedidos por ID do SKU do produto utilizado no pedido.

search[created_at_from_in]
array of dates

Permite busca por vários intervalos de data de criação - Início

search[created_at_from_in]
search[created_at_until_in]
array of dates

Permite busca por vários intervalos de data de criação - Fim

search[created_at_until_in]
boolean

Permite buscar pedidos com flag pagamento em massa

Responses

Updated 23 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago