Histórico da Página

...

Realiza a exportação de vendas feita feitas nos PDVs.

Chamada

POST {url}

...

PARÂMETRO	TIPO	DESCRIÇÃO
ID	String	Identificador único da venda
Version	String	Versão da API
Sale	Object Json	Venda
Sale.Increase	Currency	Acréscimo aplicado na venda
Sale.Discount	Currency	Desconto aplicado no venda
Sale.ID	String	Identificador único da venda
Sale.Sale.Total	Currency	Valor total da venda
Sale.header	Object Json	Cabeçalho da venda
Sale.header.idStore	Integer	Identificador da loja que gerou a venda
Sale.header.idTerminal	Integer	Identificador do terminal/checkout que gerou a venda
Sale.header.idDocument	Integer	Identificador da venda
Sale.header.idUser	Integer	Identificador do operador que realizou a venda
Sale.header.status	String	Status da venda sttValid - Vendido sttCanceled - Cancelada
Sale.header.idInvoiceKey	String	Chave da venda gerada para acessar o documento na SEFAZ
Sale.header.accountingDate	Date	Data da emissão da venda
Sale.header.dateTimeIssue	DateTime	Data e hora da emissão da venda
Sale.payments	Array object Json	Lista de pagamentos
Sale.payments[0].increase	Currency	Acréscimo aplicado no pagamento
Sale.payments[0].Discount	Currency	Desconto aplicado no pagamento
Sale.payments[0].total	Currency	Valor pago
Sale.payments[0].paymentType	String	Espécie de pagamento cptMoney - Espécie dinheiro; cptDebitCard - Espécie cartão de débito; cptCreditCard - Espécie cartão de crédito; cptBillet - Espécie boleto; cptCheck - Espécie cheque; cptPOS - Espécie POS; cptPaperTicket - Espécie ticket; cptAgreement - Espécie convênio; cptPromissoryNote - Espécie nota promissório; cptFinancialCredit - Espécie crédito financeira; cptWorthDebit - Espécie vale débito; cptWorthCredit - Espécie vale crédito; cptDigitalWallet - Espécie carteira digital;
Sale.payments[0].paymentNumber	Integer	Número da forma de pagamento
Sale.payments[0].dateTimeIssue	DateTime	Data e hora do pagamento
Sale.items	Array object Json	Item da venda
Sale.items[0].internalCode	Integer	Código interno do item
Sale.items[0].itemNumber	Integer	Código item na venda
Sale.items[0].status	String	Status do item sttValid - Vendido sttCanceled - Cancelada
Sale.items[0].unitPrice	Currency	Valor unitário do item
Sale.items[0].increasePrice	Currency	Acréscimo aplicado no item
Sale.items[0].discountPrice	Currency	Desconto aplicado no item
Sale.items[0].captionPacking	String	Descrição da unidade
Sale.items[0].barCode	String	EAN do produto vendido
Sale.items[0].quantity	Integer	Quantidade do item
Sale.items[0].description	String	Descrição do item
Sale.items[0].totalPrice	Currency	Valor total liquido do item
Sale.items[0].sellerCode	Integer	Código do vendedor
Sale.items[0].idSegment	Integer	Identificador no segmento do item
Sale.items[0].dateTimeIssue	DateTiem	Data e hora e emissão do item

...

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

...

Tipos de documento do cliente

Parâmetro

Tipo

Descrição

Document

String

Número do documento de
identificação da pessoa

DocumentType

String

Tipo de documento de identificação

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIE - Inscrição estadual

cdtRG - RG

...

Tipo de pessoa

cktPhysical - Física
cktLegal - Jurídica

...

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

...

Órgão público

yntYes - Sim
yntNo - Não

...

Situação do crédito

ccsAlert - Alerta
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso

...

Situação comercial

bstReleased - Liberado
bstBlocked - Bloqueado

...

Tipo do endereço

katMain - Principal
katCharge - Cobrança
katDelivery - Entrega
katCorrespondence - Correspondência
katPickUp - Retirada

...

Formatos de Resposta (Response Formats)

application/json

...

Bloco de código

language	actionscript3

{
  "id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person": {
    "documents":[
      {
        "document":"91347879846",
        "documentType":"cdtCPF"
      },
      {
        "document":"253716652",
        "documentType":"cdtRG"
      }
    ],
    "Name": "Edson Luan Bernardo Nogueira",
    "kind": "cktPhysical",
    "addresses": [
      {
        "kindAddress": "katMain",
        "publicPlace": "Rua Baiacu",
        "publicPlaceNumber": "482",
        "neighbourhood": "Eldorado",
        "complement": "",
        "city": "Diadema",
        "federativeUnit": "SP",
        "zipCode": "14065540",
        "iBGE": 1234
      }
    ]
  }
}

application/json

...

language	actionscript3

...

Responder com o HTTP Status Code 200

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

Chamada

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

Formatos de Resposta (Response Formats)

application/json

application/json