Skip to main content

Endpoint

POST https://api.tiny.com.br/api2/pedido.incluir.php

Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
pedidoxml/jsonobrigatórioDados do pedido em formato XML ou JSON

Estrutura de Campos

Dados Gerais do Pedido

CampoTipoTamanhoOcorrênciaDescrição
pedidoobject-obrigatórioElemento raiz do pedido
data_pedidostring10opcionalData do pedido (formato dd/mm/aaaa)
data_previstastring10opcionalData de previsão do pedido
id_lista_precoint-opcionalIdentificador da lista de preços
numero_pedido_ecommercestring50opcionalID do pedido no e-commerce
id_ecommerceint-opcionalID da plataforma e-commerce
ecommercestring50opcionalPlataforma que está enviando o pedido
situacaostring15opcionalSituação conforme tabela de pedidos
numero_ordem_comprastring10opcionalNúmero de ordem de compra

Cliente

CampoTipoTamanhoOcorrênciaDescrição
clienteobject-obrigatórioElemento do cliente
cliente.nomestring30obrigatórioNome do cliente
cliente.codigostring30opcionalCódigo para pesquisa do cliente
cliente.nome_fantasiastring60opcionalNome fantasia do cliente
cliente.tipo_pessoastring1opcionalF (Física), J (Jurídica), E (Estrangeiro)
cliente.cpf_cnpjstring18opcionalCPF ou CNPJ
cliente.iestring18opcionalInscrição estadual
cliente.rgstring10opcionalRG do cliente
cliente.enderecostring50opcionalEndereço
cliente.numerostring10opcionalNúmero do endereço
cliente.complementostring50opcionalComplemento
cliente.bairrostring30opcionalBairro
cliente.cepstring10opcionalCEP
cliente.cidadestring30opcionalCidade conforme tabela de municípios
cliente.ufstring30opcionalUnidade Federativa
cliente.paisstring50opcionalPaís conforme tabela
cliente.fonestring40opcionalTelefone
cliente.emailstring50opcionalE-mail
cliente.atualizar_clientestring1opcional”S” (Sim) ou “N” (Não) - padrão “S”
cliente.cpfConsumidorFinalstring18opcionalCPF para consumidor final

Endereço de Entrega (Opcional, se diferente do cliente)

CampoTipoTamanhoOcorrênciaDescrição
endereco_entregaobject-opcionalElemento do endereço de entrega
endereco_entrega.tipo_pessoastring1opcionalTipo de pessoa
endereco_entrega.cpf_cnpjstring18opcionalCPF/CNPJ de entrega
endereco_entrega.enderecostring50opcionalLogradouro
endereco_entrega.numerostring10opcionalNúmero
endereco_entrega.complementostring50opcionalComplemento
endereco_entrega.bairrostring30opcionalBairro
endereco_entrega.cepstring10opcionalCEP
endereco_entrega.cidadestring30opcionalCidade
endereco_entrega.ufstring30opcionalUF
endereco_entrega.fonestring40opcionalTelefone
endereco_entrega.nome_destinatariostring60opcionalNome do destinatário
endereco_entrega.iestring18opcionalInscrição estadual

Itens do Pedido

CampoTipoTamanhoOcorrênciaDescrição
itens[]list-obrigatórioLista de itens
itens[].itemobject-obrigatórioElemento do item
item.id_produtoint-opcionalID do produto
item.codigostring60opcionalCódigo do produto
item.descricaostring120obrigatórioDescrição do Produto
item.unidadestring3obrigatórioUnidade (UN, KG, etc)
item.quantidadedecimal-obrigatórioQuantidade (usa ”.” como separador)
item.valor_unitariodecimal-obrigatórioValor unitário
item.aliquota_comissaodecimal-opcionalAlíquota de comissão do item
item.informacao_adicionalstring-opcionalInformação adicional

Marcadores

CampoTipoTamanhoOcorrênciaDescrição
marcadores[]list-opcionalLista de marcadores
marcadores[].marcadorobject-opcionalElemento do marcador
marcador.idint-opcionalID do marcador existente
marcador.descricaostring50opcionalDescrição (cria novo se não existir)

Informações de Pagamento

CampoTipoTamanhoOcorrênciaDescrição
forma_pagamentostring30opcionalCódigo conforme tabela de formas
meio_pagamentostring100opcionalDescrição do meio

Parcelas

CampoTipoTamanhoOcorrênciaDescrição
parcelas[]list-opcionalLista de parcelas
parcelas[].parcelaobject-opcionalElemento da parcela
parcela.diasint20opcionalDias de vencimento
parcela.datastring10opcionalData de vencimento (dd/mm/aaaa)
parcela.valordecimal-opcionalValor da parcela
parcela.obsstring100opcionalObservação
parcela.destinostring50opcionalDestino (Caixa, Contas a Receber)
parcela.forma_pagamentostring30opcionalForma de pagamento
parcela.meio_pagamentostring100opcionalMeio de pagamento

Transportadora e Frete

CampoTipoTamanhoOcorrênciaDescrição
nome_transportadorstring100opcionalNome da transportadora
frete_por_contastring1opcional”R” (Remetente) ou “D” (Destinatário)
valor_fretedecimal-opcionalValor do frete
forma_enviostring30opcionalForma conforme tabela
forma_fretestring30opcionalForma cadastrada (ex: PAC)

Descontos e Despesas

CampoTipoTamanhoOcorrênciaDescrição
valor_descontodecimal-opcionalValor total de desconto
outras_despesasdecimal-opcionalOutras despesas

Observações

CampoTipoTamanhoOcorrênciaDescrição
obsstring100opcionalObservação do pedido
obs_internasstring100opcionalObservação interna

Vendedor

CampoTipoTamanhoOcorrênciaDescrição
id_vendedorint-opcionalID do vendedor
nome_vendedorstring50opcionalNome (desconsiderado se id_vendedor informado)

Campos Tributários

CampoTipoTamanhoOcorrênciaDescrição
id_natureza_operacaostring-opcionalID da natureza de operação
nome_natureza_operacaostring-opcionalNome da natureza
nome_depositostring-opcionalNome do depósito

Intermediador (Opcional)

CampoTipoTamanhoOcorrênciaDescrição
intermediadorobject-opcionalElemento do intermediador
intermediador.nomestring60condicionalNome do intermediador (obrigatório se presente)
intermediador.cnpjstring18condicionalCNPJ (obrigatório se presente)
intermediador.cnpjPagamentostring18opcionalCNPJ da instituição de pagamento

Pagamentos Integrados (Opcional)

CampoTipoTamanhoOcorrênciaDescrição
pagamentos_integrados[]list-opcionalLista de pagamentos integrados
pagamentos_integrados[].pagamento_integradoobject-condicionalElemento do pagamento
pagamento_integrado.tipo_pagamentoint-obrigatórioCódigo conforme tabela NFe
pagamento_integrado.valordecimal-obrigatórioValor do pagamento
pagamento_integrado.cnpj_intermediadorstring14obrigatórioCNPJ intermediador
pagamento_integrado.codigo_autorizacaostring-obrigatórioCódigo de autorização
pagamento_integrado.codigo_bandeiraint-obrigatórioBandeira do cartão

Retorno

CampoTipoOcorrênciaDescrição
retornoobjectobrigatórioElemento raiz do retorno
retorno.status_processamentointobrigatórioConforme tabela “Status de Processamento”
retorno.statusstringobrigatório”OK” ou “Erro”
retorno.codigo_errointcondicionalCódigo do erro (quando status = “Erro”)
retorno.erros[]listcondicionalLista de erros [0..n]
retorno.erros[].errostringcondicionalDescrição do erro
retorno.registros[]listcondicionalLista de resultados [0..n]
retorno.registros[].registro.sequenciaintcondicionalIdentificador sequencial de cada pedido
retorno.registros[].registro.statusstringcondicionalStatus do registro: “OK” ou “Erro”
retorno.registros[].registro.codigo_errointcondicionalCódigo do erro (conforme tabela)
retorno.registros[].registro.erros[]listcondicionalLista de erros do registro [0..n]
retorno.registros[].registro.erros[].errostringcondicionalDescrição do erro do registro
retorno.registros[].registro.idintcondicionalID do pedido no Olist ERP
retorno.registros[].registro.numerointcondicionalNúmero do pedido no Olist

Exemplo de Parâmetro XML Simplificado

<?xml version="1.0" encoding="UTF-8"?>
<pedido>
  <numero_pedido_ecommerce>LOJA-2024-5678</numero_pedido_ecommerce>
  <data_pedido>20/05/2024</data_pedido>
  <data_prevista>27/05/2024</data_prevista>
  <situacao>aprovado</situacao>
  <cliente>
    <nome>João da Silva</nome>
    <cpf_cnpj>123.456.789-00</cpf_cnpj>
    <email>joao@email.com</email>
    <telefone>(11) 98765-4321</telefone>
    <endereco>Rua Exemplo</endereco>
    <numero>100</numero>
    <bairro>Centro</bairro>
    <cidade>São Paulo</cidade>
    <uf>SP</uf>
    <cep>01310-100</cep>
  </cliente>
  <itens>
    <item>
      <codigo>PROD-001</codigo>
      <descricao>Produto Exemplo</descricao>
      <unidade>UN</unidade>
      <quantidade>2</quantidade>
      <valor_unitario>99.90</valor_unitario>
    </item>
  </itens>
  <parcelas>
    <parcela>
      <dias>0</dias>
      <data>20/05/2024</data>
      <valor>225.30</valor>
      <forma_pagamento>Cartão de Crédito</forma_pagamento>
    </parcela>
  </parcelas>
  <valor_frete>25.50</valor_frete>
  <valor_desconto>0.00</valor_desconto>
</pedido>

Exemplo de Parâmetro JSON Simplificado

{
  "pedido": {
    "numero_pedido_ecommerce": "LOJA-2024-5678",
    "data_pedido": "20/05/2024",
    "data_prevista": "27/05/2024",
    "situacao": "aprovado",
    "cliente": {
      "nome": "João da Silva",
      "cpf_cnpj": "123.456.789-00",
      "email": "joao@email.com",
      "telefone": "(11) 98765-4321",
      "endereco": "Rua Exemplo",
      "numero": "100",
      "bairro": "Centro",
      "cidade": "São Paulo",
      "uf": "SP",
      "cep": "01310-100"
    },
    "itens": [
      {
        "item": {
          "codigo": "PROD-001",
          "descricao": "Produto Exemplo",
          "unidade": "UN",
          "quantidade": "2",
          "valor_unitario": "99.90"
        }
      }
    ],
    "parcelas": [
      {
        "parcela": {
          "dias": "0",
          "data": "20/05/2024",
          "valor": "225.30",
          "forma_pagamento": "Cartão de Crédito"
        }
      }
    ],
    "valor_frete": "25.50",
    "valor_desconto": "0.00"
  }
}

Exemplo de Parâmetro XML Completo

<?xml version="1.0" encoding="UTF-8"?>
<pedido>
  <numero_pedido_ecommerce>ECOM-2024-9876</numero_pedido_ecommerce>
  <data_pedido>20/05/2024</data_pedido>
  <data_prevista>27/05/2024</data_prevista>
  <ecommerce>Loja Virtual Premium</ecommerce>
  <situacao>aprovado</situacao>
  <numero_ordem_compra>OC123456</numero_ordem_compra>

  <cliente>
    <codigo>CLI001</codigo>
    <nome>João da Silva</nome>
    <nome_fantasia>JS Comercio</nome_fantasia>
    <tipo_pessoa>F</tipo_pessoa>
    <cpf_cnpj>123.456.789-00</cpf_cnpj>
    <rg>12.345.678-9</rg>
    <ie>ISENTO</ie>
    <endereco>Rua Exemplo</endereco>
    <numero>100</numero>
    <complemento>Apto 101</complemento>
    <bairro>Centro</bairro>
    <cep>01310-100</cep>
    <cidade>São Paulo</cidade>
    <uf>SP</uf>
    <pais>Brasil</pais>
    <fone>(11) 98765-4321</fone>
    <email>joao@email.com</email>
    <atualizar_cliente>S</atualizar_cliente>
  </cliente>

  <endereco_entrega>
    <tipo_pessoa>F</tipo_pessoa>
    <cpf_cnpj>123.456.789-00</cpf_cnpj>
    <nome_destinatario>João da Silva</nome_destinatario>
    <endereco>Av. Principal</endereco>
    <numero>200</numero>
    <complemento>Casa 2</complemento>
    <bairro>Jardins</bairro>
    <cep>12345-678</cep>
    <cidade>São Paulo</cidade>
    <uf>SP</uf>
    <fone>(11) 98765-4321</fone>
  </endereco_entrega>

  <itens>
    <item>
      <id_produto>12345</id_produto>
      <codigo>PROD-001</codigo>
      <descricao>Notebook Dell Inspiron 15</descricao>
      <unidade>UN</unidade>
      <quantidade>2</quantidade>
      <valor_unitario>2500.00</valor_unitario>
      <aliquota_comissao>5.00</aliquota_comissao>
      <informacao_adicional>Notebook com 8GB RAM, SSD 256GB</informacao_adicional>
    </item>
    <item>
      <codigo>PROD-002</codigo>
      <descricao>Mouse sem fio</descricao>
      <unidade>UN</unidade>
      <quantidade>2</quantidade>
      <valor_unitario>50.00</valor_unitario>
      <informacao_adicional>Mouse óptico wireless</informacao_adicional>
    </item>
  </itens>

  <marcadores>
    <marcador>
      <descricao>E-commerce</descricao>
    </marcador>
    <marcador>
      <descricao>Promoção</descricao>
    </marcador>
  </marcadores>

  <forma_pagamento>credito</forma_pagamento>
  <meio_pagamento>Cartão de Crédito Visa</meio_pagamento>

  <parcelas>
    <parcela>
      <dias>0</dias>
      <data>20/05/2024</data>
      <valor>1700.00</valor>
      <obs>Entrada</obs>
      <destino>Contas a Receber</destino>
      <forma_pagamento>dinheiro</forma_pagamento>
      <meio_pagamento>Dinheiro</meio_pagamento>
    </parcela>
    <parcela>
      <dias>30</dias>
      <data>20/06/2024</data>
      <valor>1700.00</valor>
      <obs>Primeira parcela</obs>
      <destino>Contas a Receber</destino>
      <forma_pagamento>credito</forma_pagamento>
      <meio_pagamento>Cartão de Crédito</meio_pagamento>
    </parcela>
    <parcela>
      <dias>60</dias>
      <data>20/07/2024</data>
      <valor>1700.00</valor>
      <obs>Segunda parcela</obs>
      <destino>Contas a Receber</destino>
      <forma_pagamento>credito</forma_pagamento>
      <meio_pagamento>Cartão de Crédito</meio_pagamento>
    </parcela>
  </parcelas>

  <nome_transportador>Transportadora Rápida Ltda</nome_transportador>
  <frete_por_conta>R</frete_por_conta>
  <valor_frete>50.00</valor_frete>
  <forma_envio>X</forma_envio>
  <forma_frete>PAC</forma_frete>

  <valor_desconto>200.00</valor_desconto>
  <outras_despesas>30.00</outras_despesas>

  <obs>Pedido realizado através do site</obs>
  <obs_internas>Cliente preferencial - entrega prioritária</obs_internas>

  <id_vendedor>789</id_vendedor>
  <nome_vendedor>Maria Vendedora</nome_vendedor>

  <id_natureza_operacao>12345</id_natureza_operacao>
  <nome_natureza_operacao>Venda</nome_natureza_operacao>
  <nome_deposito>Deposito Principal</nome_deposito>
</pedido>

Exemplo de Parâmetro JSON Completo

{
  "pedido": {
    "numero_pedido_ecommerce": "ECOM-2024-9876",
    "data_pedido": "20/05/2024",
    "data_prevista": "27/05/2024",
    "ecommerce": "Loja Virtual Premium",
    "situacao": "aprovado",
    "numero_ordem_compra": "OC123456",
    "cliente": {
      "codigo": "CLI001",
      "nome": "João da Silva",
      "nome_fantasia": "JS Comercio",
      "tipo_pessoa": "F",
      "cpf_cnpj": "123.456.789-00",
      "rg": "12.345.678-9",
      "ie": "ISENTO",
      "endereco": "Rua Exemplo",
      "numero": "100",
      "complemento": "Apto 101",
      "bairro": "Centro",
      "cep": "01310-100",
      "cidade": "São Paulo",
      "uf": "SP",
      "pais": "Brasil",
      "fone": "(11) 98765-4321",
      "email": "joao@email.com",
      "atualizar_cliente": "S"
    },
    "endereco_entrega": {
      "tipo_pessoa": "F",
      "cpf_cnpj": "123.456.789-00",
      "nome_destinatario": "João da Silva",
      "endereco": "Av. Principal",
      "numero": "200",
      "complemento": "Casa 2",
      "bairro": "Jardins",
      "cep": "12345-678",
      "cidade": "São Paulo",
      "uf": "SP",
      "fone": "(11) 98765-4321"
    },
    "itens": [
      {
        "item": {
          "id_produto": "12345",
          "codigo": "PROD-001",
          "descricao": "Notebook Dell Inspiron 15",
          "unidade": "UN",
          "quantidade": "2",
          "valor_unitario": "2500.00",
          "aliquota_comissao": "5.00",
          "informacao_adicional": "Notebook com 8GB RAM, SSD 256GB"
        }
      },
      {
        "item": {
          "codigo": "PROD-002",
          "descricao": "Mouse sem fio",
          "unidade": "UN",
          "quantidade": "2",
          "valor_unitario": "50.00",
          "informacao_adicional": "Mouse óptico wireless"
        }
      }
    ],
    "marcadores": [
      {
        "marcador": {
          "descricao": "E-commerce"
        }
      },
      {
        "marcador": {
          "descricao": "Promoção"
        }
      }
    ],
    "forma_pagamento": "credito",
    "meio_pagamento": "Cartão de Crédito Visa",
    "parcelas": [
      {
        "parcela": {
          "dias": "0",
          "data": "20/05/2024",
          "valor": "1700.00",
          "obs": "Entrada",
          "destino": "Contas a Receber",
          "forma_pagamento": "dinheiro",
          "meio_pagamento": "Dinheiro"
        }
      },
      {
        "parcela": {
          "dias": "30",
          "data": "20/06/2024",
          "valor": "1700.00",
          "obs": "Primeira parcela",
          "destino": "Contas a Receber",
          "forma_pagamento": "credito",
          "meio_pagamento": "Cartão de Crédito"
        }
      },
      {
        "parcela": {
          "dias": "60",
          "data": "20/07/2024",
          "valor": "1700.00",
          "obs": "Segunda parcela",
          "destino": "Contas a Receber",
          "forma_pagamento": "credito",
          "meio_pagamento": "Cartão de Crédito"
        }
      }
    ],
    "nome_transportador": "Transportadora Rápida Ltda",
    "frete_por_conta": "R",
    "valor_frete": "50.00",
    "forma_envio": "X",
    "forma_frete": "PAC",
    "valor_desconto": "200.00",
    "outras_despesas": "30.00",
    "obs": "Pedido realizado através do site",
    "obs_internas": "Cliente preferencial - entrega prioritária",
    "id_vendedor": "789",
    "nome_vendedor": "Maria Vendedora",
    "id_natureza_operacao": "12345",
    "nome_natureza_operacao": "Venda",
    "nome_deposito": "Deposito Principal"
  }
}

Exemplo de Chamada com XML

curl -X POST https://api.tiny.com.br/api2/pedido.incluir.php \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "token=SEU_TOKEN" \
  -d "formato=json" \
  --data-urlencode "pedido=<?xml version=\"1.0\" encoding=\"UTF-8\"?><pedido><numero_pedido_ecommerce>LOJA-2024-5678</numero_pedido_ecommerce><data_pedido>20/05/2024</data_pedido><situacao>aprovado</situacao><cliente><nome>João da Silva</nome><cpf_cnpj>123.456.789-00</cpf_cnpj><email>joao@email.com</email></cliente><itens><item><codigo>PROD-001</codigo><descricao>Produto Exemplo</descricao><unidade>UN</unidade><quantidade>2</quantidade><valor_unitario>99.90</valor_unitario></item></itens><valor_frete>25.50</valor_frete></pedido>"

Exemplo de Chamada REST com JSON

# Exemplo com JSON
curl -X POST https://api.tiny.com.br/api2/pedido.incluir.php \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "token=SEU_TOKEN" \
  -d "formato=json" \
  --data-urlencode "pedido=$(cat <<'EOF'
{
  "pedido": {
    "numero_pedido_ecommerce": "LOJA-2024-5678",
    "data_pedido": "20/05/2024",
    "data_prevista": "27/05/2024",
    "situacao": "aprovado",
    "cliente": {
      "nome": "João da Silva",
      "cpf_cnpj": "123.456.789-00",
      "email": "joao@email.com",
      "telefone": "(11) 98765-4321",
      "endereco": "Rua Exemplo",
      "numero": "100",
      "bairro": "Centro",
      "cidade": "São Paulo",
      "uf": "SP",
      "cep": "01310-100"
    },
    "itens": [
      {
        "item": {
          "codigo": "PROD-001",
          "descricao": "Produto Exemplo",
          "unidade": "UN",
          "quantidade": "2",
          "valor_unitario": "99.90"
        }
      }
    ],
    "valor_frete": "25.50"
  }
}
EOF
)"

Exemplos de Retorno

Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": 1,
          "status": "OK",
          "id": 789456,
          "numero": 12345
        }
      }
    ]
  }
}

Erro - Validação (campo obrigatório faltando)

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 31,
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "31",
          "erros": [
            {"erro": "O campo cliente.nome é obrigatório"},
            {"erro": "O campo itens é obrigatório"}
          ]
        }
      }
    ]
  }
}

Erro - Cliente não encontrado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 30,
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {"erro": "Cliente com código CLI999 não encontrado"}
          ]
        }
      }
    ]
  }
}

Erro - Produto sem estoque

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 30,
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {"erro": "Produto PROD-001 sem estoque disponível"}
          ]
        }
      }
    ]
  }
}

Erro - Autenticação

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {"erro": "token invalido"}
    ]
  }
}

Erro - Registro duplicado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 30,
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {"erro": "Pedido com número LOJA-2024-5678 já existe"}
          ]
        }
      }
    ]
  }
}

Notas Importantes

  • Separador decimal: Use ponto (.) para valores decimais, por exemplo “5.25”
  • Formato de data: dd/mm/aaaa, por exemplo “20/05/2024”
  • Comportamento de busca: Campos de código buscam registros existentes; registros encontrados carregam dados adicionais do banco
  • Atualização de cliente: Por padrão, os dados do cliente são atualizados (atualizar_cliente = “S”)
  • Validação de vendedor: Vendedores não existentes geram erro
  • Tratamento de marcadores: Marcadores não encontrados são criados automaticamente