Versões comparadas

Chave

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


Image Removed
MANUAL DE LENGUAJE DE PROMOCIONESImage Added



PROMO 7.1

...

- Manual de Lenguaje de Promociones




Painel
borderColor#E4E3E3
titleColor#ffffff
borderWidth1
titleBGColor#704581
titleCONTENIDO


Expandir
titleExpandir contenido
Índice



Propósito y alcance


El presente manual pretende mostrar los pasos para definir promociones vía formato Json para luego importarlas vía Servicio REST o RabbitMQ. La información aquí presentada es válida también para el formato xml de promociones, al respecto se presenta un ejemplo operativo para que a partir de los mapas xml de Promo se puedan obtener las definiciones en formato Json de las promociones.

...

CampoDetalle

name

Es el identificador unívoco del set. Este id va a ser referenciado tanto en las condiciones como en el conjunto de aplicación del beneficio.

type

El code del elemento, sus valores posibles son:

Valor

Descripción

customer

Clientes

benefit

Beneficio externo

coupon

Cupones

event

Eventos

item

Productos

loyaltycard

Tarjetas de fidelidad

payment

Medios de Pago

intersection

Crear un "AND" para más de una condición

union

Crear un "OR" para más de una condición

Para los "type" de "intersection" y "union" se necesita poner una lista de sets. Puede tener intersección dentro de unión y unión dentro de intersección.

attribute

Es el código del Atributo de los elementos. Sus valores posibles son:

Valor

Descripción

Valor de Type

code

Codigo (SKU)

item

unitprice

Precio unitario

item

brand

Marca

item

supplier

Proveedor

item

level1

Departamento

item

level2

Familia

item

level3

Categoria

item

level4

Sub Categoria

item

qty

Cantidad

item

magnitude

Magnitud

item

xprice

Precio total

item

all

Aplica a TODOS

item

discontinuous

Discontinuo

item

lowTurnover

Baja Rotacion

item

keyProduct

Producto Estrella

item

id

Id

coupon

type

Tipo

coupon

qty

Cantidad

coupon

amount

Monto

coupon

all

Aplica a TODOS

coupon

id

Id

customer

type

Tipo

customer

points

Puntos

customer

amount

Saldo

customer

remainingAmount

Monto restante

customer

segment

Segmento

customer

profileCode

Perfil de cliente

customer

creditCampaignCode

Campaña crediticia

customer

all

Aplica a TODOS

customer

redeemPointsPriceFactor

redeemPointsPriceFactor

customer

id

Numero

event

type

Tipo de Transacción

event

value

Valor

event

all

Aplica a TODOS

event

id

Codigo

payment

type

Tipo

payment

bank

Banco

payment

plan

Plan

payment

installments

Cuotas

payment

amount

Monto

payment

itemamount

Monto del Ítem

payment

prefix

Prefijo

payment

all

Aplica a TODOS

payment

payCreditCampaign

Campaña crediticia

payment

prefixGroup

Grupo de Prefijos

payment

pocket

Bolsillo

payment

id

Id

benefit

type

Tipo de beneficio

benefit

amount

Monto

benefit

benefitType

Tipo de beneficio

benefit


comparator

Es el código del comparador de los atributos de los elementos. Sus valores posibles son:

Valor

Descripción

GreaterThan

MAYOR

Distinct

DISTINTO

LessThan

MENOR

Into

IGUAL


value

El valor


A continuación se muestra un ejemplo donde el conjunto es para todos los productos con código igual a 111:

Bloco de código
titleEjemplo Json
"set": {
 	"name": "6171aabde830a52d9c434b95",
	"type": "item",
	"attribute": "code",
	"comparator": "Into",
	"value": "111"
	}	"value": "111"
	}


El siguiente es un ejemplo donde el conjunto es para todos los productos con level1 igual a maderas y que el tipo de pago sea tarjeta:

Bloco de código
titleEjemplo 2 Json
"set": [
                    {
                        "name": "5feaf1324b10b84760e83f37",
                        "type": "item",
                        "attribute": "level1",
                        "comparator": "Into",
                        "value": "maderas"
                    },
                    {
                        "name": "5feaf13a4b10b84760e83f3a",
                        "type": "payment",
                        "attribute": "type",
                        "comparator": "Into",
                        "value": "card"
                    }
          ]


El siguiente es un ejemplo donde el conjunto es para todos los productos con level1 igual a maderas y que el tipo de pago sea tarjetase utiliza el "type" "union":

Bloco de código
titleEjemplo 2 3 Json
"set": [{
           "name": "6171aabde830a52d9c434b95",
            {"type": "union",
           "set" :[
            "name": "5feaf1324b10b84760e83f37",         {
                         "type": "item",
                         "attribute": "level1",
                         "comparator": "Into",
                         "value": "maderas"
                      },
                     {
                         "nametype": "5feaf13a4b10b84760e83f3apayment",
                         "typeattribute": "paymenttype",
                         "attributecomparator": "typeInto",
                         "comparatorvalue": "Intocard",
                        "value": "card"}
                   ]
 }
        }  ]


Ejemplo con una Condición Simple:

...

CampoDetalle

type

El tipo de condición. Sus valores son: (basic o composite). "Basic" es que la promoción tiene solo una condición (condición simple) y "composite" que es una condición por composición o sea un combo.

name

Es el método de la condición, sus valores son:

Valor

Descripción

Between


DayFrequence


WeekFrequence


DayMonthFrequence


DayOfTheMonthFrequence


WeekDay


DayMonth


EqualOrMoreThan


MoreThan


EqualOrLessThan


LessThan


PaymentTotalBenefitedItems


Exists


Distinct

Distinct (solamente de transacciones)

Header

IGUAL (solamente en transacciones)


parameter

Son una lista de los parámetros de la condición. Tiene dos valores “key” y “value”. El elemento “key” puede tener 2 valores:
      - “use-set” que hace referencia a la lista del set y su valor es lo mismo que tiene el "name" del set.

      - “attribute” con esta “Key” el “value” puede tener varios valores. Los valores de “vaule” además del valor real de la condición son los code:

Con los elementos “Distinct” y “Header” en la condición con “Transacción” sus “value” son distintas de los además.


Los de transición son:

Valor

Descripción

subZone

Sub Zone

zone

Zone

format

Format

storeChain

StoreChain

currencyCode

CurrencyCode

channel

Channel

store

Tienda

terminal

Terminal


Los demás son (cuando no son “Transacción”):

Valor

Descripción

Valor del Type

code

Codigo (SKU)

Item

unitprice

Precio unitario

Item

brand

Marca

Item

supplier

Proveedor

item

level1

Departamento

item

level2

Familia

item

level3

Categoria

item

level4

Sub Categoria

item

qty

Cantidad

item

magnitude

Magnitud

item

xprice

Precio total

item

all

Aplica a TODOS

item

discontinuous

Discontinuo

item

lowTurnover

Baja Rotacion

item

keyProduct

Producto Estrella

item

id

Id

coupon

type

Tipo

coupon

qty

Cantidad

coupon

amount

Monto

coupon

all

Aplica a TODOS

coupon

id

Id

customer

type

Tipo

customer

points

Puntos

customer

amount

Saldo

customer

remainingAmount

Monto restante

customer

segment

Segmento

customer

profileCode

Perfil de cliente

customer

creditCampaignCode

Campaña crediticia

customer

all

Aplica a TODOS

customer

redeemPointsPriceFactor

redeemPointsPriceFactor

customer

id

Numero

event

type

Tipo de Transacción

event

value

Valor

event

all

Aplica a TODOS

event

id

Codigo

payment

type

Tipo

payment

bank

Banco

payment

plan

Plan

payment

installments

Cuotas

payment

amount

Monto

payment

itemamount

Monto del Ítem

payment

prefix

Prefijo

payment

all

Aplica a TODOS

payment

payCreditCampaign

Campaña crediticia

payment

prefixGroup

Grupo de Prefijos

payment

pocket

Bolsillo

payment

id

Id

benefit

type

Tipo de beneficio

benefit

amount

Monto

benefit

benefitType

Tipo de beneficio

benefit


Algunos ejemplos cuando usamos atributo (attribute):

Observe que siempre hay que tener un set con el “type”,  cuando no es condición de una “Transacción”.

Json Ejemplo con transacción 

[…]

 {

      "type": "basic",

       "name": "Header",

        "parameter": [

                                   {

                                     "key": "attribute",

                                     "value": "store"

                                      },

                                      {

                                      "key": "value",

                                      "value": "666"

                                       }

                                    ]

 }

[…]


Json Ejemplo sin transacción 
 

"set": [

              {

                "name": "61126855e830a505e41642a3",

                "type": "item"

              },
[...]

"type": "basic",

"name": "EqualOrMoreThan",
"parameter": [

              {

                "key": "use-set",

                "value": "61126855e830a505e41642a3"

              },

              {

                "key": "attribute",

                "value": "xprice"

              },

              {

                "key": "value",

                "value": "1000"

              }

            ] 


Este ejemplo muestra que hay una condición simple con el precio total de todos los items (SKU) con valor mayor o igual a 1000.

...

CampoDetalle

type

Tipo de condición. Sus valores son: (basic o composite).

name

Esta es la operación sobre la condición, sus posibles valores son:

Operación

SIMPLE

AND

OR

NOT

AND_NOT

OR_NOT


condition

Una lista de condiciones.

...

CampoDetalle

min

cantidad mínima

max

cantidad máxima

attribute

Son las Unidades de medida (están diferenciadas por el tipo (type) y por el set (use-set) )

Valor

Descripción

Valor del Type

qty

Cantidad

item

magnitude

Magnitud

item

xprice

Precio total

item

qty

Cantidad

coupon

amount

Monto

coupon

points

Puntos

customer

amount

Saldo

customer

amount

Monto

payment

itemamount

Monto del Ítem

payment

amount

Monto

loyaltycard


use-set

Es la relación con la lista de sets.

order-criteria

Es el Criterio de ordenamiento. Los posibles valores son:

Valor

Nombre

OneLessExpensive

Uno mas barato por condicion

LessExpensiveFirst

Los mas baratos primero

OneMoreExpensive

Uno mas caro por condicion

MoreExpensiveFirst

Los mas caros primero


equivalence-attribute

Es el Atributo de equivalencia (si tiene). Los posibles valores son:

Valor

Descripción

Valor del Type

unitprice

Precio unitario

item

code

Codigo (SKU)

item

brand

Marca

item

supplier

Proveedor

item

level1

Departamento

item

level2

Familia

item

level3

Categoria

item

level4

Sub Categoria

item

all

Aplica a TODOS

item

discontinuous

Discontinuo

item

lowTurnover

Baja Rotacion

item

keyProduct

Producto Estrella

item

productCode

Cod. Producto

item

barcode

Cod. Barra Producto

item

id

Id

coupon

type

Tipo

coupon

qty

Cantidad

coupon

amount

Monto

coupon

all

Aplica a TODOS

coupon

type

Tipo

customer

profileCode

Perfil de cliente

customer

creditCampaignCode

Campaña crediticia

customer

id

Codigo

payment

type

Tipo

payment

bank

Banco

payment

plan

Plan

payment

installments

Cuotas

payment

itemamount

Monto del Ítem

payment

prefix

Prefijo

payment

all

Aplica a TODOS

payment

payCreditCampaign

Campaña crediticia

payment

prefixGroup

Grupo de Prefijos

payment

pocket

Bolsillo

payment

type

Tipo

loyaltycard

contract

Convenio

loyaltycard


inequivalence-attribute


Es el Atributo de inequivalencia (si tiene). Los posibles valores son:

Valor

Descripción

Valor del Type

brand

Marca

item

code

Codigo (SKU)

item

unitprice

Precio unitario

item

supplier

Proveedor

item

level1

Departamento

item

level2

Familia

item

level3

Categoria

item

level4

Sub Categoria

item

qty

Cantidad

item

magnitude

Magnitud

item

xprice

Precio total

item

all

Aplica a TODOS

item

discontinuous

Discontinuo

item

lowTurnover

Baja Rotacion

item

keyProduct

Producto Estrella

item

redeemOption

redeemOption

item

productCode

Cod. Producto

item

barcode

Cod. Barra Producto

item

id

Id

coupon

type

Tipo

coupon

qty

Cantidad

coupon

amount

Monto

coupon

all

Aplica a TODOS

coupon

type

Tipo

customer

profileCode

Perfil de cliente

customer

creditCampaignCode

Campaña crediticia

customer

id

Codigo

payment

type

Tipo

payment

bank

Banco

payment

plan

Plan

payment

installments

Cuotas

payment

amount

Monto

payment

itemamount

Monto del Ítem

payment

prefix

Prefijo

payment

all

Aplica a TODOS

payment

payCreditCampaign

Campaña crediticia

payment

prefixGroup

Grupo de Prefijos

payment

pocket

Bolsillo

payment

type

Tipo

loyaltycard

contract

Convenio

loyaltycard



Json de Beneficios

El elemento “benefits” es un objeto que tiene una lista de beneficios (“benefit”) que tiene la promoción con sus parámetros particulares. Aquí se muestra un ejemplo con dos beneficios uno con Cupón Calculado y otro con Beneficio Externo.

...

instance

Son los códigos (code) del tipo de beneficio. Estos son los posibles valores de ese campo:

Valor

Descripción

CalculatedCouponApplicationBenefit

Aplicación de Cupón Calculado

WalletBenefit

Beneficio Monedero

ContractPercentageDiscount

Descuento por convenio

RedeemPointsBenefit

Redención de Puntos

CalculatedCouponBenefit

Cupón Calculado

CatalogRedeemBenefit

Canje de Puntos por Catálogo

RedeemWithOptionsBenefit

Canje con Opciones

ExternalBenefit

Beneficio Externo

BankRefundBenefit

Reintegro bancario

PercentLoyaltyBenefit

Porcentaje de fidelización

GeneralBenefit

Beneficio General

GiftBenefit

Regalo

PaymentPlanBenefit

Plan de pagos

CouponBenefit

Cupón

FactorLoyaltyBenefit

Coeficiente de fidelización

LoyaltyBenefit

Puntos de fidelización

PercentageDiscount

Descuento porcentaje

FixedDiscount

Descuento fijo

NewPrice

Nuevo precio


nro

Es el id de la base de datos cuando hace las operaciones (U: Actualizar / R: Cancelación) es un campo requerido.

Parameter

Es la lista de parámetros que tienen los tipos de beneficio. Aquí se muestran parámetros que tienen todos los beneficios y otros que son exclusivos. En el campo "Key code" se muestra la "key". El campo "value" son los valores (los que están en blanco son insertados por el usuario), algunos de ellos tienen valores predefinidos (Options values (codes)) como se ve abajo.

Parámetros generales:

Options value (codes)

Key code

Descripción


displayMessage


Mensaje en POS


TLOGMessage


Coca + Papas, lleva las papas gratis


printerMessage


Mensaje en impresora


account


Cuenta contable

{"code" : "cheapest-first","name" : "Mas baratos primero"

}


prorationMethod


Método de prorrateo 

{"code" : "most-expensive-first","name" : "Mas caros primero"}


prorationMethod

Método de prorrateo 

{"code" : "proportional","name" : "Proporcional"}

prorationMethod

Método de prorrateo 

{"code" : "benefited-price","name" : "Precio beneficiado"

}

applicationPriceType


Aplicar sobre.. 

{"code" : "original-price","name" : "Precio original"}

applicationPriceType


Aplicar sobre.. 

{"code" : "resume","name" : "Resumen"}

applicationMethod


Método de aplicación

{"code" : "lineByLine","name" : "Linea a linea"}

applicationMethod


Método de aplicación


name


El número de la promoción se necesita cuando se hacen las operaciones (U: Actualizar / R: Cancelar )


Parámetros exclusivos:

Key codeRequeridoDescripciónTipo de beneficioOptions value (Code)Options value (Name)
externalAmountfalsePrecio informado por el POSNuevo precio

newpricefalseEl siguiente precio ($)Nuevo precio

unitfalsePor cada unidad deNuevo precioqtyCantidad
unitfalsePor cada unidad deNuevo preciomagnitudeMagnitud
unitfalsePor cada unidad deNuevo precionaTodo
recoveryValuefalseValor del RecuperoNuevo precio

recoveryTypefalseTipo de RecuperoNuevo preciopPorcentaje
recoveryTypefalseTipo de RecuperoNuevo precioaMonto fijo
prorateBCPfalseProrratear entre participantesNuevo precio

amounttrueEl siguiente monto ($)Descuento fijo

unitfalsePor cada unidad deDescuento fijoqtyCantidad
unitfalsePor cada unidad deDescuento fijomagnitudeMagnitud
unitfalsePor cada unidad deDescuento fijonaTodo
recoveryValuefalseValor del RecuperoDescuento fijo

recoveryTypefalseTipo de RecuperoDescuento fijopPorcentaje
recoveryTypefalseTipo de RecuperoDescuento fijoaMonto fijo
prorateBCPfalseProrratear entre participantesDescuento fijo

percenttrueEl siguiente porcentaje (%)Descuento porcentaje

unitfalsePor cada unidad deDescuento porcentajeqtyCantidad
unitfalsePor cada unidad deDescuento porcentajemagnitudeMagnitud
unitfalsePor cada unidad deDescuento porcentajenaTodo
recoveryValuefalseValor del RecuperoDescuento porcentaje

recoveryTypefalseTipo de RecuperoDescuento porcentajepPorcentaje
recoveryTypefalseTipo de RecuperoDescuento porcentajeaMonto fijo
prorateBCPfalseProrratear entre participantesDescuento porcentaje

valuetrueOtorgar puntos (cantidad)Puntos de fidelización

typetrueDe tipoPuntos de fidelización

unitfalsePor cada unidad dePuntos de fidelizaciónqtyCantidad
unitfalsePor cada unidad dePuntos de fidelizaciónmagnitudeMagnitud
unitfalsePor cada unidad dePuntos de fidelizaciónnaTodo
trxPointsLimitfalseMáximo de puntos por transacciónPuntos de fidelización

recoveryValuefalseValor del RecuperoPuntos de fidelización

recoveryTypefalseTipo de RecuperoPuntos de fidelizaciónpPorcentaje
recoveryTypefalseTipo de RecuperoPuntos de fidelizaciónaMonto fijo
ignorePaidInPointsfalseIgnorar Pagado con PuntosPuntos de fidelización

typetrueOtorgar puntos de tipoCoeficiente de fidelización

factortrueCon el siguiente factorCoeficiente de fidelización

trxPointsLimitfalseMáximo de puntos por transacciónCoeficiente de fidelización

recoveryValuefalseValor del RecuperoCoeficiente de fidelización

recoveryTypefalseTipo de RecuperoCoeficiente de fidelizaciónpPorcentaje
recoveryTypefalseTipo de RecuperoCoeficiente de fidelizaciónaMonto fijo
ignorePaidInPointsfalseIgnorar Pagado con PuntosCoeficiente de fidelización

qtytrueOtorgar cupones (cantidad)Cupón

couponidtrueDe tipo/identificadorCupón

infoPostrueDatos para el POSCupón0nameInfoPos0
infoPostrueDatos para el POSCupón1nameInfoPos1
infoPostrueDatos para el POSCupón2nameInfoPos2
recoveryValuefalseValor del RecuperoCupón

recoveryTypefalseTipo de RecuperoCupónpPorcentaje
recoveryTypefalseTipo de RecuperoCupónaMonto fijo
paymentplanidtrueOtorgar el plan de pagosPlan de pagos

paymentplanvtolidfalsePlan de Pago VtolPlan de pagos

typetruePara tipo de pagoPlan de pagos

tendertrueCon medio de pagoPlan de pagos

installmentstrueCuotasPlan de pagos

bankfalseDel bancoPlan de pagos

limitamountfalseMonto limitePlan de pagos

prefixesfalsePrefijoPlan de pagos

percentfalseCon un PorcentajePlan de pagos

percenttypefalseDe (Descuento/Recargo)Plan de pagosindistinctIndistinto
percenttypefalseDe (Descuento/Recargo)Plan de pagosdiscountDescuento
percenttypefalseDe (Descuento/Recargo)Plan de pagossurchargeRecargo
installmentsToDisplayfalseCuotas a mostrar en el POSPlan de pagos

pocketfalseBolsilloPlan de pagos

recoveryValuefalseValor del RecuperoPlan de pagos

recoveryTypefalseTipo de RecuperoPlan de pagospPorcentaje
recoveryTypefalseTipo de RecuperoPlan de pagosaMonto fijo
vtoloperationtypefalseOperationType VtolPlan de pagos

qtytrueOtorgar regalos (cantidad)Regalo

giftidtrueCon ID de regaloRegalo

gifttypetrueY tipo de regaloRegalo

recoveryValuefalseValor del RecuperoRegalo

recoveryTypefalseTipo de RecuperoRegalopPorcentaje
recoveryTypefalseTipo de RecuperoRegaloaMonto fijo
qtytrueCantidad de beneficios generalesBeneficio General

generalidtrueCon IDBeneficio General

generaltypetrueY tipoBeneficio General

recoveryValuefalseValor del RecuperoBeneficio General

recoveryTypefalseTipo de RecuperoBeneficio GeneralpPorcentaje
recoveryTypefalseTipo de RecuperoBeneficio GeneralaMonto fijo
percenttrueOtorgar un porcentaje del precio en puntosPorcentaje de fidelización

typetrueDe tipoPorcentaje de fidelización

trxPointsLimitfalseMáximo de puntos por transacciónPorcentaje de fidelización

recoveryValuefalseValor del RecuperoPorcentaje de fidelización

recoveryTypefalseTipo de RecuperoPorcentaje de fidelizaciónpPorcentaje
recoveryTypefalseTipo de RecuperoPorcentaje de fidelizaciónaMonto fijo
ignorePaidInPointsfalseIgnorar Pagado con PuntosPorcentaje de fidelización

paymentplanidtruebankRefoundBenefit-Otorgar el plan de pagosReintegro bancario

paymentplanvtolidfalsePlan de Pago VtolReintegro bancario

typetruebankRefoundBenefit-Para tipo de pagoReintegro bancario

tendertruebankRefoundBenefit-Con medio de pagoReintegro bancario

installmentstruebankRefoundBenefit-CuotasReintegro bancario

bankfalsebankRefoundBenefit-Del bancoReintegro bancario

limitamountfalsebankRefoundBenefit-Monto limiteReintegro bancario

prefixesfalsebankRefoundBenefit-PrefijoReintegro bancario

percenttruebankRefoundBenefit-Con un PorcentajeReintegro bancario

percenttypefalsebankRefoundBenefit-De (Descuento/Recargo)Reintegro bancariodiscountDescuento
pocketfalsebankRefoundBenefit-Del bolsilloReintegro bancario

recoveryValuefalseValor del RecuperoReintegro bancario

recoveryTypefalseTipo de RecuperoReintegro bancariopPorcentaje
recoveryTypefalseTipo de RecuperoReintegro bancarioaMonto fijo
vtoloperationtypefalseOperationType VtolReintegro bancario

typetrueDe tipoBeneficio Externo

recoveryValuefalseValor del RecuperoBeneficio Externo

recoveryTypefalseTipo de RecuperoBeneficio ExternopPorcentaje
recoveryTypefalseTipo de RecuperoBeneficio ExternoaMonto fijo
prorateBCPfalseProrratear entre participantesBeneficio Externo

recoveryValuefalseValor del RecuperoCanje con Opciones

recoveryTypefalseTipo de RecuperoCanje con OpcionespPorcentaje
recoveryTypefalseTipo de RecuperoCanje con OpcionesaMonto fijo
typetrueTipo tarjeta canje puntos por catalogoCanje de Puntos por Catalogo

recoveryValuefalseValor del RecuperoCanje de Puntos por Catalogo

recoveryTypefalseTipo de RecuperoCanje de Puntos por CatalogopPorcentaje
recoveryTypefalseTipo de RecuperoCanje de Puntos por CatalogoaMonto fijo
prorateBCPfalseProrratear entre participantesCanje de Puntos por Catalogo

couponidtrueTipoAplicacion de Cupón Calculado

recoveryValuefalseValor del RecuperoAplicacion de Cupón Calculado

recoveryTypefalseTipo de RecuperoAplicacion de Cupón CalculadopPorcentaje
recoveryTypefalseTipo de RecuperoAplicacion de Cupón CalculadoaMonto fijo
prorateBCPfalseProrratear entre participantesAplicacion de Cupón Calculado

couponidtrueTipoCupón Calculado

amountApplicationTypetrueTipo de aplicacion de montoCupón CalculadopercentageCupón calculado - aplicación del monto por porcentaje
amountApplicationTypetrueTipo de aplicacion de montoCupón CalculadofixedAmountCupón calculado - aplicación del monto por monto fijo
amountApplicationTypetrueTipo de aplicacion de montoCupón CalculadoexternalAmountCupón calculado - aplicación del monto por monto externo
calculatedCouponValuetrueValor del tipo de cupón calculadoCupón Calculado

qtytrueCantidadCupón Calculado

recoveryValuefalseValor del RecuperoCupón Calculado

recoveryTypefalseTipo de RecuperoCupón CalculadopPorcentaje
recoveryTypefalseTipo de RecuperoCupón CalculadoaMonto fijo
accumulateInSingleCouponfalseAcumular el monto de beneficios en un cupón únicoCupón Calculado

typetrueTipoRedención de Puntos

factortrueTipoRedención de Puntos

recoveryValuefalseValor del RecuperoRedención de Puntos

recoveryTypefalseTipo de RecuperoRedención de PuntospPorcentaje
recoveryTypefalseTipo de RecuperoRedención de PuntosaMonto fijo
prorateBCPfalseProrratear entre participantesRedención de Puntos

percentfalseCon un PorcentajeDescuento por convenio

unitfalsePor cada unidad deDescuento por convenioqtyCantidad
unitfalsePor cada unidad deDescuento por conveniomagnitudeMagnitud
unitfalsePor cada unidad deDescuento por convenionaTodo
balancefalseBalanceDescuento por conveniobalance1Balance 1
balancefalseBalanceDescuento por conveniobalance2Balance 2
recoveryValuefalseValor del RecuperoDescuento por convenio

recoveryTypefalseTipo de RecuperoDescuento por conveniopPorcentaje
recoveryTypefalseTipo de RecuperoDescuento por convenioaMonto fijo
prorateBCPfalseProrratear entre participantesDescuento por convenio

wallettrueMonederoBeneficio Monedero

limitAmounttrueLimiteBeneficio Monedero

percenttruePorcentajeBeneficio Monedero


applied-elements

Es el Json de la aplicación de la promoción

...

CampoDetalle

name

Referencia a un set

order-criteria

Son los Criterios de ordenamento, sus posibles valores son :

Valor

Descripción

MoreExpensiveFirst

Los mas caros primero

LessExpensiveFirst

Los mas baratos primero


max

Es la Aplicación máxima (valor)

min

Es el Descuento mínimo a aplicar

attribute

Es la Aplicación máxima (medida), sus posibles valores son :

Valor

Descripción

qty

Cantidad

magnitude

Magnitud

xprice

Precio total



Escalones:

Son Escalones de la definición de promociones escalonadas de un beneficio.

...

unit

Es laUnidad de Escalonada.  Sus posibles valores son:

Valor

Descripción

qty

Cantidad

magnitude

Magnitud

xprice

Precio total


staggeredStep

Es una lista de la definición de la Escalones, sus campos son:

CampoDescripción

nro

Número de la base de datos cuando se hacen las operaciones (U: Actualizar / R: Cancelar ) es un dato requerido.

min

Ocurrencias mínimas

max

Ocurrencias máximas

applyValue

Es el Valor




Ejemplos

Ejemplo 1:

El siguiente es un ejemplo donde se inserta una nueva promoción con una condición simple y tiene un beneficio monedero.

...

Una buena práctica cuando iniciamos en la confeccion confección del Json es tomar una promocion promoción de un mapa existente o bien definirla en consola y obtener el mapa en formato xml para convertirlo en el Json equivalente y así poder por comparación lograr una comprensión para luego ya confeccionarlos por otros medios.

...

4. Resultado

Promo importada y creada correctamente en la consola de Promo:


Importación de Promoción con tipo, subtipo y forma de aplicación:

Si se tiene una promoción con tipo, subtipo y forma de aplicación: 

Image Added

Estas propiedades no son  propias del mapa:

Image Added

pero se pueden agregar manualmente:

Image Added

y se importará la promoción con su tipo, subtipo y forma de aplicación.