Pedido de Venda

pedidoVenda

Obtem Listagem de Pedidos de Venda

get

/pedidoVenda

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstring | nuloOpcional

Identificador de Paginação da Consulta

dataDigitacaoIniciostring | nuloOpcional

Data de Digitação do Pedido Inicial (YYYY-MM-DD)

dataDigitacaoFimstring | nuloOpcional

Data de Digitação do Pedido Final (YYYY-MM-DD)

dataPrevisaoFaturamentoIniciostring | nuloOpcional

Data de Previsao de Faturamento Inicial (YYYY-MM-DD)

dataPrevisaoFaturamentoFimstring | nuloOpcional

Data de Previsao de Faturamento Final (YYYY-MM-DD)

clientesinteger[] | nuloOpcional

Lista de Código de Cliente

representantesinteger[] | nuloOpcional

Lista de Código de Representante

tipoNotainteger[] | nuloOpcional

Lista de Código do Tipo de Nota

campoFiltroDinamicostring | nuloOpcional

Campo para Filtrar Dinamicamente no SQL

valorFiltroDinamicostring | nuloOpcional

Valor para Filtrar Dinamicamente no SQL

paginacaointeger | nuloOpcional

Quantidade de Pedidos na Paginação de Retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVenda

GET /comercial/v10/pedidoVenda HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codPedido": "text",
      "codCliente": 1,
      "codTipoNF": 1,
      "codRepresentante": 1,
      "percComissRep": 1,
      "tipoDesconto": 0,
      "desconto1": 1,
      "desconto2": 1,
      "desconto3": 1,
      "desconto4": 1,
      "desconto5": 1,
      "desconto6": 1,
      "acrescimo1": 1,
      "acrescimo2": 1,
      "acrescimo3": 1,
      "acrescimo4": 1,
      "dataEmissao": "2025-11-29",
      "dataPrevFat": "2025-11-29",
      "observacaoPedido": "text",
      "observacaoSelecao": "text",
      "situacao": "text",
      "nomeLocalEntrega": "text",
      "enderecoLocalEntrega": "text",
      "numeroLocalEntrega": "text",
      "cepLocalEntrega": "text",
      "ibgeCidadeLocalEntrega": 1,
      "bairroLocalEntrega": "text",
      "complementoLocalEntrega": "text",
      "cpfCnpjLocalEntrega": "text",
      "inscEstLocalEntrega": "text",
      "codTabelaPreco": 1,
      "codCondVenda": 1,
      "vencimentoEsp": [
        "2025-11-29"
      ],
      "codPortador": 1,
      "codTipoCobranca": 1,
      "codTransportadora": 1,
      "codConsignatario": 1,
      "codTipoFreteTransp": 1,
      "vlrFrete": 1,
      "vlrSeguro": 1,
      "consumidorFinal": true,
      "codUnidMonetaria": 1,
      "dataUltConvME": "2025-11-29",
      "pedidoAutomacao": "text",
      "codAtendente": "text",
      "percComissAtendente": 1,
      "prioridade": 1,
      "codEtapa": 1,
      "codPedidoCliente": "text",
      "codPedidoRep": "text",
      "vlrOutrasDesp": 1,
      "libFin": true,
      "flgBloqCredito": true,
      "flgBloqComercial": true,
      "vlrAntecipado": 1,
      "pesoBruto": 1,
      "pesoLiquido": 1,
      "codEstComercial": "text",
      "fatParcial": "text",
      "bloqGeracaoRomParcial": "text",
      "nomeOperador": "text",
      "tipoPedido": 1,
      "itensPedido": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "codProduto": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "precoUnit": 1,
          "percComissRepProd": 1,
          "descontoItem": 1,
          "tipoDescontoItem": 0,
          "acrescimoItem": 1,
          "tipoAcrescimoItem": 0,
          "codPedidoCliente": "text",
          "itemPedidoCliente": "text",
          "itemPrevFaturamento": "2025-11-29",
          "transEstoqueEst": "text",
          "codFinalidade": "text",
          "percIpi": 1,
          "codGrade": 1,
          "descricaoComplem1": "text",
          "descricaoComplem2": "text",
          "descricaoComplem3": "text",
          "descricaoComp1": "text",
          "descricaoComp2": "text",
          "descricaoComp3": "text",
          "tipoSortimento": 1,
          "possuiPunho": "text",
          "punhoItem": 1,
          "grade": [
            {
              "codProdutoSKU": "text",
              "qtdPedida": 1,
              "qtdFaturada": 1,
              "qtdCancelada": 1,
              "dadosCustomizados": [
                {
                  "campo": "text",
                  "valor": "text"
                }
              ]
            }
          ],
          "dadosMalharia": {
            "possuiGola": 1,
            "itemGola": "text",
            "percRibana": 1,
            "possuiRibana": 1,
            "itemRibana": "text",
            "codRib": "text",
            "possuiPunho": 1,
            "itemPunho": "text"
          },
          "itemBrinde": true,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "codTipoAtend": "text",
      "tipoPedTint": 1,
      "codLoteVenda": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastra um Pedido de Venda

put

/pedidoVenda

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da empresa

Corpo

codPedidostringOpcional

Código do Pedido de Venda

codClienteintegerObrigatório

Código do Cliente

codTipoNFintegerObrigatório

Código do Tipo de Nota

codRepresentanteintegerObrigatório

Código do Representante

percComissRepnumberOpcional

Percentual de Comissão do Representante

tipoDescontointeger · enumOpcional

Tipo de Desconto (0 - Percentual, 1 - Valor)

Valores possíveis:

desconto1numberOpcional

Primeiro Desconto

desconto2numberOpcional

Segundo Desconto

desconto3numberOpcional

Terceiro Desconto

desconto4numberOpcional

Quarto Desconto

desconto5numberOpcional

Quinto Desconto

desconto6numberOpcional

Sexto Desconto

acrescimo1numberOpcional

Primeiro Acréscimo

acrescimo2numberOpcional

Segundo Acréscimo

acrescimo3numberOpcional

Terceiro Acréscimo

acrescimo4numberOpcional

Quarto Acréscimo

dataEmissaostring · dateOpcional

Data de Emissão do Pedido de Venda (YYYY-MM-DD)

dataPrevFatstring · dateOpcional

Data de Previsão de Faturamento (YYYY-MM-DD)

observacaoPedidostring · máx: 1000Opcional

Observação para o Pedido de Venda

observacaoSelecaostring · máx: 1000Opcional

Observação para a Seleção de Faturamento

nomeLocalEntregastring · máx: 35Opcional

Nome do Local de Entrega

enderecoLocalEntregastring · máx: 60Opcional

Endereço do Local de Entrega

numeroLocalEntregastringOpcional

Número do Local de Entrega

cepLocalEntregastring · máx: 8Opcional

CEP do Local de Entrega

bairroLocalEntregastring · máx: 60Opcional

Bairro do Local de Entrega

cpfCnpjLocalEntregastring · máx: 15Opcional

Inscrição Estadual do Local de Entrega

inscEstLocalEntregastring · máx: 17Opcional

Inscrição Estadual do Local de Entrega

nomeOperadorstring · máx: 40Opcional

Nome do Operador do Sistemas

codOperadorintegerOpcional

Código do Operador do Sistemas

complementoLocalEntregastring · máx: 60Opcional

Complemento do Local de Entrega

codTabelaPrecointegerObrigatório

Código da Tabela de Preço

codCondVendaintegerOpcional

Condição de Venda

vencimentoEspstring · date[] · máx: 18Opcional

Dias de Vencimento Especial (Obrigatório para condição de venda 99)

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

codTransportadoraintegerOpcional

Código da Transportadora

codConsignatariointegerOpcional

Código da Transportadora Consignatária

codTipoFreteTranspintegerOpcional

Código do Tipo de Frete da Transportadora

codTipoFreteConsintegerOpcional

Código do Tipo de Frete da Transportadora Consignatária

vlrFretenumberOpcional

Valor do Frete

vlrSeguronumberOpcional

Valor do Seguro

consumidorFinalbooleanOpcional

Consumidor Final

codUnidMonetariaintegerOpcional

Código da Unidade Monetária

pedidoAutomacaostringOpcional

Pedido Automação

codAtendentestringOpcional

Código do Atendente

percComissAtendentenumberOpcional

Percentual de Comissão do Antendente

prioridadeinteger · máx: 9Opcional

Código da Prioridade

codPedidoClientestringOpcional

Código do Pedido do Cliente

codPedidoRepstringOpcional

Código do Pedido do Representante

vlrOutrasDespnumberOpcional

Valor Outras Despesas

vlrAntecipadonumberOpcional

Valor pago antecipadamente

pesoBrutonumberOpcional

Peso bruto da Quantidade Saldo do pedido

pesoLiquidonumberOpcional

Peso Líquido da Quantidade Saldo do pedido

codEstComercialstring · máx: 20Opcional

Código da Estrutura Comercial do Cliente

fatParcialstring · máx: 1Opcional

Permite Faturamento Parcial? (0 - Não, 1 - Sim)

bloqGeracaoRomParcialstring · máx: 1Opcional

Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)

tipoPedidoMalConfintegerOpcional

Tipo do Pedido (1 - Malharia, 2 - Confecção)

codTipoAtendstringOpcional

Tipo de atendimento

tipoPedidointeger · enumOpcional

Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)

Valores possíveis:

codLoteVendaintegerOpcional

Código do Lote

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/pedidoVenda

PUT /comercial/v10/pedidoVenda HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 2198

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "bairroLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "nomeOperador": "text",
  "codOperador": 1,
  "complementoLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "codTipoFreteCons": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "tipoPedidoMalConf": 1,
  "itensPedido": [
    {
      "codProduto": "text",
      "qtdPedida": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codGrade": 1,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "incideDescontoCapa": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "distTamanhosGrade": [
        {
          "codTamanho": "text",
          "qtdPedida": 1
        }
      ],
      "dadosMalharia": {
        "possuiGola": 0,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 0,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 0,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedido": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obtem Listagem de Pedidos de Venda Bloqueados na Etapa

get

/pedidosVendaBloqueados

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstring | nuloOpcional

Identificador de Paginação da Consulta

dataPrevisaoFaturamentoIniciostring | nuloOpcional

Data de Previsao de Faturamento Inicial (YYYY-MM-DD)

dataPrevisaoFaturamentoFimstring | nuloOpcional

Data de Previsao de Faturamento Final (YYYY-MM-DD)

clienteinteger | nuloOpcional

Código do Cliente

representanteinteger | nuloOpcional

Código do Representante

tipoNotainteger | nuloOpcional

Código do Tipo de Nota

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidosVendaBloqueados

GET /comercial/v10/pedidosVendaBloqueados HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codPedido": "text",
      "codCliente": 1,
      "codTipoNF": 1,
      "codRepresentante": 1,
      "percComissRep": 1,
      "tipoDesconto": 0,
      "desconto1": 1,
      "desconto2": 1,
      "desconto3": 1,
      "desconto4": 1,
      "desconto5": 1,
      "desconto6": 1,
      "acrescimo1": 1,
      "acrescimo2": 1,
      "acrescimo3": 1,
      "acrescimo4": 1,
      "dataEmissao": "2025-11-29",
      "dataPrevFat": "2025-11-29",
      "observacaoPedido": "text",
      "observacaoSelecao": "text",
      "situacao": "text",
      "nomeLocalEntrega": "text",
      "enderecoLocalEntrega": "text",
      "numeroLocalEntrega": "text",
      "cepLocalEntrega": "text",
      "ibgeCidadeLocalEntrega": 1,
      "bairroLocalEntrega": "text",
      "complementoLocalEntrega": "text",
      "cpfCnpjLocalEntrega": "text",
      "inscEstLocalEntrega": "text",
      "codTabelaPreco": 1,
      "codCondVenda": 1,
      "vencimentoEsp": [
        "2025-11-29"
      ],
      "codPortador": 1,
      "codTipoCobranca": 1,
      "codTransportadora": 1,
      "codConsignatario": 1,
      "codTipoFreteTransp": 1,
      "vlrFrete": 1,
      "vlrSeguro": 1,
      "consumidorFinal": true,
      "codUnidMonetaria": 1,
      "dataUltConvME": "2025-11-29",
      "pedidoAutomacao": "text",
      "codAtendente": "text",
      "percComissAtendente": 1,
      "prioridade": 1,
      "codEtapa": 1,
      "codPedidoCliente": "text",
      "codPedidoRep": "text",
      "vlrOutrasDesp": 1,
      "libFin": true,
      "flgBloqCredito": true,
      "flgBloqComercial": true,
      "vlrAntecipado": 1,
      "pesoBruto": 1,
      "pesoLiquido": 1,
      "codEstComercial": "text",
      "fatParcial": "text",
      "bloqGeracaoRomParcial": "text",
      "nomeOperador": "text",
      "tipoPedido": 1,
      "itensPedido": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "codProduto": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "precoUnit": 1,
          "percComissRepProd": 1,
          "descontoItem": 1,
          "tipoDescontoItem": 0,
          "acrescimoItem": 1,
          "tipoAcrescimoItem": 0,
          "codPedidoCliente": "text",
          "itemPedidoCliente": "text",
          "itemPrevFaturamento": "2025-11-29",
          "transEstoqueEst": "text",
          "codFinalidade": "text",
          "percIpi": 1,
          "codGrade": 1,
          "descricaoComplem1": "text",
          "descricaoComplem2": "text",
          "descricaoComplem3": "text",
          "descricaoComp1": "text",
          "descricaoComp2": "text",
          "descricaoComp3": "text",
          "tipoSortimento": 1,
          "possuiPunho": "text",
          "punhoItem": 1,
          "grade": [
            {
              "codProdutoSKU": "text",
              "qtdPedida": 1,
              "qtdFaturada": 1,
              "qtdCancelada": 1,
              "dadosCustomizados": [
                {
                  "campo": "text",
                  "valor": "text"
                }
              ]
            }
          ],
          "dadosMalharia": {
            "possuiGola": 1,
            "itemGola": "text",
            "percRibana": 1,
            "possuiRibana": 1,
            "itemRibana": "text",
            "codRib": "text",
            "possuiPunho": 1,
            "itemPunho": "text"
          },
          "itemBrinde": true,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "codTipoAtend": "text",
      "tipoPedTint": 1,
      "codLoteVenda": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Obtem um Pedido de Venda pelo Código de Automação

get

/pedidoVendaCodAutomacao/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Automação

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVendaCodAutomacao/{id}

GET /comercial/v10/pedidoVendaCodAutomacao/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "codCliente": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obtem um Pedido de Venda

get

/pedidoVenda/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVenda/{id}

GET /comercial/v10/pedidoVenda/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualiza um Pedido de Venda

put

/pedidoVenda/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codClienteintegerOpcional

Código do Cliente

codTipoNFintegerOpcional

Código do TIpo de Venda

codRepresentanteintegerOpcional

Código do Representante

percComissRepnumberOpcional

Percentual de Comissão do Representante

tipoDescontointeger · enumOpcional

Tipo de Desconto (0 - Percentual, 1 - Valor)

Valores possíveis:

desconto1numberOpcional

Primeiro Desconto

desconto2numberOpcional

Segundo Desconto

desconto3numberOpcional

Terceiro Desconto

desconto4numberOpcional

Quarto Desconto

desconto5numberOpcional

Quinto Desconto

desconto6numberOpcional

Sexto Desconto

acrescimo1numberOpcional

Primeiro Acréscimo

acrescimo2numberOpcional

Segundo Acréscimo

acrescimo3numberOpcional

Terceiro Acréscimo

acrescimo4numberOpcional

Quarto Acréscimo

dataPrevFatstring · dateOpcional

Data de Previsão de Faturamento (YYYY-MM-DD)

observacaoPedidostring · máx: 1000Opcional

Observação para o Pedido de Venda

observacaoSelecaostring · máx: 1000Opcional

Observação para a Seleção de Faturamento

nomeLocalEntregastring · máx: 35Opcional

Nome do Local de Entrega

enderecoLocalEntregastring · máx: 60Opcional

Endereço do Local de Entrega

numeroLocalEntregastringOpcional

Número do Local de Entrega

cepLocalEntregastring · máx: 8Opcional

CEP do Local de Entrega

bairroLocalEntregastring · máx: 60Opcional

Bairro do Local de Entrega

complementoLocalEntregastring · máx: 60Opcional

Complemento do Local de Entrega

cpfCnpjLocalEntregastring · máx: 15Opcional

Inscrição Estadual do Local de Entrega

inscEstLocalEntregastring · máx: 17Opcional

Inscrição Estadual do Local de Entrega

fatParcialstring · máx: 1Opcional

Permite Faturamento Parcial? (0 - Não, 1 - Sim)

bloqGeracaoRomParcialstring · máx: 1Opcional

Bloqueia Geração de Romaneio Parcial? (0 - Não, 1 - Sim)

nomeOperadorstring · máx: 40Opcional

Nome do Operador do Sistemas

codCondVendaintegerOpcional

Condição de Venda

vencimentoEspstring · date[] · máx: 18Opcional

Dias de Vencimento Especial (Obrigatório para condição de venda 99)

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

codTransportadoraintegerOpcional

Código da Transportadora

codConsignatariointegerOpcional

Código da Transportadora Consignatária

codTipoFreteTranspintegerOpcional

Código do Tipo de Frete da Transportadora

codTipoFreteConsintegerOpcional

Código do Tipo de Frete da Transportadora Consignatária

vlrFretenumberOpcional

Valor do Frete

vlrSeguronumberOpcional

Valor do Seguro

consumidorFinalbooleanOpcional

Consumidor Final

pedidoClientestringOpcional

Pedido do Cliente

pedidoAutomacaostringOpcional

Pedido Automação

codAtendentestringOpcional

Código do Atendente

percComissAtendentenumberOpcional

Percentual de Comissão do Antendente

prioridadeinteger · máx: 9Opcional

Código da Prioridade

vlrOutrasDespnumberOpcional

Valor Outras Despesas

vlrAntecipadonumberOpcional

Valor pago antecipadamente

codEstComercialstring · máx: 20Opcional

Código da Estrutura Comercial do Cliente

codTipoAtendstringOpcional

Tipo de atendimento

tipoPedidointeger · enumOpcional

Tipo de Pedido (1 -Tecelagem, 2 - Tintutaria, 3 - Tecelagem e Tinturaria)

Valores possíveis:

codLoteVendaintegerOpcional

Código do Lote

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/pedidoVenda/{id}

PUT /comercial/v10/pedidoVenda/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 1110

{
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "codTipoFreteCons": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "pedidoCliente": "text",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "vlrOutrasDesp": 1,
  "vlrAntecipado": 1,
  "codEstComercial": "text",
  "codTipoAtend": "text",
  "tipoPedido": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Consulta Sugestões de Faturamento de um Pedido de Venda

get

/pedidoVenda/{id}/sugestaoFaturamento

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de consulta

continuationTokenstring | nuloOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVenda/{id}/sugestaoFaturamento

GET /comercial/v10/pedidoVenda/{id}/sugestaoFaturamento HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codPedido": "text",
      "seqSugestao": 1,
      "situacao": 0,
      "valorSugestao": 1,
      "dataGeracao": "2025-11-29",
      "dataHoraListagem": "2025-11-29T01:52:29.926Z",
      "bloqueadoFaturamento": true,
      "liberadoComQtdMenor": true,
      "priorizar": true,
      "dataSeparacao": "2025-11-29",
      "horaGeracao": "text",
      "produto": [
        {
          "itemPedido": 1,
          "codProduto": "text",
          "qtdSugerida": 1,
          "qtdConferida": 1,
          "caixa": [
            {
              "codCaixa": "text",
              "codTag": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Obtém Sugestão de Faturamento de um Pedido de Venda

get

/pedidoVenda/{id}/sugestaoFaturamento/{seqSugestao}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

seqSugestaointegerObrigatório

Sequência de Sugestão de Faturamento

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVenda/{id}/sugestaoFaturamento/{seqSugestao}

GET /comercial/v10/pedidoVenda/{id}/sugestaoFaturamento/{seqSugestao} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "seqSugestao": 1,
  "situacao": 0,
  "valorSugestao": 1,
  "dataGeracao": "2025-11-29",
  "dataHoraListagem": "2025-11-29T01:52:29.926Z",
  "bloqueadoFaturamento": true,
  "liberadoComQtdMenor": true,
  "priorizar": true,
  "dataSeparacao": "2025-11-29",
  "horaGeracao": "text",
  "produto": [
    {
      "itemPedido": 1,
      "codProduto": "text",
      "qtdSugerida": 1,
      "qtdConferida": 1,
      "caixa": [
        {
          "codCaixa": "text",
          "codTag": [
            "text"
          ]
        }
      ]
    }
  ]
}

Cancela um Pedido de Venda

post

/pedidoVenda/{id}/cancelar

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codMotivointegerObrigatório

Código do Motivo do Cancelamento

nomeUsuarioCancelamentostringOpcional

Nome do Usuário do Cancelamento

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoVenda/{id}/cancelar

POST /comercial/v10/pedidoVenda/{id}/cancelar HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "codMotivo": 1,
  "nomeUsuarioCancelamento": "text"
}

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Cancelamento de Itens de Pedido de Venda

post

/pedidoVenda/{id}/cancelamentoItens

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codMotivointegerObrigatório

Código do Motivo do Cancelamento

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoVenda/{id}/cancelamentoItens

POST /comercial/v10/pedidoVenda/{id}/cancelamentoItens HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "codMotivo": 1,
  "itensPedido": [
    {
      "seqItem": "text",
      "qtdCancelamento": 1,
      "observacao": null
    }
  ]
}

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Liberar Bloqueio de um Pedido de Venda

post

/pedidoVenda/{id}/liberarBloqueio/{nomeUsuario}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

nomeUsuariostringObrigatório

Nome do Usuário ou Aplicação que Está Liberando o Pedido

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoVenda/{id}/liberarBloqueio/{nomeUsuario}

POST /comercial/v10/pedidoVenda/{id}/liberarBloqueio/{nomeUsuario} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Gera Sugestão de Faturamento de um Pedido de Venda da Confecção

post

/pedidoVenda/{id}/gerarSugestaoFaturamento

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoVenda/{id}/gerarSugestaoFaturamento

POST /comercial/v10/pedidoVenda/{id}/gerarSugestaoFaturamento HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "codCliente": 1,
  "codTipoNF": 1,
  "codRepresentante": 1,
  "percComissRep": 1,
  "tipoDesconto": 0,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "desconto5": 1,
  "desconto6": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "dataEmissao": "2025-11-29",
  "dataPrevFat": "2025-11-29",
  "observacaoPedido": "text",
  "observacaoSelecao": "text",
  "situacao": "text",
  "nomeLocalEntrega": "text",
  "enderecoLocalEntrega": "text",
  "numeroLocalEntrega": "text",
  "cepLocalEntrega": "text",
  "ibgeCidadeLocalEntrega": 1,
  "bairroLocalEntrega": "text",
  "complementoLocalEntrega": "text",
  "cpfCnpjLocalEntrega": "text",
  "inscEstLocalEntrega": "text",
  "codTabelaPreco": 1,
  "codCondVenda": 1,
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "codTipoCobranca": 1,
  "codTransportadora": 1,
  "codConsignatario": 1,
  "codTipoFreteTransp": 1,
  "vlrFrete": 1,
  "vlrSeguro": 1,
  "consumidorFinal": true,
  "codUnidMonetaria": 1,
  "dataUltConvME": "2025-11-29",
  "pedidoAutomacao": "text",
  "codAtendente": "text",
  "percComissAtendente": 1,
  "prioridade": 1,
  "codEtapa": 1,
  "codPedidoCliente": "text",
  "codPedidoRep": "text",
  "vlrOutrasDesp": 1,
  "libFin": true,
  "flgBloqCredito": true,
  "flgBloqComercial": true,
  "vlrAntecipado": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "codEstComercial": "text",
  "fatParcial": "text",
  "bloqGeracaoRomParcial": "text",
  "nomeOperador": "text",
  "tipoPedido": 1,
  "itensPedido": [
    {
      "codPedido": "text",
      "itemPedido": 1,
      "codProduto": "text",
      "qtdPedida": 1,
      "qtdFaturada": 1,
      "qtdCancelada": 1,
      "precoUnit": 1,
      "percComissRepProd": 1,
      "descontoItem": 1,
      "tipoDescontoItem": 0,
      "acrescimoItem": 1,
      "tipoAcrescimoItem": 0,
      "codPedidoCliente": "text",
      "itemPedidoCliente": "text",
      "itemPrevFaturamento": "2025-11-29",
      "transEstoqueEst": "text",
      "codFinalidade": "text",
      "percIpi": 1,
      "codGrade": 1,
      "descricaoComplem1": "text",
      "descricaoComplem2": "text",
      "descricaoComplem3": "text",
      "descricaoComp1": "text",
      "descricaoComp2": "text",
      "descricaoComp3": "text",
      "tipoSortimento": 1,
      "possuiPunho": "text",
      "punhoItem": 1,
      "grade": [
        {
          "codProdutoSKU": "text",
          "qtdPedida": 1,
          "qtdFaturada": 1,
          "qtdCancelada": 1,
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosMalharia": {
        "possuiGola": 1,
        "itemGola": "text",
        "percRibana": 1,
        "possuiRibana": 1,
        "itemRibana": "text",
        "codRib": "text",
        "possuiPunho": 1,
        "itemPunho": "text"
      },
      "itemBrinde": true,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "codTipoAtend": "text",
  "tipoPedTint": 1,
  "codLoteVenda": 1,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Liberar Sugestão de Faturamento de um Pedido de Venda da Confecção para Conferência

post

/pedidoVenda/liberarConferenciaSugestaoFaturamento/{id},{seqSugestao}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

seqSugestaointegerObrigatório

Sequência de Sugestão de Faturamento

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post

/pedidoVenda/liberarConferenciaSugestaoFaturamento/{id},{seqSugestao}

POST /comercial/v10/pedidoVenda/liberarConferenciaSugestaoFaturamento/{id},{seqSugestao} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Exclui Sugestão de Faturamento de um Pedido de Venda da Confecção

delete

/pedidoVenda/{id}/excluirSugestaoFaturamento/{seqSugestao}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

seqSugestaointegerObrigatório

Sequência de Sugestão de Faturamento

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/pedidoVenda/{id}/excluirSugestaoFaturamento/{seqSugestao}

DELETE /comercial/v10/pedidoVenda/{id}/excluirSugestaoFaturamento/{seqSugestao} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Obtém a Quantidade e Valor de Saldo dos Pedidos que Estão em Aberto.

get

/somaPedidoAberto

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

clientestringObrigatório

Código do CPF/CNPJ do Cliente

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/somaPedidoAberto

GET /comercial/v10/somaPedidoAberto?cliente=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "qtdTotal": 1,
  "qtdTotalPedidos": 1,
  "valorTotal": 1
}

Obtem um Analise Fiscal de um Pedido de Venda

get

/pedidoVendaAnaliseFiscal/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Pedido de Venda

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/pedidoVendaAnaliseFiscal/{id}

GET /comercial/v10/pedidoVendaAnaliseFiscal/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPedido": "text",
  "itensPedido": [
    {
      "itemPedido": 1,
      "codItem": 1,
      "codProduto": "text",
      "cfop": "text",
      "valorTotal": 1,
      "desconto": 1,
      "acrescimo": 1,
      "reducaoICMS": 1,
      "baseICMS": 1,
      "aliquotaICMS": 1,
      "valorICMS": 1,
      "valorICMSisentas": 1,
      "despesasAcessorias": 1,
      "baseIPI": 1,
      "aliquotaIPI": 1,
      "aliquotaIPI2": 1,
      "valoIPIdespAces": 1,
      "baseICMSst": 1,
      "aliquotaICMSst": 1,
      "valorICMSst": 1,
      "mvaICMSst": 1,
      "reducaoICMSst": 1,
      "desICMSzonaFran": 1,
      "desPISzonaFran": 1,
      "desCOFINSzonaFran": 1,
      "icmsCobradoOpAnt": true,
      "baseicmsUFdest": 1,
      "icmsAliquoFCP": 1,
      "icmsAliqIntDest": 1,
      "icmsAliqInterestadual": 1,
      "icmsInteres": 1,
      "icmsFCP": 1,
      "icmsUFdest": 1,
      "icmsUFreme": 1,
      "percReducao": 1,
      "codNCM": "text",
      "codCEST": "text",
      "percFECOEP": 1,
      "basePIS": 1,
      "aliquotaPIS": 1,
      "valorPIS": 1,
      "baseCOFINS": 1,
      "aliquotaCOFINS": 1,
      "valorCOFINS": 1,
      "valorFCPfecoepST": 1,
      "valorPercFCP43": 1,
      "valorPercFCP44": 1,
      "materiaPrima": 1,
      "valorSTNaoDestacado": 1,
      "valorFCPSTNaoDestacado": 1,
      "cstICMS": "text",
      "cstPIS": "text",
      "cstCOFINS": "text",
      "uniMed": "text",
      "quantItem": 1,
      "valLiqOP": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

AnteriorModels PróximoNota Fiscal Saída

Atualizado há 5 horas

Boa noite

Obtem Listagem de Pedidos de Venda

Cadastra um Pedido de Venda

Obtem Listagem de Pedidos de Venda Bloqueados na Etapa

Obtem um Pedido de Venda pelo Código de Automação

Obtem um Pedido de Venda

Atualiza um Pedido de Venda

Consulta Sugestões de Faturamento de um Pedido de Venda

Obtém Sugestão de Faturamento de um Pedido de Venda

Cancela um Pedido de Venda

Cancelamento de Itens de Pedido de Venda

Liberar Bloqueio de um Pedido de Venda

Gera Sugestão de Faturamento de um Pedido de Venda da Confecção

Liberar Sugestão de Faturamento de um Pedido de Venda da Confecção para Conferência

Exclui Sugestão de Faturamento de um Pedido de Venda da Confecção

Obtém a Quantidade e Valor de Saldo dos Pedidos que Estão em Aberto.

Obtem um Analise Fiscal de um Pedido de Venda