> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pesquisar Pedidos

> Serviço destinado a consultar pedidos de venda.

## Endpoint

```
POST https://api.tiny.com.br/api2/pedidos.pesquisa.php
```

## Parâmetros

| Parâmetro             | Tipo   | Ocorrência  | Descrição                                            |
| --------------------- | ------ | ----------- | ---------------------------------------------------- |
| token                 | string | obrigatório | Chave gerada para identificar sua empresa            |
| formato               | string | obrigatório | Formato do retorno (json)                            |
| numero                | string | opcional    | Número do pedido no Olist (1)                        |
| cliente               | string | opcional    | Nome ou código do cliente (busca parcial) (1)        |
| cpf\_cnpj             | string | opcional    | CPF ou CNPJ do cliente (1)                           |
| dataInicial           | string | opcional    | Data inicial de cadastro (dd/mm/yyyy) (1)            |
| dataFinal             | string | opcional    | Data final de cadastro (dd/mm/yyyy) (1)              |
| dataAtualizacao       | string | opcional    | Data da última atualização (dd/mm/yyyy hh:mm:ss) (1) |
| situacao              | string | opcional    | Situação do pedido conforme tabela de situações (1)  |
| numeroEcommerce       | string | opcional    | Número do pedido no e-commerce/sistema (1)           |
| idVendedor            | string | opcional    | Número de identificação do vendedor (1)              |
| nomeVendedor          | string | opcional    | Nome do vendedor no Olist (1)                        |
| marcador              | string | opcional    | Descrição do marcador (1)                            |
| dataInicialOcorrencia | string | opcional    | Data inicial de ocorrência (dd/mm/yyyy) (1)          |
| dataFinalOcorrencia   | string | opcional    | Data final de ocorrência (dd/mm/yyyy) (1)            |
| situacaoOcorrencia    | string | opcional    | Situação da ocorrência (1)                           |
| pagina                | int    | opcional    | Número da página (padrão: 1; 100 registros/página)   |
| sort                  | string | opcional    | Ordenação (ASC ou DESC)                              |

> (1) Ao menos um parâmetro de pesquisa deve ser informado.

## Retorno

| Campo                                          | Tipo    | Tamanho | Ocorrência  | Descrição                                 |
| ---------------------------------------------- | ------- | ------- | ----------- | ----------------------------------------- |
| retorno                                        | object  | -       | obrigatório | Elemento raiz do retorno                  |
| retorno.status\_processamento                  | int     | -       | obrigatório | Conforme tabela "Status de Processamento" |
| retorno.status                                 | string  | -       | obrigatório | "OK" ou "Erro"                            |
| retorno.pagina                                 | int     | -       | obrigatório | Número da página retornada                |
| retorno.numero\_paginas                        | int     | -       | obrigatório | Quantidade total de páginas               |
| retorno.pedidos\[]                             | list    | -       | condicional | Lista de resultados \[0..n]               |
| retorno.pedidos\[].pedido.id                   | int     | -       | condicional | ID do pedido no Olist ERP                 |
| retorno.pedidos\[].pedido.numero               | int     | -       | condicional | Número do pedido no Olist                 |
| retorno.pedidos\[].pedido.numero\_ecommerce    | string  | 50      | condicional | Número do pedido no e-commerce            |
| retorno.pedidos\[].pedido.data\_pedido         | date    | 10      | condicional | Data do pedido (dd/mm/yyyy)               |
| retorno.pedidos\[].pedido.data\_prevista       | date    | 10      | condicional | Data prevista de entrega                  |
| retorno.pedidos\[].pedido.nome                 | string  | 50      | condicional | Nome do cliente                           |
| retorno.pedidos\[].pedido.valor                | decimal | -       | condicional | Valor total do pedido (usa separador ".") |
| retorno.pedidos\[].pedido.id\_vendedor         | int     | -       | condicional | ID do vendedor associado                  |
| retorno.pedidos\[].pedido.nome\_vendedor       | int     | -       | condicional | Nome do vendedor associado                |
| retorno.pedidos\[].pedido.situacao             | string  | 15      | condicional | Situação do pedido                        |
| retorno.pedidos\[].pedido.codigo\_rastreamento | string  | 25      | condicional | Código de rastreamento                    |

## Exemplo de chamada

```bash theme={null}
curl -X POST https://api.tiny.com.br/api2/pedidos.pesquisa.php \
  -d "token=SEU_TOKEN&formato=json&dataInicial=01/05/2024&dataFinal=31/05/2024"
```

## Exemplos de retorno

### Sucesso

```json theme={null}
{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "pedidos": [
      {
        "pedido": {
          "id": 123456,
          "numero": 123456,
          "numero_ecommerce": "12",
          "data_pedido": "01/01/2013",
          "data_prevista": "10/01/2013",
          "nome": "Cliente Teste",
          "valor": "100.25",
          "id_vendedor": "123456",
          "nome_vendedor": "Vendedor Teste",
          "situacao": "Atendido"
        }
      }
    ]
  }
}
```