05. Modelo JSON pelo tipo de promoção

Última modificación por Mylena Gomes el 04/08/2026

O modelo JSON de uma promoção está composto por um cabeçalho comum e um detalhe variável dependendo do tipo de promoção indicado (ver Tipos de promoções).

Cabeçal

id

Código da promoção

titulo

Título da promoção

descripcion

Descrição da promoção

tipo

Tipos de promoções:

  • LLEVA_PAGA

  • ADICIONAL_DESCUENTO

  • ADICIONAL_REGALO

  • PRECIO_FIJO

  • DESCUENTO_VARIABLE

  • DESCUENTO_FIJO

detalle

Detalhe da promoção. JSON com a especificação particular da promoção. Variável segundo o tipo definido. O detalhe será analisado com mais detalhe na próxima tabela.

autor

Informação do autor. JSON com um único campo descripcion que indica quem foi o autor da promoção.

vigenciaDesde

Data a partir da qual a promoção está disponível.

vigenciaHasta

Data a partir da qual a promoção deixa de estar disponível.

Detalhes (campo detalle da tabela anterior)

condiciones

Lista de items que ativam a promoção no PDV em caso de uma venda. Cada elemento da lista inclui uma quantidade (campo cantidad) e uma lista de produtos (campo articulos) por código de barras. Cada uma dessas linhas representa uma regra que significa “se leva uma quantidade cantidad dos produtos com uma barra que está na lista articulos”.

Lista de meios de pagamento que ativam a promoção. Cada elemento indica uma possível forma de pagamento a ser usada para pagar a venda. Em cada caso, o tipo de pagamento é indicado (9 = Dinheiro, 10 = Cartão de Crédito, 11 = Cheque, 12 = Vale, 13 = Cartão de Débito), descrição (ex: "Cartão de crédito XXX"), código da moeda e lista do BIN's (para cartões). No caso de cartões, o BIN indicado na venda deve coincidir com os especificados nesta lista para que a promoção seja válida.

formasPago

Lista dos meios de pagamento que ativam a promoção. Cada elemento indica uma possível forma de pagamento a ser utilizada para a venda. Em cada caso, é indicado o tipo de pagamento (9 = dinheiro, 10 = cartão de crédito, 11 = cheque, 12 = vale, 13 = cartão de débito), descrição (por exemplo, "Cartão de crédito XXX"), código da moeda e lista de BINs (de cartões). No caso de cartões, o BIN indicado na venda deve corresponder aos especificados nesta lista para ser considerado válido.

gruposClientes

Lista de grupos de clientes que ativam a promoção. Cada elemento indica um grupo de clientes ao qual se aplica a promoção. Em cada caso, o tipo é indicado. No momento GLOBAL é o único valor possível, representando grupos definidos pela Scanntech.

beneficios

Lista de items para os quais é aplicado um benefício, por exemplo, os produtos de presente em um pack (ADICIONAL_REGALO) ou aqueles sobre os quais se aplica um desconto. Cada elemento da lista inclui uma quantidade (campo cantidad) e uma lista de produtos (campo articulos) por código de barras. Cada uma dessas linhas representa uma regra que significa “O beneficio se aplica a uma quantidade cantidad de produtos dentre aqueles que tenham alguma das barras definidas na lista articulos”.

precio

Valor fixo em caso de PRECIO_FIJO

descuento

Porcentagem de desconto (0-100) em caso de ADICIONAL_DESCUENTO o DESCUENTO_VARIABLE, ou ainda, um valor fixo de desconto no caso de DESCUENTO_FIJO

paga

Quantidade de items a pagar em caso de LLEVA_PAGA.

Exemplos dos distintos tipos de promoção existentes

Seguem alguns exemplos, da representação JSON correspondente ao campo detalle, para alguns dos tipo de promoção existente.

LLEVA_PAGA

“Levando 6 unidades de Fanta paga 4”

"detalles":{
    "condiciones":{
       "items":[
          {
             "cantidad":6,
             "articulos":[
                {
                     "codigoBarras":"7894900031607",
                     "nombre":"REFRIGERANTE LARANJA FANTA 600ML"
                },
                {
                     "codigoBarras":"7894900053630",
                     "nombre":"REFRIGERANTE UVA FANTA 600ML"
                },
                {
                     "codigoBarras":"7894900093261",
                     "nombre":"REFRIGERANTE GUARANÁ FANTA 600ML"
                }
             ]
          }
       ]
    },
    "beneficios":null,
    "precio":null,
    "descuento":null,
    "paga":4
}

ADICIONAL_DESCUENTO

“Levando 2 unidades de Fanta, desconto de 50% num alfajor”

"detalles":{
    "condiciones":{
       "items":[
          {
             "cantidad":2,
             "articulos":[
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"REFRESCO FANTA POMELO PET.600 ML"
                }
             ]
          }
       ]
    },
    "beneficios":{
       "items":[
          {
             "cantidad":1,
             "articulos":[
                {
                   "codigoBarras":"7790580651067",
                   "nombre":"ALFAJOR MILKA MOUSSE"
                }
             ]
          }
       ]
    },
    "precio":null,
    "descuento":50,
    "paga":null
}

ADICIONAL_REGALO

"Levando 2 unidades de Fernet, leva como presente umas papas Lay’s"

"detalles":{
    "condiciones":{
       "items":[
          {
             "cantidad":2,
             "articulos":[
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"FERNET DUVAL 750 ML."
                }
             ]
          }
       ]
    },
    "beneficios":{
       "items":[
          {
             "cantidad":1,
             "articulos":[
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"PAPAS LAYS 150 GRS"
                }
             ]
          }
       ]
    },
    "precio":null,
    "descuento":null,
    "paga":null
}

PRECIO_FIJO

"Levando 2 alfajores, paga $ 10"

"detalles": {
  "condiciones": {
      "items": [
        {
            "cantidad": 2,
            "articulos": [
                {
                     "codigoBarras":"7790580651067",
                     "nombre":"ALFAJOR MILKA MOUSSE"
                },
    {
                     "codigoBarras":"7896019601559",
                     "nombre":"ALFAJOR MILKA AO LEITE"
                }
            ]
        }
    ]
},
"beneficios": null,
"precio": 10,
"descuento": null,
"paga": null
}

DESCUENTO_VARIABLE

“Levando 2 produtos (Pepsi ou Fanta Pomelo), tem um desconto de 30% no preço total”

"detalles":{
    "condiciones":{
       "items":[
          {
             "cantidad":2,
             "articulos":[
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"REFRESCO PEPSI LIGHT PET.500 ML"
                },
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"REFRESCO FANTA POMELO PET.600 ML"
                }
             ]
          }
       ]
    },
    "beneficios":null,
    "precio":null,
    "descuento":30,
    "paga":null
 }
}

DESCUENTO_FIJO

“Levando 2 produtos (Pepsi ou Fanta Pomelo), tem um desconto de $10 no preço total”

"detalles":{
    "condiciones":{
       "items":[
          {
             "cantidad":2,
             "articulos":[
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"REFRESCO PEPSI LIGHT PET.500 ML"
                },
                {
                   "codigoBarras":"7790580651008",
                   "nombre":"REFRESCO FANTA POMELO PET.600 ML"
                }
             ]
          }
       ]
    },
    "beneficios":null,
    "precio":null,
    "descuento":10,
    "paga":null
 }
}