| Propriedade | Descrição |
|---|---|
| id_store | ID da loja na Saipos |
| id_sale | ID único da venda na Saipos |
| id_sale_type | Tipo de venda 1: Entrega 2: Retirada no balcão / Takeout 3: Salão (mesas e comandas) 4: Ficha / Senha |
| created_at | Data e hora da criação da venda |
| updated_at | Data e hora da ultima modificação da venda |
| shift_date | Data do turno em que a venda foi realizada Importante - funcionamento da data do turno: Já a data do turno (shift date) também sobre influência, registrando a data em que o turno começou, independente da data que a venda foi incluída. Isso possui uma particularidade principalmente em restaurantes que atuam em períodos noturnos, conforme exemplo abaixo: Restaurante possui os seguintes turnos cadastrados: Há noites em que o estabelecimento está com bastante movimento e permanece aberto após 23h59min e nesse caso vendas cadastradas após às 00h são mantidas no turno da noite, uma vez que ele se iniciou às 18h e o próximo turno inicia-se apenas às 08h e o campo "shift_date" permanecerá com a data do último turno aberto. Essa regra foi desenvolvida com o objetivo de responder "dúvidas" dos clientes em relatórios quando querem saber "Quanto vendi ontem?" ou "Quantos produtos X vendi ontem?" e o desejo deles não é olhar apenas a "data" de ontem e excluindo vendas após à meia noite e sim possuem o objetivo de saber quanto vendeu nas operações que se iniciaram ontem, independente do horário que elas terminaram. Vale destacar que todos os relatórios da Saipos quando existe um filtro de data (sem hora) utilizará o campo shift_date para realizar o filtro. Dessa forma, recomendamos que filtros na API de dados também sejam feitos com base nesse campo. |
| notes | Observações da venda |
| discount_reason | Motivo do valor de desconto aplicado na venda Preenchido de forma obrigatória de acordo com configurações da loja |
| sale_number | Número de identificação da venda dentro do Sistema Saipos para vendas de Delivery. Informação não preenchida para vendas de Salão e Ficha (id_sale_type 3 ou 4). Para vendas de Ficha (id_sale_type = 4) consultar o número no objetoticket |
| desc_sale | Texto para identificação da venda em atendimento de Ficha ou Mesa com texto livre, normalmente utilizado para colocar nome do cliente ou posição na mesa. |
| canceled | Indica se a venda foi cancelado. Podendo ter os valores "Y" ou "N" |
| count_canceled_items | Quantidade de itens cancelados na venda |
| has_items_resolved_by_resolution_service | Venda com algum item onde no processo de integração de pedidos o código PDV foi resolvido através de Inteligência Artificial para identificação correta do item |
| increase_reason | Motivo do valor de acréscimo aplicado na venda Preenchido de forma obrigatória de acordo com configurações da loja |
| total_amount | Valor total da venda, que já está calculado com base na soma do valor dos itens e com descontos, acréscimos, taxa de serviço e taxa de entrega. |
| total_discount | Valor total de descontos aplicados na venda |
| total_increase | Valor total de acréscimos aplicados na venda |
| total_amount_items | Valor total dos itens da venda |
| customer | Objeto com dados referente ao Cliente da venda |
| store_shift | Objeto com dados referente ao Turno |
| discount_coupon | Objeto com dados referente ao Cupom de Desconto |
| delivery | Objeto com dados referente a Entrega para venda de Delivery |
| delivery_man | Objeto com dados referente ao Entregador da venda de Delivery |
| partner_sale | Objeto com dados do Parceiro de integração / Canal de venda |
| partner_delivery | Objeto com dados do Parceiro de integração de Logística |
| table_order | Objeto com dados referente ao Mesa para vendas do tipo Salão |
| ticket | Objeto com dados referente a Ficha para vendas do tipo Ficha |
| schedule | Objeto com dados referente ao Agendamento da venda |
| nfce | Objeto com dados do Cupom Fiscal emitido para a venda |
| payments | Array de objetos com dados de Formas de Pagamento da venda |
| payment_transaction_smartpos | Dados detalhados das transações SmartPOS para a conciliação de recebíveis |
| payment_transaction_tef | Dados detalhados das transações TEF para a conciliação de recebíveis |
Cliente (customer)
| Propriedade | Descrição |
|---|---|
| id_customer | ... |
| name | ... |
| ... | |
| birth_date | ... |
| phone | ... |
| cpf_cnpj | ... |
Consumidor não identificadoExistem alguns cenários onde integrações não enviam dados de Cliente. Nestes cenários. o customer não é identificado e o retorno na consulta terá somente a propriedade name com o valor "Consumidor não identificado"
Turno da venda (store_shift)
| Propriedade | Descrição |
|---|---|
| desc_store_shift | Descrição informando o turno em que a venda foi realizada |
| starting_time | Horário em que o turno iniciou na loja |
Cupom de desconto (discount_coupon)
| Propriedade | Descrição |
|---|---|
| coupon | Identificação do cupom |
| type | 1: Valor fixo 2: Percentual sobre a compra 3: Frete grátis |
| discount | Valor de desconto |
Entrega (delivery)
Somente para vendas com id_sale_type = 1
| Propriedade | Descrição |
|---|---|
| delivery_fee | Valor da taxa de entrega |
| delivery_time | Tempo estimado para a entrega |
| delivery_by | MERCHANT: Entrega feita pelo estabelecimento, PARTNER: Entrega feita pelo parceiro de integração |
| state | ... |
| city | ... |
| district | ... |
| street | ... |
| number | ... |
| complement | ... |
| reference | ... |
| zipcode | ... |
Sem dados de entregaSomente em vendas com o id_sale_type 1 (Entrega) a propriedade delivery será preenchida, em outros tipos de venda a propriedade virá com valor null
Entregador (delivery_man)
| Propriedade | Descrição |
|---|---|
| delivery_man_name | Nome do Entregador |
| id_store_delivery_man | Identificação (ID) do Entregador |
| id_store_partner_delivery | Retorna o ID do parceiro quando o entregador estiver vinculado a um serviço de entrega; caso contrário, retorna null |
Parceiro de integração de Pedido (partner_sale)
| Propriedade | Descrição |
|---|---|
| cod_store | Identificação da loja no Sistema do Parceiro |
| desc_store_partner | Nome da loja (marca/merchant) no Sistema do Parceiro |
| cod_sale1 | ID único do pedido no Sistema do Parceiro |
| cod_sale2 | Código curto de identificação do pedido no Sistema do Parceiro |
| partner_status | Último status do pedido no Sistema do Parceiro |
| import_delivery_fee | Configuração no Sistema Saipos, onde o estabelecimento escolhe se deve importar a taxa de entrega quando um pedido é integrado |
Parceiro de integração de Logística (partner_delivery)
| Propriedade | Descrição |
|---|---|
| partner_order_id | ID único do pedido no Sistema do Parceiro |
| created_at | Data e hora em que o Sistema Saipos realizou a solicitação da entrega no Sistema do Parceiro |
Mesa (table_order)
Somente para vendas com id_sale_type = 3
| Propriedade | Descrição |
|---|---|
| id_store_table | ID da Mesa vinculada à venda |
| id_store_order_card | ID da Comanda vinculada à venda |
| id_table_order_status | Status da Mesa 1: Fechada 2: Aberta 3: Em fechamento |
| total_service_charge_amount | Valor total da taxa de serviço calculado |
| service_charge | Taxa de serviço em percentual |
| customers_on_table | Quantidade de clientes na Mesa |
Ficha (ticket)
Somente para vendas com id_sale_type = 4
| Propriedade | Descrição |
|---|---|
| number | Número da ficha |
Agendamento (schedule)
| Propriedade | Descrição |
|---|---|
| schedule_datetime | Data e hora para a qual a venda foi agendada |
Nota fiscal (nfce)
| Propriedade | Descrição |
|---|---|
| serie | Série do último cupom fiscal emitido para a venda |
| numero | Número do último cupom fiscal emitido para a venda |
| data_emissao | Data da emissão do último cupom fiscal emitido para a venda |
| chave_acesso | Chave de acesso da nota fiscal emitida |
Formas de pagamento (payments)
| Propriedade | Descrição |
|---|---|
| payment_amount | Valor pago com a forma de pagamento |
| change_for | Valor para o qual precisa de troco. Somente para pagamento em DINHEIRO |
| created_at | Data e hora em que a forma de pagamento foi adicionada na venda |
| desc_store_payment_type | Identificação da forma de pagamento |
Múltiplas formas de pagamentoNo Sistema Saipos, é possível ter uma ou mais forma de pagamento em um mesma venda
Transações SmartPOS (payment_transaction_smartpos)
| Propriedade | Descrição |
|---|---|
| id_pos_partner | Identificador do parceiro de SmartPOS |
| payment_amount | Valor do pagamento processado |
| authorization_code | Código de autorização da transação SmartPOS |
| authorization_date_time | Data e hora da autorização de pagamento via SmartPOS |
| approved | Indica se a transação foi aprovada |
| cancelled | Indica se a transação foi cancelada |
| id_transaction | Identificador único da transação SmartPOS |
| card_label | Bandeira do cartão utilizado na transação |
| payment_method | Método de pagamento utilizado (ex: Crédito, Débito) |
| created_at | Data e hora da criação da transação no sistema |
| updated_at | Data e hora da última atualização da transação no sistema |
Transações TEF (payment_transaction_tef)
| Propriedade | Descrição |
|---|---|
| payment_amount | Valor do pagamento processado |
| approved | Indica se a transação foi aprovada |
| cancelled | Indica se a transação foi cancelada |
| created_at | Data e hora da criação da transação no sistema |
| updated_at | Data e hora da última atualização da transação no sistema |
| card_label | Bandeira do cartão utilizado na transação |
| nsu | Número Sequencial Único da transação TEF |
| processed_at | Data e hora em que a transação foi processada |
| cancelled_at | Data e hora do cancelamento da transação, quando aplicável |
| id_authorizer | Identificador da adquirente ou processadora da transação |