09 - Vender item

Objetivo

Utilizar nas seguintes operações Venda do item e cancelamento do item. Será enviado apenas um item.

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

Segurança

Se os parâmetros de autenticação estiverem configurados e o tipo de autenticação for Basic auth, será enviado no Header no formato Basic Authentication:

Authorization: Basic dGVzdGU6MTIz

Se os parâmetros de autenticação estiverem configurados e o tipo de autenticação for Bearer token(JWT), será enviado no Header no formato Bearer token:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTYiLCJuYW1lIjoidGVzdGUiLCJpYXQiOjE1MTYyM...

Parâmetros do Corpo (Body Parameters)

Parâmetro	Tipo	Descrição
Event	string	Tipo da execução cetContinue, cetInterrupt, cetFailed
id	string	Identificado único da requisição
version	string	Versão da API
Operation	String	cotSellItem - Esse vai ser o valor para esse evento
Sale	Objeto json	Objeto json da venda
Sale.Id	string	Identificado único da venda
Sale.Header	Objeto json	Objeto json do cabeçalho da venda
Sale.Header.AccountingDate	Date	Data do movimento
Sale.Header.DateTimeIssue	DateTime	Date de emissão
Sale.Header.IdDocument	Integer	Número do documento
Sale.Header.CooDocument	Integer	COO do documento
Sale.Header.IdStore	Integer	Número da empresa
Sale.Header.IdTerminal	Integer	Número do checkout
Sale.Header.IdUser	Integer	Número do usuário da venda
Sale.Items	Objeto json array	Produto vendido, cancelado ou não-registrado
Sale.Items[0].BarCode	String	Código de acesso do produto(EAN, GTIN13, GTIN14, etc)
Sale.Items[0].CaptionPacking	String	Unidade de medida do produto
Sale.Items[0].Description	String	Descrição do produto
Sale.Items[0].DiscountPrice	Currency	Desconto do item
Sale.Items[0].IdSegment	Integer	Número do segmento
Sale.Items[0].IncreasePrice	Currency	Acréscimo do item
Sale.Items[0].InternalCode	Integer	Número interno
Sale.Items[0].ExternalCode	Integer	Número externo
Sale.Items[0].ItemNumber	Integer	Número do item na venda
Sale.Items[0].PackingQuantity	Integer	Quando da embalagem
Sale.Items[0].Quantity	Double	Quantidade vendida do produto
Sale.Items[0].Scale	Boolean	Indica se o produto é pesável
Sale.Items[0].Status	String	sttValid - Item vendido sttCanceled - Item cancelado sttUnregistered - Item não registrado (não identificado ou não cadastrado)
Sale.Items[0].TotalPrice	Currency	Valor total do produto
Sale.Items[0].UnitPrice	Currency	Valor unitário do produto

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

{
  "Event":"cetAfter",
  "Execution":"cetContinue",
  "ID":"001032000943369",
  "Operation":"cotSellItem",
  "Version":1,
  "Sale":{
    "ID":"001032000943369",
    "Header":{
      "AccountingDate":"2023-03-09T00:00:00",
      "DateTimeIssue":"2023-03-09T16:12:16",
      "IdDocument":943369,
      "CooDocument": 527,
      "IdStore":1,
      "IdTerminal":32,
      "IdUser":2
    },
    "Items":[
      {
        "BarCode":"17",
        "CaptionPacking":"KG",
        "Description":"CARNE BOVINA kg 1C OSSO",
        "DiscountPrice":0,
        "IdSegment":3,
        "IncreasePrice":0,
        "InternalCode":"84",
        "ExternalCode":"555",
        "ItemNumber":1,
        "PackingQuantity":1,
        "Quantity":1,
        "Scale":true,
        "Status":"sttValid",
        "TotalPrice":1.19,
        "UnitPrice":1.19
      }
    ]
  }
}

Árvore de páginas