Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Permitir que o parceiro desenvolva uma API onde o PDV realizará a consulta de pré-vendas. Por favor, siga a documentação de configuração de ambiente para mais detalhes.

Chamada

POST {url}

Informações da Requisição (Request Information)

Segurança

Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Auth ou Bearer Token, siga a documentação de configuração para selecionar o modelo de autenticação.

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
idstringIdentificado único da requisição
versionstring

Versão da API

orderNumberIntegerNúmero da pré-venda
sheetNumberIntegerNúmero da comanda
idStoreIntegerNúmero da empresa do PDV
identificationsArray object JsonLista de documentos
identifications[0].documentstringDocumento
identifications[0].documentTypestring

Tipo do documento

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIDInternal -  ID interno

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

{
  "id":"001032001000103",
  "version":1,
  "orderNumber":1000103,
  "sheetNumber":0,
  "idStore":1,
   "identifications":[
    {
      "document":"",
      "documentType":"cdtCPF"
    },
    {
      "document":"-1",
      "documentType":"cdtIDInternal"
    }
  ]
}

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)


PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

idstring

Identificado único da resposta
versionInteger

Número da versão
preSalesArray object Json

Lista de pré-vendas
preSales[0].idStoreInteger3SimNúmero da loja
preSales[0].orderNumberDecimal14SimNúmero da pré-venda
preSales[0].headerobject Json

Dados do cabeçalho da pré-venda
preSales[0].header.identificationsArray object Json

Lista de documentos
preSales[0].header.identifications[0].documentString
SimDocumento
preSales[0].header.identifications[0].documentTypeString
Sim

Tipo do documento

cdtCPF - CFP sem formatação

cdtCNPJ - CNPJ  sem formatação

cdtIDInternal -  ID interno

preSales[0].header.statusString
Sim

Situação da pré-venda

sttBilled - Faturado
sttReleased - Liberado
sttFinancialReleased - Liberado financeiro
sttTyping - Digitação
sttScripted - Roterizado
sttSeparation - Separação
sttCanceled - Cancelado
sttPreSeparation - Pré-separação
sttSeparationAwaitingBilling - Separação aguardando para faturamento

preSales[0].header.orderKindstring
Não

Tipo da pré-venda

pstQuotation - Cotação (pode ser faturado mais de uma vez)
pstSale - Venda
pstSheet - Comanda
pstPopularPharmacy - Farmácia popular
pstCutLine - Papa-fila
pstSelfCheckoutSheet - Comanda Self-Checkout
pstPBM - PBM

preSales[0].header.loadStatusstring
Não

Situação da carga

lstGenerated - Carga gerada
lstExportedWMS - Exportado WMS
lstReleased - Liberado
lstBilled - Faturada
lstCanceled - Cancelada
lstPreSeparation - Pré-separação

preSales[0].header.loadNumberInteger8NãoNúmero da carga
preSales[0].header.sheetNumberInteger14NãoNúmero da comanda
preSales[0].header.expirationDateDate
SimData de validade
preSales[0].header.noteString250NãoObservação
preSales[0].header.dateTimeIssueDateTime
SimData de emissão
preSales[0].header.auxiliaryDocumentNumberInteger
NãoNúmero sequêncial para DAV (documento auxiliar de venda)
preSales[0].header.auxiliaryDocumentDateDate
NãoData do número do DAV
preSales[0].header.templatesPrintArray object Json

Lista de template para ser impressos
preSales[0].header.templatesPrint[0].TextString
NãoTexto a ser impresso
preSales[0].header.shippingValueCurrency
NãoValor do frete
preSales[0].header.idSegmentInteger3NãoNúmero do segmento
preSales[0].itemsArray object Json

Lista de item da pré-venda
preSales[0].items[0].itemNumberInteger
simNúmero de sequência do item na pré-venda
preSales[0].items[0].internalCodeInteger
simSequencial interno do produto
preSales[0].items[0].packingQuantityNumber
SimQuantidade embalagem
preSales[0].items[0].quantityNumber
SimQuatidade
preSales[0].items[0].unitPriceCurrency
SimPreço unitário do produto
preSales[0].items[0].discountPriceCurrency
NãoDesconto
preSales[0].items[0].statusString
Sim

Status do produto

Status do item

istSold - Venda
istCanceled - Vancelado 
istTransferred - Transferido 

preSales[0].items[0].sellerCodeInteger
NãoCódigo do vendedor
preSales[0].items[0].dateTimeIssueDateTime
SimData de Emissão
preSales[0].items[0].expeditionString
Não

Tipo da expedição

expHand - Entregar  
expPickUp - Retirar 
expDelivery - Delivery

preSales[0].items[0].batchCodeInteger
NãoCódigo do lote
preSales[0].items[0].quantityServedNumber
NãoQuantidade atendida
preSales[0].items[0].barCodeInteger14SimCódigo do produto/EAN
preSales[0].paymentsObject Json

Dados de pagamento
preSales[0].payments[0].itemNumberInteger5SimNúmero de sequência do pagamento na pré-venda
preSales[0].payments[0].dateTimeIssueDataTime
SimData e hora emissão
preSales[0].payments[0].paymentNumberInteger4SimNúmero da forma de pagamento
preSales[0].payments[0].valueCurrency9,2SimValor do pagamento
preSales[0].payments[0].increaseCurrency9,2NãoAcréscimo no pagamento
preSales[0].payments[0].discountCurrency9,2NãoDesconto no pagamento
preSales[0].payments[0].totalCurrency9,2SimTotal do pagamento

preSales[0].payments[0].transactionCode


String50Não

NSU número de sequência único do TEF ou 

NSU host número de sequência único do TEF gerado pela administradora

preSales[0].payments[0].networkCardString5NãoCódigo da rede do cartão no TEF
preSales[0].payments[0].firstDigitCardString9NãoNúmero do BIN do cartão no TEF
preSales[0].payments[0].flagCardString6NãoCódigo da bandeira do cartão no TEF
preSales[0].payments[0].modalityCardString4NãoModalidade do cartão TEF
preSales[0].payments[0].installmentAmountInteger2NãoQuantidade de parcelas do cartão no TEF
preSales[0].payments[0].statusString
Sim

Status do pagamento

pstPayment - Pagamento 
pstCancellation - Cancelamento

preSales[0].payments[0].templatesPrintArray object Json

Lista de template para ser impressos
preSales[0].payments[0].templatesPrint[0].TextString

Texto a ser impresso
preSales[0].payments[0].idWalletString8NãoID da carteira digital
preSales[0].payments[0].typeWalletString2NãoTipo da carteira digital
preSales[0].payments[0].coinString8NãoTipo de moeda utilizada
preSales[0].payments[0].ValueCoinDouble14, 7NãoValor da moeda utilizada

Formatos de Resposta (Response Formats)

application/json

Exemplo simplificado (Sample)


{
  "id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
  "version":1,
  "preSales":[
    {
      "idStore":1,
      "orderNumber":1000103,
      "idStore":1, 
      "header":{
        "identifications":[
          {
           "document":"12345678909",
           "documentType":"cdtCPF"
          }
        ],
        "status":"sttBilled",
        "expirationDate":"2023-01-25T00:00:00.000Z",
        "dateTimeIssue":"2023-01-15T00:00:00.000Z"
      },
      "items":[
        {
          "itemNumber":1,
          "internalCode":4900,
          "packingQuantity":1,
          "quantity":1,
          "unitPrice":5.00,
          "status":"istSold",
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "barCode":7891000100103
        },
        {
          "itemNumber":2,
          "internalCode":4900,
          "packingQuantity":1,
          "quantity":2,
          "unitPrice":5.00,
          "status":"istSold",
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "barCode":7891000100103
        }
      ],
      "payments":[
        {
          "itemNumber":1,
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "paymentNumber":1,
          "value":15.00,
          "total":15.00,
          "transactionCode":"",
          "networkCard":"",
          "firstDigitCard":"",
          "flagCard":"",
          "modalityCard":"",
          "installmentAmount":0,
          "status":"pstPayment",
          "idWallet":"",
          "typeWallet":""
        }
      ]
    }
  ]
}
application/json

Exemplo completo (Sample)

{
  "id":"16774AFE-12D7-4AD4-BCEF-1A3580B593F1",
  "version":1,
  "preSales":[
    {
      "idStore":1,
      "orderNumber":1000103,
      "header":{
        "identifications":[
          {
           "document":"12345678909",
           "documentType":"cdtCPF"
          }
        ],
        "status":"sttBilled",
        "orderKind":"pstQuotation",
        "loadStatus":"lstGenerated",
        "loadNumber":0,
        "sheetNumber":0,
        "expirationDate":"2023-01-25T00:00:00.000Z",
        "note":"",
        "dateTimeIssue":"2023-01-15T00:00:00.000Z",
        "auxiliaryDocumentNumber":0,
        "auxiliaryDocumentDate":"2023-01-15T00:00:00.000Z",
        "templatesPrint":[
          {
           "Text": ""
          }   
        ],
        "shippingValue":0,
        "idSegment":0
      },
      "items":[
        {
          "itemNumber":1,
          "internalCode":4900,
          "packingQuantity":1,
          "quantity":1,
          "unitPrice":5.00,
          "discountPrice":0,
          "status":"istSold",
          "sellerCode":0,
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "expedition":"expHand",
          "batchCode":0,
          "note":"",
          "quantityServed":0,
          "barCode":7891000100103
        },
        {
          "itemNumber":2,
          "internalCode":4900,
          "packingQuantity":1,
          "quantity":2,
          "unitPrice":10.00,
          "discountPrice":0,
          "status":"istSold",
          "sellerCode":0,
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "expedition":"expHand",
          "batchCode":0,
          "note":"",
          "quantityServed":0,
          "barCode":7891000100103
        }
      ],
      "payments":[
        {
          "itemNumber":0,
          "dateTimeIssue":"2023-01-15T00:00:00.000Z",
          "paymentNumber":1,
          "value":15.00,
          "increase":0,
          "discount":0,
          "total":15.00,
          "transactionCode":"",
          "networkCard":"",
          "firstDigitCard":"",
          "flagCard":"",
          "modalityCard":"",
          "installmentAmount":0,
          "status":"pstPayment",
          "templatesPrint":[
           {
            "Text": ""
           }   
          ],
          "idWallet":"",
          "typeWallet":"",
          "coin":"",
          "valueCoin":0
        }
      ]
    }
  ]
}