Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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 estiver configurado for Basic auth, será enviado no Header no formato Basic Authentication.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âmetroTipoDescrição
EventstringTipo da execução cetContinue, cetInterrupt, cetFailed
idstringIdentificado único da requisição
versionstring

Versão da API

OperationStringcotSellItem -  Esse vai ser o valor para esse evento
SaleObjeto jsonObjeto json da venda
Sale.IdstringIdentificado único da venda
Sale.HeaderObjeto jsonObjeto json do cabeçalho da venda
Sale.Header.AccountingDateDateData do movimento
Sale.Header.DateTimeIssueDateTimeDate de emissão
Sale.Header.IdDocumentIntegerNúmero do documento
Sale.Header.CooDocumentIntegerCOO do documento
Sale.Header.IdStoreIntegerNúmero da empresa
Sale.Header.IdTerminalIntegerNúmero do checkout
Sale.Header.IdUserIntegerNúmero do usuário da venda
Sale.ItemsObjeto json arrayProduto vendido, cancelado ou não-registrado
Sale.Items[0].BarCodeStringCódigo de acesso do produto(EAN, GTIN13, GTIN14, etc)
Sale.Items[0].CaptionPackingStringUnidade de medida do produto
Sale.Items[0].DescriptionStringDescrição do produto
Sale.Items[0].DiscountPriceCurrencyDesconto do item
Sale.Items[0].IdSegmentIntegerNúmero do segmento
Sale.Items[0].IncreasePriceCurrencyAcréscimo do item
Sale.Items[0].InternalCodeIntegerNúmero interno
Sale.Items[0].ExternalCodeIntegerNúmero externo
Sale.Items[0].ItemNumberIntegerNúmero do item na venda
Sale.Items[0].PackingQuantityIntegerQuando da embalagem
Sale.Items[0].QuantityDoubleQuantidade vendida do produto
Sale.Items[0].ScaleBooleanIndica se o produto é pesável
Sale.Items[0].StatusString

sttValid - Item vendido

sttCanceled - Item cancelado

sttUnregistered - Item não registrado (não identificado ou não cadastrado)

Sale.Items[0].TotalPriceCurrencyValor total do produto
Sale.Items[0].UnitPriceCurrencyValor unitário do produto

Formatos de Requisição (Request Formats)

...

Bloco de código
languageactionscript3
{
  "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
      }
    ]
  }
}

...