Sensio API
  1. Sales
Sensio API
  • Introdução
  • People
    • Buscar pessoas cadastradas
      GET
    • Cadastrar uma nova pessoa
      POST
    • Encontrar pessoa pelo Id
      GET
  • Items
    • Cadastrar um novo item
      POST
    • Retorna uma lista de itens
      GET
    • Retorna um item específico
      GET
    • Editar item
      POST
    • Retorna as composições do item e/ou das variações
      GET
  • POs
    • Retorna todas as ordens de produção
      GET
    • Retorna uma ordem de produção específica
      GET
    • Retorna uma ordem de produção específica buscando pelo código
      GET
    • Alterar estágio de OP
      PUT
    • Retorna estágios de produção
      GET
    • Criar uma OP
      POST
  • Sales
    • Listar pedidos
      GET
    • Retorna todas as vendas
      GET
    • Retorna um pedido específico
      GET
    • Retorna um pedido específico, buscando pelo código
      GET
    • Cadastrar um novo pedido
      POST
    • Cancelar um pedido
      PUT
    • Faturar um pedido
      PUT
    • Editar estágio de um pedido
      GET
  • NFes
    • Lista as NFes
      GET
    • Retorna uma NFe específica
      GET
    • Retorna XML da NFe
      GET
    • Retorna DANFE da NFe
      GET
  • NFSes
    • Lista Notas Fiscais de Serviço
    • Retorna uma NFSe por id
    • Retorna XML da NFSe
    • Retorna PDF da NFSe
  • Transactions
    • Cadastrar um novo lançamento financeiro
    • Retorna lançamentos paginados
    • Retorna um lançamento específico
  • Item Categories
    • Listar categorias de itens
  • Warehouses
    • Lista os depósitos
  • Custom Fields
    • Listar Campos Personalizados
  • Batches
    • Retorna lotes de um item
    • Listar lotes
  • Webhooks
    • Configurar webhook
  • Services
    • Retorna serviços cadastrados
  • Accounting
    • Retorna contas contábeis
  • CTes
    • Retorna CTes
    • Retorna CTe pelo id
  • Cargos
    • Editar o status de uma carga
    • Criar uma carga
    • Listar cargas
    • Retorna uma carga por id
  • Inventory
    • Movimentar estoque
  • Tags
    • Listar Tags
  1. Sales

Retorna todas as vendas

GET
/sales
Sales
Apenas para Venda ou Compra

Requisição

Parâmetros Query
type
enum<string> 
opcional
Valores permitidos:
VendaCompra

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/sales?type'

Respostas

🟢200OK
application/json
Response
Body
array of:
success
boolean 
opcional
message
string 
opcional
Padrão:
Vendas encontradas
response
array[object (sale) {80}] 
opcional
code
integer 
opcional
Código único.
company
string 
opcional
Id da empresa.
child
string 
opcional
Id da empresa, se ela for uma filial.
total
number <float>
opcional
Valor total dos itens adicionados no pedido.
dateCreated
string 
opcional
Data da criação do pedido, já existe de forma padrão a crição.
datePaymentsGenerated
string <date>
opcional
Data do pagamento que é gerada automáticamente no frontEnd.
dateSold
string <date>
opcional
Data do pedido.
dateBilled
string <date>
opcional
Data do faturamento.
fixedPaymentsDate
boolean 
opcional
Informa se as datas das parcelas são fixas.
type
enum<string> 
requerido
Tipo do pedido.
Valores permitidos:
VendaAssistência TécnicaOrçamentoCompraVenda RepresentaçãoBonificação/RemessaOutros
status
enum<string> 
opcional
Valores permitidos:
Em abertoFaturado
paymentConditionType
string 
opcional
Condição a ser escolhida, os sem 'X' são os dias pra cada parcela, sendo que somente uma parcela por mês.
Exemplo:
2x
paymentMethod
string 
opcional
Método de pagamento a ser feito.
Exemplo:
Dinheiro
priceList
string 
opcional
Tabela de preços, são adicionados à essa tabela os itens que pode ser vendido. Se for referênciado no pedido, deve-se adicionar somente os itens que compões a tabela.
payments
array[object (sale_payments) {6}] 
opcional
Lista das parcelas.
transactionsGenerated
boolean 
opcional
Informativo se houve geração de lançamentos nas parcelas.
Padrão:
false
customer
string 
requerido
Nome do cliente que fez o pedido.
customerId
string 
requerido
Id do cliente que fez o pedido.
otherExpenses
number <float>
opcional
Outras despesas que é adicionado junto ao valor líquido do pedido.
Padrão:
0
discount
number <float>
opcional
Desconto em real da venda.
Padrão:
0
discountType
enum<string> 
opcional
Valores permitidos:
%R$
Padrão:
R$
discountPercentage
number <float>
opcional
Porcentagem informada ao escolher o tipo de desconto como 'porcentagem', tanto este campo quanto o campo discount devem ser informados.
Padrão:
0
transportFee
number <float>
opcional
Taxa do transporte/frete.
Padrão:
0
details
string 
opcional
Observações que pode ser feito para o pedido.
nfse
string 
opcional
Id da nota fiscal que foi emitida pelo sistema.
nfseStatus
string 
opcional
Status da nota fiscal que foi emitida.
oc
string 
opcional
campo para informar OC/número do pedido do cliente/fornecedor
sellersInfo
array[object (salePostObject_sellersInfo) {4}] 
opcional
Informações do vendedor, bem como sua comissão
netTotal
number <float>
opcional
Valor líquido, valor resultante da subtração do desconto, da soma das 'outras despesas', 'taxa de transporte' e 'valor total'.
negotiationStatus
enum<string> 
opcional
Status da negociação
Valores permitidos:
Em orçamentoRecusadoAprovado
dueDate
string <date>
opcional
Data de vencimento do orçamento, ou seja, somente no tipo orçamento é preenchido este campo.
events
array[object (sale_events) {3}] 
opcional
foreseenDelivery
string <date>
opcional
Previsão de entrega, somente utilizado quando o pedido é do tipo orçamento.
quote
boolean 
opcional
quoteDate
string <date>
opcional
Data do orçamento, somente utilizado quando o pedido é do tipo orçamento.
orig
string 
opcional
Origem do pedido - utilizado para importações do pedido apartir de um ecommerce.
origId
string 
opcional
Id da origem do pedido - utilizado para importações do pedido apartir de um ecommerce.
ecommerce
boolean 
opcional
Indica se houve o envio das informações da nota fiscal para o ecommerce
tags
array[object (salePostObject_tags) {1}] 
opcional
Lista das tags que compõe o pedido, somente pode ser adicionado tags que fazem parte do escopo do pedido.
origStatus
string 
opcional
Status no ecommerce do pedido.
origPaymentMethod
string 
opcional
Método de pagamento no ecommerce.
origSynced
boolean 
opcional
Informa ao sistema que já foi enviada os dados da nota fiscal para o ecommerce.
Padrão:
false
nfce
string 
opcional
Id da nota fiscal do consumidor eletrônica emitida.
pdv
string 
opcional
Id do pdv - Frente de Caixa Online
nfe
string 
opcional
Id da nota fiscal eletrônica no banco, é gerado quando se emite uma nota fiscal após o faturamento do pedido.
cte
string 
opcional
Id do cte, conhecimento de transporte eletrônico, no banco de dados.
contract
string 
opcional
Id de referência para o contrato que gerou o pedido.
nfeStatus
string 
opcional
Status da NFe.
totalTaxes
number <float>
opcional
Valor do imposta sobre produto industrializado IPI. É adicionado quando se emite a NFe.
vNF
number <float>
opcional
Valor da NFe.
po
string 
opcional
Id da ordem de produção gerada para o pedido.
poCode
integer 
opcional
Código da ordem de produção.
dateCanceled
string <date>
opcional
Data do cancelamento do pedido.
cargo
string 
opcional
Id da carga que adicionou o pedido.
warehouse
string 
opcional
Depósito que vai ser decrementado a quantidade de cada item que foi adicionado no pedido quando for faturado.
category
string 
opcional
Id da categoria.
bonificacao
boolean 
opcional
Quando habilitado ele não será contado no faturamento final.
Padrão:
false
carrier
string 
opcional
Id do responsável por fazer o frete.
modFrete
enum<string> 
opcional
Tipo de transporte a ser realizado.
Valores permitidos:
0 - Por conta do emitente1 - Por conta do destinatário/remetente2 - Por conta de terceiros9 - Sem frete
foreseenShipment
string <date>
opcional
Previsão de entrega.
shipmentDetails
string 
opcional
Observações para entrega.
shipmentAddress
enum<string> 
opcional
Valores permitidos:
Endereço da PessoaEndereço de EntregaEndereço de CobrançaEndereço Secundário
Padrão:
Endereço da Pessoa
shipment
string 
opcional
Descrição do frete.
shipped
boolean 
opcional
Informa se os itens do pedido já foi enviado.
shipmentCode
string 
opcional
Código do envio.
shipmentDate
string <date>
opcional
Data do envio.
approved
boolean 
opcional
Possibilidade de não aprovar o pedido e ficar no aguardo.
Padrão:
true
cpfCNPJ
string 
opcional
Este dado é utilizado para emissão das NFe, dado do cliente que solicitou o pedido.
description
string 
opcional
checked
boolean 
opcional
Se o pedido foi conferido na carga em que ele faz parte.
Padrão:
false
userChecked
string 
opcional
Id do usuário que fez a conferência.
dateChecked
string <date>
opcional
Data da conferência.
groupedSales
array[string]
opcional
grouper
string 
opcional
Valor de referência para agrupar os pedidos.
Padrão:
saleLines
array[object (sale_saleLines) {11}] 
requerido
attachments
array[object (sale_attachments) {4}] 
opcional
Arquivos que vão anexados junto ao pedido, as informações são adionados quando é feito upload do arquivo para o sistema.
user
string 
opcional
Id do usuário que fez a venda.
contactId
string 
opcional
Id do contato.
acquirer
object (salePostObject_acquirer) 
opcional
updates
array[object (sale_updates) {3}] 
opcional
As atualizações são adicionadas automaticamente quando é feito alguma mudança no pedido.
Exemplo
[
    {
        "success": true,
        "message": "Vendas encontradas",
        "response": [
            {
                "code": 0,
                "company": "string",
                "child": "string",
                "total": 0,
                "dateCreated": "string",
                "datePaymentsGenerated": "2019-08-24",
                "dateSold": "2019-08-24",
                "dateBilled": "2019-08-24",
                "fixedPaymentsDate": true,
                "type": "Venda",
                "status": "Em aberto",
                "paymentConditionType": "2x",
                "paymentMethod": "Dinheiro",
                "priceList": "string",
                "payments": [
                    {
                        "transaction": "string",
                        "nDup": 0,
                        "dVenc": "2019-08-24",
                        "vDup": 0,
                        "tPag": "string",
                        "acquirerFee": 0
                    }
                ],
                "transactionsGenerated": false,
                "customer": "string",
                "customerId": "string",
                "otherExpenses": 0,
                "discount": 0,
                "discountType": "R$",
                "discountPercentage": 0,
                "transportFee": 0,
                "details": "string",
                "nfse": "string",
                "nfseStatus": "string",
                "oc": "string",
                "sellersInfo": [
                    {
                        "seller": "string",
                        "comissionType": "%",
                        "comissionValue": 0,
                        "comission": 0
                    }
                ],
                "netTotal": 0,
                "negotiationStatus": "Em orçamento",
                "dueDate": "2019-08-24",
                "events": [
                    {
                        "dateEvent": "2019-08-24",
                        "description": "string",
                        "responsible": "string"
                    }
                ],
                "foreseenDelivery": "2019-08-24",
                "quote": true,
                "quoteDate": "2019-08-24",
                "orig": "string",
                "origId": "string",
                "ecommerce": true,
                "tags": [
                    {
                        "tagId": "string"
                    }
                ],
                "origStatus": "string",
                "origPaymentMethod": "string",
                "origSynced": false,
                "nfce": "string",
                "pdv": "string",
                "nfe": "string",
                "cte": "string",
                "contract": "string",
                "nfeStatus": "string",
                "totalTaxes": 0,
                "vNF": 0,
                "po": "string",
                "poCode": 0,
                "dateCanceled": "2019-08-24",
                "cargo": "string",
                "warehouse": "string",
                "category": "string",
                "bonificacao": false,
                "carrier": "string",
                "modFrete": "0 - Por conta do emitente",
                "foreseenShipment": "2019-08-24",
                "shipmentDetails": "string",
                "shipmentAddress": "Endereço da Pessoa",
                "shipment": "string",
                "shipped": true,
                "shipmentCode": "string",
                "shipmentDate": "2019-08-24",
                "approved": true,
                "cpfCNPJ": "string",
                "description": "string",
                "checked": false,
                "userChecked": "string",
                "dateChecked": "2019-08-24",
                "groupedSales": [
                    "string"
                ],
                "grouper": "",
                "saleLines": [
                    {
                        "productName": "string",
                        "productId": "string",
                        "variationId": "string",
                        "dimension": "UN",
                        "qty": 0,
                        "price": 0,
                        "subtotal": 0,
                        "productType": "Produto",
                        "details": "string",
                        "detailsNF": true,
                        "warehouse": "string"
                    }
                ],
                "attachments": [
                    {
                        "name": "string",
                        "size": 0,
                        "key": "string",
                        "url": "string"
                    }
                ],
                "user": "string",
                "contactId": "string",
                "acquirer": {
                    "isWithAcquirerFee": true,
                    "acquirerId": "string",
                    "feeType": "string"
                },
                "updates": [
                    {
                        "user": "string",
                        "timestamp": "YYYY-MM-DD HH:mm:ss",
                        "description": "string"
                    }
                ]
            }
        ]
    }
]
🟠400Bad Request
🔴500Server Error
Modificado em 2025-06-06 19:12:23
Página anterior
Listar pedidos
Próxima página
Retorna um pedido específico
Built with