Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
numerostringopcionalNúmero do pedido no Olist (1)
clientestringopcionalNome ou código do cliente (busca parcial) (1)
cpf_cnpjstringopcionalCPF ou CNPJ do cliente (1)
dataInicialstringopcionalData inicial de cadastro (dd/mm/yyyy) (1)
dataFinalstringopcionalData final de cadastro (dd/mm/yyyy) (1)
dataAtualizacaostringopcionalData da última atualização (dd/mm/yyyy hh:mm:ss) (1)
situacaostringopcionalSituação do pedido conforme tabela de situações (1)
numeroEcommercestringopcionalNúmero do pedido no e-commerce/sistema (1)
idVendedorstringopcionalNúmero de identificação do vendedor (1)
nomeVendedorstringopcionalNome do vendedor no Olist (1)
marcadorstringopcionalDescrição do marcador (1)
dataInicialOcorrenciastringopcionalData inicial de ocorrência (dd/mm/yyyy) (1)
dataFinalOcorrenciastringopcionalData final de ocorrência (dd/mm/yyyy) (1)
situacaoOcorrenciastringopcionalSituação da ocorrência (1)
paginaintopcionalNúmero da página (padrão: 1; 100 registros/página)
sortstringopcionalOrdenação (ASC ou DESC)
(1) Ao menos um parâmetro de pesquisa deve ser informado.

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioQuantidade total de páginas
retorno.pedidos[]list-condicionalLista de resultados [0..n]
retorno.pedidos[].pedido.idint-condicionalID do pedido no Olist ERP
retorno.pedidos[].pedido.numeroint-condicionalNúmero do pedido no Olist
retorno.pedidos[].pedido.numero_ecommercestring50condicionalNúmero do pedido no e-commerce
retorno.pedidos[].pedido.data_pedidodate10condicionalData do pedido (dd/mm/yyyy)
retorno.pedidos[].pedido.data_previstadate10condicionalData prevista de entrega
retorno.pedidos[].pedido.nomestring50condicionalNome do cliente
retorno.pedidos[].pedido.valordecimal-condicionalValor total do pedido (usa separador ”.“)
retorno.pedidos[].pedido.id_vendedorint-condicionalID do vendedor associado
retorno.pedidos[].pedido.nome_vendedorint-condicionalNome do vendedor associado
retorno.pedidos[].pedido.situacaostring15condicionalSituação do pedido
retorno.pedidos[].pedido.codigo_rastreamentostring25condicionalCódigo de rastreamento

​
Exemplo de chamada

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

{
  "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"
        }
      }
    ]
  }
}