Skip to main content
GET
/
ordem-compra
/
{idOrdemCompra}
Obter ordem de compra
curl --request GET \
  --url https://api.tiny.com.br/public-api/v3/ordem-compra/{idOrdemCompra} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "numeroPedido": "<string>",
  "data": "2024-01-01",
  "situacao": 0,
  "desconto": "<string>",
  "frete": 123,
  "totalProdutos": 123,
  "totalPedidoCompra": 123,
  "dataPrevista": "2024-01-01",
  "itens": [
    {
      "produto": {
        "id": 123,
        "sku": "<string>",
        "descricao": "<string>",
        "tipo": "P"
      },
      "gtin": "<string>",
      "quantidade": 123,
      "preco": 123,
      "ipi": 123
    }
  ],
  "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>"
  },
  "parcelas": [
    {
      "id": 123,
      "numero": 123,
      "dias": 123,
      "dataVencimento": "<string>",
      "valor": 123,
      "contaContabil": {
        "id": 123
      },
      "meioPagamento": 1,
      "observacoes": "<string>"
    }
  ],
  "fretePorConta": "R",
  "observacoes": "<string>",
  "observacoesInternas": "<string>",
  "pvFrete": 123
}

Path Parameters

idOrdemCompra
integer
required

Response

OK

id
integer
numeroPedido
string | null
data
string
Example:

"2024-01-01"

situacao
enum<string> | null
  • 0 - Em Aberto
  • 1 - Atendido
  • 2 - Cancelado
  • 3 - Em Andamento
Available options:
0,
1,
2,
3
desconto
string
frete
number<float>
totalProdutos
number<float>
totalPedidoCompra
number<float>
dataPrevista
string
Example:

"2024-01-01"

itens
· object[]
contato
· object
categoria
· object
notaFiscal
· object
parcelas
· object[]
fretePorConta
enum<string> | null
  • R - Remetente
  • D - Destinatario
  • T - Terceiros
  • 3 - Proprio Remetente
  • 4 - Proprio Destinatario
  • S - Sem Transporte
Available options:
R,
D,
T,
3,
4,
S
observacoes
string
observacoesInternas
string | null
pvFrete
number<float>