Histórico da Página
Objetivo
Realiza a exportação de vendas feita nos PDVs.
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 Authentication.
| Bloco de código |
|---|
Authorization: Basic dGVzdGU6MTIz |
Parâmetros do Corpo (Body Parameters)
| PARÂMETRO | TIPO | DESCRIÇÃO |
|---|---|---|
| ID | String | Identificador único da venda |
| Version | String | Versão da API |
| Sale | Object Json | Venda |
| Increase | Currency | Acréscimo aplicado na venda |
| Discount | Currency | Desconto aplicado no venda |
| Total | Currency | Valor total da venda |
| header | Object Json | Cabeçalho da venda |
| idStore | Integer | Identificador da loja que gerou a venda |
| idTerminal | Integer | Identificador do terminal/checkout que gerou a venda |
| idDocument | Integer | Identificador da venda |
| idUser | Integer | Identificador do operador que realizou a venda |
| status | String | Status da venda sttValid - Vendido sttCanceled - Cancelada |
| payments | Array object Json |
Formatos de Requisição (Request Formats)
application/json
Exemplo (Sample)
| Bloco de código | ||
|---|---|---|
| ||
{
"ID":"001032000942933",
"version":1,
"sale":{
"iD":"001032000942933",
"increase":0,
"discount":0,
"total":15,
"header":{
"idStore":1,
"idTerminal":32,
"idDocument":942933,
"idUser":2,
"status":"sttValid",
"idInvoiceKey":"35221207363764000352651030000001001213154121",
"accountingDate":"2022-12-20T00:00:00.000Z",
"dateTimeIssue":"2022-12-20T09:35:17.000Z"
},
"payments":[
{
"increase":0,
"installmentAmount":0,
"itemNumber":1,
"total":15,
"discount":0,
"paymentType":"cptMoney",
"paymentNumber":1,
"dateTimeIssue":"2022-12-20T09:35:20.000Z"
}
],
"items":[
{
"internalCode":"4900",
"itemNumber":1,
"status":"sttValid",
"unitPrice":5,
"increasePrice":0,
"captionPacking":"UN",
"packingQuantity":1,
"barCode":"7891000100103",
"quantity":1,
"description":"LEITE COND MOCA LATA 395G",
"totalPrice":5,
"discountPrice":0,
"sellerCode":0,
"idSegment":3,
"dateTimeIssue":"2022-12-20T09:35:17.000Z"
},
{
"internalCode":"4900",
"itemNumber":2,
"status":"sttValid",
"unitPrice":5,
"increasePrice":0,
"captionPacking":"UN",
"packingQuantity":1,
"barCode":"7891000100103",
"quantity":1,
"description":"LEITE COND MOCA LATA 395G",
"totalPrice":5,
"discountPrice":0,
"sellerCode":0,
"idSegment":3,
"dateTimeIssue":"2022-12-20T09:35:17.000Z"
},
{
"internalCode":"4900",
"itemNumber":3,
"status":"sttValid",
"unitPrice":5,
"increasePrice":0,
"captionPacking":"UN",
"packingQuantity":1,
"barCode":"7891000100103",
"quantity":1,
"description":"LEITE COND MOCA LATA 395G",
"totalPrice":5,
"discountPrice":0,
"sellerCode":0,
"idSegment":3,
"dateTimeIssue":"2022-12-20T09:35:17.000Z"
}
]
}
} |
Informações para Resposta (Response Information)
Parâmetros do Corpo (Body Parameters)
| PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| documents | Object Json | Sim | Tipos de documento do cliente
| ||||||||||
| Name | String | 50 | Sim | Nome | |||||||||
| String | 80 | Não | Email do cliente | ||||||||||
| Kind | String | Sim | Tipo de pessoa cktPhysical - Física | ||||||||||
| Taxpayer | String | Não | Contribuinte de ICMS yntYes - Sim | ||||||||||
| PublicAgency | String | Não | Órgão público yntYes - Sim | ||||||||||
| TaxRegime | Integer | 5 | Não | Regime de tributação | |||||||||
| GlobalLimit | Double | 9, 2 | Não | Valor limite global | |||||||||
| Deadline | Integer | 3 | Não | Prazo máximo em dias | |||||||||
| CreditStatus | String | Não | Situação do crédito ccsAlert - Alerta | ||||||||||
| Note | String | 250 | Não | Observação | |||||||||
| CardNumber | Integer | 15 | Não | Número do cartão | |||||||||
| BusinessSituation | String | Não | Situação comercial bstReleased - Liberado | ||||||||||
| KindAddress | String | Sim | Tipo do endereço katMain - Principal | ||||||||||
| PublicPlace | String | 60 | Sim | Descrição do logradouro | |||||||||
| PublicPlaceNumber | String | 10 | Não | Número do logradouro | |||||||||
| Neighbourhood | String | 50 | Sim | Descrição do bairro | |||||||||
| Complement | String | 60 | Não | Complemento de endereço | |||||||||
| City | String | 60 | Sim | Nome da cidade | |||||||||
| FederativeUnit | String | 2 | Sim | Estado da cidade | |||||||||
| ZipCode | Integer | 8 | Sim | Cep sem formatação | |||||||||
| IBGE | Integer | 12 | Não | Código da cidade no IBGE |
Formatos de Resposta (Response Formats)
application/json
Exemplosimplificado(Sample)
| Bloco de código | ||
|---|---|---|
| ||
{
"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
Exemplocompleto(Sample)
| Bloco de código | ||
|---|---|---|
| ||
{
"id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
"version": 1,
"person": {
"documents":[
{
"document":"91347879846",
"documentType":"cdtCPF"
},
{
"document":"253716652",
"documentType":"cdtRG"
}
],
"Name": "Antonio Arthur João da Mota",
"email":"[email protected]",
"kind":"cktPhysical",
"taxpayer":"yntNo",
"publicAgency":"yntNo",
"customer":{
"globalLimit":0,
"deadline":0,
"creditStatus":"ccsReleased",
"note":"",
"cardNumber":0,
"businessSituation":"bstReleased"
},
"addresses": [
{
"kindAddress": "katMain",
"publicPlace": "Rua Nestor Ferreira da Rocha",
"publicPlaceNumber": "368",
"neighbourhood": "Vila Iolanda II",
"complement": "",
"city": "São Paulo",
"federativeUnit": "SP",
"zipCode": "08473400",
"iBGE": 1234
}
]
}
} |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas