GET Api/Venda/Venda/{codigo}?codigoPedido={codigoPedido}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}

Método para consultar o pedido pelo código. Serão rertornadas as informações sobre o pedido.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
codigoPedido

Código do pedido

 integer

Required
CNPJ

Numero do CNPJ da empresa que receberá as informações.

 string

Required
token

Código de acesso à API

 string

Required
codigoEmpresa

Código identificador da empresa

 integer

Required
codigo

string

None.

Body Parameters

None.

Response Information

Resource Description

VendaModel
NameDescriptionTypeAdditional information
CodigoPedido

Código do pedido. Chave primária do tipo inteiro que será retornado do ERP ao criar o pedido.

 integer

None.
CodigoPedidoEcommerce

Codigo do Pedido no e-commerce, para relação do pedido do site com o pedido interno, alfanumérico

 string

None.
ValorFrete

Valor do Frete a ser cobrado, caso exista

 decimal number

None.
DataPrevistaEntrega

Data Prevista de entrega de acordo com a regra do site

 date

None.
CNPJTransportadora

CNPJ da Transportadora a ser utilizada, deve estar cadastrado no ERP. Se não encontrada, nao será atribuida ao pedido

 string

None.
TipoFrete

Tipo do Frete, 0, para por conta do emitente (vendedor), 1 por conta do destinatario (sera cobrado do cliente)

 integer

None.
CodigoCondicacaoFaturamento

Codigo da Condicação de faturamento

 integer

None.
CodigoBanco

Codigo do Banco a ser definido o contas a receber

 integer

None.
DataEmissao

Data de emissão do contas a receber do pedido. Se não informado, será considerada a data de vencimento

 date

None.
DataCompetencia

Data de competência do contas a receber do pedido. Se não informado, será considerada a data de vencimento

 date

None.
CodigoFormaPagamento

Codigo da Forma de Pagamento

 integer

None.
CodigoUsuario

Codigo do usuario responsavel pelas informações, padrão = -1

 integer

None.
ContaContabil

Codigo da Conta Contabil

 integer

None.
CodigoExecutivoConta

Codigo do Executivo de Conta

 integer

None.
Feira

boolean

None.
CentroCusto

Codigo do centro de custo

 integer

None.
DadosProduto

Dados dos produtos contidos no pedido, uma coleção de itens.

 Collection of ProdutosModel

None.
DadosCliente

Dados do Cliente

 ClienteModel

None.
DadosPagamento

Dados do pagamento, uma coleção de itens, pois pode haver mais de uma forma de pagamento

 Collection of PagamentoModel

None.
CodigoRetorno

Código do retorno da API: 0 - erro || 1 - sucesso

 integer

None.
MensagemRetorno

Mensagem de retorno da API

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CodigoPedido": 1,
  "CodigoPedidoEcommerce": "sample string 2",
  "ValorFrete": 3.0,
  "DataPrevistaEntrega": "2026-06-13T11:59:58.3327594-03:00",
  "CNPJTransportadora": "sample string 5",
  "TipoFrete": 6,
  "CodigoCondicacaoFaturamento": 7,
  "CodigoBanco": 8,
  "DataEmissao": "2026-06-13T11:59:58.3327594-03:00",
  "DataCompetencia": "2026-06-13T11:59:58.3327594-03:00",
  "CodigoFormaPagamento": 11,
  "CodigoUsuario": 12,
  "ContaContabil": 13,
  "CodigoExecutivoConta": 14,
  "Feira": true,
  "CentroCusto": 16,
  "DadosProduto": [
    {
      "CodigoProduto": "sample string 1",
      "DescricaoProduto": "sample string 2",
      "Quantidade": 3.0,
      "PrecoUnitario": 4.0,
      "DescontoProduto": 5.0,
      "ProdutoBonificado": true
    },
    {
      "CodigoProduto": "sample string 1",
      "DescricaoProduto": "sample string 2",
      "Quantidade": 3.0,
      "PrecoUnitario": 4.0,
      "DescontoProduto": 5.0,
      "ProdutoBonificado": true
    }
  ],
  "DadosCliente": {
    "CodigoCliente": 1,
    "Nome": "sample string 2",
    "Cpf": "sample string 3",
    "CNPJ": "sample string 4",
    "InscricaoEstadual": "sample string 5",
    "Cep": "sample string 6",
    "Endereco": "sample string 7",
    "NumeroEndereco": "sample string 8",
    "Complemento": "sample string 9",
    "Bairro": "sample string 10",
    "Cidade": "sample string 11",
    "Uf": "sample string 12",
    "CepEntrega": "sample string 13",
    "EnderecoEntrega": "sample string 14",
    "NumeroEnderecoEntrega": "sample string 15",
    "ComplementoEntrega": "sample string 16",
    "BairroEntrega": "sample string 17",
    "CidadeEntrega": "sample string 18",
    "UfEntrega": "sample string 19",
    "Email": "sample string 20",
    "EmailDeContato": "sample string 21",
    "DadosPessoa": [
      {
        "Nome": "sample string 1",
        "Cpf": "sample string 2",
        "Cnpj": "sample string 3",
        "Telefone": "sample string 4",
        "Email": "sample string 5",
        "DDD": 6,
        "DDI": 7
      },
      {
        "Nome": "sample string 1",
        "Cpf": "sample string 2",
        "Cnpj": "sample string 3",
        "Telefone": "sample string 4",
        "Email": "sample string 5",
        "DDD": 6,
        "DDI": 7
      }
    ],
    "CodigoRetorno": 22,
    "MensagemRetorno": "sample string 23"
  },
  "DadosPagamento": [
    {
      "TipoDeDocumento": 0,
      "NumeroParcelas": 1,
      "ValorTotal": 2.0,
      "DataPagamento": "2026-06-13T11:59:58.3327594-03:00",
      "DataVencimento": "2026-06-13T11:59:58.3327594-03:00",
      "CodigoAutorizacao": "sample string 5",
      "Credenciador": "sample string 6",
      "CodigoTid": "sample string 7",
      "Nsu": "sample string 8"
    },
    {
      "TipoDeDocumento": 0,
      "NumeroParcelas": 1,
      "ValorTotal": 2.0,
      "DataPagamento": "2026-06-13T11:59:58.3327594-03:00",
      "DataVencimento": "2026-06-13T11:59:58.3327594-03:00",
      "CodigoAutorizacao": "sample string 5",
      "Credenciador": "sample string 6",
      "CodigoTid": "sample string 7",
      "Nsu": "sample string 8"
    }
  ],
  "CodigoRetorno": 17,
  "MensagemRetorno": "sample string 18"
}

application/xml, text/xml

Sample: 
<VendaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models">
  <CNPJTransportadora>sample string 5</CNPJTransportadora>
  <CentroCusto>16</CentroCusto>
  <CodigoBanco>8</CodigoBanco>
  <CodigoCondicacaoFaturamento>7</CodigoCondicacaoFaturamento>
  <CodigoExecutivoConta>14</CodigoExecutivoConta>
  <CodigoFormaPagamento>11</CodigoFormaPagamento>
  <CodigoPedido>1</CodigoPedido>
  <CodigoPedidoEcommerce>sample string 2</CodigoPedidoEcommerce>
  <CodigoRetorno>17</CodigoRetorno>
  <CodigoUsuario>12</CodigoUsuario>
  <ContaContabil>13</ContaContabil>
  <DadosCliente>
    <Bairro>sample string 10</Bairro>
    <BairroEntrega>sample string 17</BairroEntrega>
    <CNPJ>sample string 4</CNPJ>
    <Cep>sample string 6</Cep>
    <CepEntrega>sample string 13</CepEntrega>
    <Cidade>sample string 11</Cidade>
    <CidadeEntrega>sample string 18</CidadeEntrega>
    <CodigoCliente>1</CodigoCliente>
    <CodigoRetorno>22</CodigoRetorno>
    <Complemento>sample string 9</Complemento>
    <ComplementoEntrega>sample string 16</ComplementoEntrega>
    <Cpf>sample string 3</Cpf>
    <DadosPessoa>
      <ContatoModel>
        <Cnpj>sample string 3</Cnpj>
        <Cpf>sample string 2</Cpf>
        <DDD>6</DDD>
        <DDI>7</DDI>
        <Email>sample string 5</Email>
        <Nome>sample string 1</Nome>
        <Telefone>sample string 4</Telefone>
      </ContatoModel>
      <ContatoModel>
        <Cnpj>sample string 3</Cnpj>
        <Cpf>sample string 2</Cpf>
        <DDD>6</DDD>
        <DDI>7</DDI>
        <Email>sample string 5</Email>
        <Nome>sample string 1</Nome>
        <Telefone>sample string 4</Telefone>
      </ContatoModel>
    </DadosPessoa>
    <Email>sample string 20</Email>
    <EmailDeContato>sample string 21</EmailDeContato>
    <Endereco>sample string 7</Endereco>
    <EnderecoEntrega>sample string 14</EnderecoEntrega>
    <InscricaoEstadual>sample string 5</InscricaoEstadual>
    <MensagemRetorno>sample string 23</MensagemRetorno>
    <Nome>sample string 2</Nome>
    <NumeroEndereco>sample string 8</NumeroEndereco>
    <NumeroEnderecoEntrega>sample string 15</NumeroEnderecoEntrega>
    <Uf>sample string 12</Uf>
    <UfEntrega>sample string 19</UfEntrega>
  </DadosCliente>
  <DadosPagamento>
    <PagamentoModel>
      <CodigoAutorizacao>sample string 5</CodigoAutorizacao>
      <CodigoTid>sample string 7</CodigoTid>
      <Credenciador>sample string 6</Credenciador>
      <DataPagamento>2026-06-13T11:59:58.3327594-03:00</DataPagamento>
      <DataVencimento>2026-06-13T11:59:58.3327594-03:00</DataVencimento>
      <Nsu>sample string 8</Nsu>
      <NumeroParcelas>1</NumeroParcelas>
      <TipoDeDocumento>Boleto</TipoDeDocumento>
      <ValorTotal>2</ValorTotal>
    </PagamentoModel>
    <PagamentoModel>
      <CodigoAutorizacao>sample string 5</CodigoAutorizacao>
      <CodigoTid>sample string 7</CodigoTid>
      <Credenciador>sample string 6</Credenciador>
      <DataPagamento>2026-06-13T11:59:58.3327594-03:00</DataPagamento>
      <DataVencimento>2026-06-13T11:59:58.3327594-03:00</DataVencimento>
      <Nsu>sample string 8</Nsu>
      <NumeroParcelas>1</NumeroParcelas>
      <TipoDeDocumento>Boleto</TipoDeDocumento>
      <ValorTotal>2</ValorTotal>
    </PagamentoModel>
  </DadosPagamento>
  <DadosProduto>
    <ProdutosModel>
      <CodigoProduto>sample string 1</CodigoProduto>
      <DescontoProduto>5</DescontoProduto>
      <DescricaoProduto>sample string 2</DescricaoProduto>
      <PrecoUnitario>4</PrecoUnitario>
      <ProdutoBonificado>true</ProdutoBonificado>
      <Quantidade>3</Quantidade>
    </ProdutosModel>
    <ProdutosModel>
      <CodigoProduto>sample string 1</CodigoProduto>
      <DescontoProduto>5</DescontoProduto>
      <DescricaoProduto>sample string 2</DescricaoProduto>
      <PrecoUnitario>4</PrecoUnitario>
      <ProdutoBonificado>true</ProdutoBonificado>
      <Quantidade>3</Quantidade>
    </ProdutosModel>
  </DadosProduto>
  <DataCompetencia>2026-06-13T11:59:58.3327594-03:00</DataCompetencia>
  <DataEmissao>2026-06-13T11:59:58.3327594-03:00</DataEmissao>
  <DataPrevistaEntrega>2026-06-13T11:59:58.3327594-03:00</DataPrevistaEntrega>
  <Feira>true</Feira>
  <MensagemRetorno>sample string 18</MensagemRetorno>
  <TipoFrete>6</TipoFrete>
  <ValorFrete>3</ValorFrete>
</VendaModel>