GET api/v1/pedido/lista

Descrição

Lista pedidos da loja com filtros e paginação. Os pedidos são retornados ordenados por data de criação decrescente (mais recentes primeiro).

Paginação: Utilize os parâmetros pagina e limite para controlar a paginação. O limite máximo por página é 100 registros.

Filtros disponíveis:

status — Filtra por status do pedido (ex: "Em trânsito", "Entregue")
canal — Filtra por canal de origem (ex: "ecommerce", "mercadolivre")
dataInicio / dataFim — Filtra por período de criação (formato YYYY-MM-DD)

Obs.: Utilizar tokenAPI (Authorization: Bearer)

Limite de requisições: 60 requisições por minuto.

Códigos de erro:

Código	Descrição
400	Requisição inválida — Valor inválido para paginação (pagina menor que 1).
401	Não autorizado — Token ausente, inválido, inativo ou sem permissão para este serviço/método.
429	Limite de requisições ultrapassada — Aguarde o próximo minuto para novas requisições.
500	Erro interno — Falha inesperada no servidor.

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
pagina	Número da página para paginação (valor padrão: 1, mínimo: 1)	integer		não
limite	Quantidade de registros por página (valor padrão: 20, máximo: 100)	integer		não
status	Filtra pedidos pelo status (ex: "Em trânsito", "Entregue", "Aguardando postagem")	string	50	não
canal	Filtra pedidos pelo canal de origem (ex: "ecommerce", "mercadolivre", "shopee")	string	50	não
dataInicio	Data inicial do período de criação do pedido (formato YYYY-MM-DD). Deve ser usado junto com dataFim	string	10	não
dataFim	Data final do período de criação do pedido (formato YYYY-MM-DD). Deve ser usado junto com dataInicio	string	10	não

Exemplo de uso:
GET api/v1/pedido/lista?pagina=1&limite=20
GET api/v1/pedido/lista?status=Em trânsito&canal=ecommerce
GET api/v1/pedido/lista?dataInicio=2024-01-01&dataFim=2024-01-31

Parâmetros de Retorno

Campo	Descrição	Tipo	Tamanho
total	Total de registros encontrados com os filtros aplicados	integer
pagina	Página atual retornada	integer
limite	Limite de registros por página utilizado	integer
pedidos[]._id	Identificador único do pedido no MongoDB	string	24
pedidos[].numeroPedido	Número do pedido no sistema do lojista	string	100
pedidos[].pedidoLoja	Número do pedido na loja/plataforma de envio (ex: número AllPost)	string	100
pedidos[].tipoPedido	Tipo do pedido (envio ou reversa)	string	7
pedidos[].canal	Canal de origem do pedido	string	50
pedidos[].statusDescricao	Descrição do status atual do pedido	string	50
pedidos[].dataCriacao	Data de criação do pedido (formato ISO 8601)	string	24

Exemplo de Resposta

{
  "total": 150,
  "pagina": 1,
  "limite": 20,
  "pedidos": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "numeroPedido": "PED-2024-001",
      "tipoPedido": "envio",
      "canal": "ecommerce",
      "statusDescricao": "Em trânsito",
      "dataCriacao": "2024-01-15T10:30:00Z"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "numeroPedido": "PED-2024-002",
      "tipoPedido": "envio",
      "canal": "mercadolivre",
      "statusDescricao": "Entregue",
      "dataCriacao": "2024-01-14T08:15:00Z"
    }
  ]
}