GET api/v1/pedido/{filtro}/{valor}

Descrição

Consulta detalhes de um pedido por filtro. Permite buscar um pedido específico utilizando diferentes critérios de pesquisa.

Filtros aceitos:

numeroPedido — Busca pelo número do pedido no sistema do lojista
chaveNfe — Busca pela chave da Nota Fiscal Eletrônica (44 caracteres numéricos)
pedidoCanal — Busca pelo número do pedido na plataforma de origem (marketplace)

A busca é sempre filtrada pela loja associada ao token autenticado, garantindo que apenas pedidos da loja sejam retornados.

Obs.: Utilizar tokenAPI (Authorization: Bearer)

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

Códigos de erro:

Código	Descrição
400	Requisição inválida — Filtro não aceito ou valor do filtro não informado.
401	Não autorizado — Token ausente, inválido, inativo ou sem permissão para este serviço/método.
404	Pedido não encontrado — Nenhum pedido corresponde ao filtro e valor informados para a loja autenticada.
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
filtro	Tipo de filtro para busca. Valores aceitos: numeroPedido, chaveNfe, pedidoCanal, pedidoLoja	string	20	sim
valor	Valor do filtro para busca do pedido	string	100	sim

Exemplo de uso:
GET api/v1/pedido/numeroPedido/PED-2024-001
GET api/v1/pedido/chaveNfe/35240112345678000195550010000000011000000019
GET api/v1/pedido/pedidoCanal/ML-123456
GET api/v1/pedido/pedidoLoja/2469057

Parâmetros de Retorno

Campo	Descrição	Tipo	Tamanho
_id	Identificador único do pedido no MongoDB	string	24
numeroPedido	Número do pedido no sistema do lojista	string	100
pedidoLoja	Número do pedido na loja/plataforma de envio (ex: número AllPost)	string	100
pedidoCanal	Número do pedido na plataforma de origem	string	100
canal	Canal de origem do pedido	string	50
tipoPedido	Tipo do pedido (envio ou reversa)	string	7
statusDescricao	Descrição do status atual do pedido	string	50
enderecoEntrega	Objeto com dados do endereço de entrega (nome, cpfCnpj, cep, cidade, uf, endereco, numero, complemento, bairro, telefone, email)	object
envio	Array de envios com produtos, nota fiscal, chaveNfe, linkRastreio e codigoRastreio	array
dataCriacao	Data de criação do pedido (formato ISO 8601)	string	24
dataAtualizacao	Data da última atualização do pedido (formato ISO 8601)	string	24

Exemplo de Resposta

{
  "_id": "507f1f77bcf86cd799439011",
  "numeroPedido": "PED-2024-001",
  "pedidoCanal": "ML-123456",
  "canal": "ecommerce",
  "tipoPedido": "envio",
  "statusDescricao": "Em trânsito",
  "enderecoEntrega": {
    "nome": "João da Silva",
    "cpfCnpj": "12345678901",
    "cep": "01310100",
    "cidade": "São Paulo",
    "uf": "SP",
    "endereco": "Av. Paulista",
    "numero": "1000",
    "complemento": "Sala 101",
    "bairro": "Bela Vista",
    "telefone": "11999998888",
    "email": "joao@email.com"
  },
  "envio": [
    {
      "produtos": [
        {
          "sku": "SKU-001",
          "titulo": "Camiseta Básica",
          "quantidade": 2,
          "preco": 49.90
        }
      ],
      "chaveNfe": "35240112345678000195550010000000011000000019",
      "linkRastreio": "https://www.helpygo.com.br/rastreio/ABC123",
      "codigoRastreio": "ABC123DEF456"
    }
  ],
  "dataCriacao": "2024-01-15T10:30:00Z",
  "dataAtualizacao": "2024-01-16T14:20:00Z"
}