Skip to main content
GET
/
ordem-compra
Listar ordens de compra
curl --request GET \
  --url https://api.tiny.com.br/public-api/v3/ordem-compra \
  --header 'Authorization: Bearer <token>'
{
  "itens": [
    {
      "id": 123,
      "numero": "<string>",
      "data": "2024-01-01",
      "situacao": 0,
      "desconto": "<string>",
      "frete": 123,
      "totalProdutos": 123,
      "totalPedidoCompra": 123,
      "dataPrevista": "2024-01-01",
      "contato": {
        "nome": "<string>",
        "codigo": "<string>",
        "fantasia": "<string>",
        "tipoPessoa": "J",
        "cpfCnpj": "<string>",
        "inscricaoEstadual": "<string>",
        "rg": "<string>",
        "telefone": "<string>",
        "celular": "<string>",
        "email": "<string>",
        "endereco": {
          "endereco": "<string>",
          "numero": "<string>",
          "complemento": "<string>",
          "bairro": "<string>",
          "municipio": "<string>",
          "cep": "<string>",
          "uf": "<string>",
          "pais": "<string>"
        },
        "id": 123
      },
      "categoria": {
        "id": 123,
        "nome": "<string>",
        "caminhoCompleto": "<string>"
      },
      "notaFiscal": {
        "id": 123,
        "numero": "<string>",
        "dataEmissao": "2024-01-01",
        "valor": "<string>",
        "natureza": "<string>"
      },
      "fretePorConta": "R",
      "observacoes": "<string>",
      "observacoesInternas": "<string>"
    }
  ],
  "paginacao": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Query Parameters

numero
integer

Pesquisa através do número da ordem de compra

dataInicial
string

Pesquisa através da data de criação da ordem de compra

dataFinal
string

Pesquisa através da data de criação da ordem de compra

marcadores
string[]

Pesquisa através dos marcadores da ordem de compra

nomeFornecedor
string

Pesquisa através do nome do fornecedor da ordem de compra

codigoFornecedor
string

Pesquisa através do código do fornecedor da ordem de compra

situacao
enum<number>

Pesquisa através da situação da ordem de compra

  • 0 - Em Aberto
  • 1 - Atendido
  • 2 - Cancelado
  • 3 - Em Andamento
Available options:
0,
1,
2,
3
orderBy
enum<string>

Define a ordenação da listagem por ordem crescente ou decrescente

  • asc - Crescente
  • desc - Descrescente
Available options:
asc,
desc
limit
integer
default:100

Limite da paginação

offset
integer
default:0

Offset da paginação

Response

OK

itens
· object[]
paginacao
· object