...

Bloco de código

language	text
theme	Emacs
title	Ejemplo

curl -X GET -H "Authorization: Bearer 8c014b30-a674-456e-bc18-29a072a7a1f8" -H "Content-type: application/json" -H "Accept: application/json" "http://localhost:8080/promo/api/rest/customer?code=1"

De la misma forma, el mismo request pero realizado en POSTMAN, sería:

Bloco de código

language	xml
theme	Emacs

http://localhost:8070/promo/api/rest/customer?code=1

Image Removed

Presionando el botón SEND se obtendrá como respuesta, los datos del cliente.para obtener el Token en POSTMAN, sería:

Debe seleccionar Type 0Auth 2.0
Indicar la URL de la versión a la cual se quiere conectar
Indicar ClientID
Indicar nombre de usuario y password

Image Added

5. Luego presionar el botón "Get New Access Token"

Image Added

6. Por último presionar el botón "Use Token"

Una vez obtenido el token, se puede enviar una solicitud, por ejemplo realizamos un GET:

Image Added

Al presionar el botón "Send", se obtiene el siguiente resultado:

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "_id": "64415ac9a62e433e0436b84b",
    "code": "2",
    "name": "sofia",
    "lastName": "gonzalez",
    "gender": "m",
    "birthDate": "1950-05-05T03:00:00Z",
    "identificationType": "le",
    "identifier": "222233",
    "identificationExpiration": "2060-06-06T03:00:00Z",
    "nacionality": "br",
    "email": "[email protected]",
    "customerType": "frecuente",
    "address": "calle 2",
    "addressCountry": "arg",
    "addressState": "bsas",
    "addressCity": "tig",
    "addressPostalCode": "2",
    "phone": "1566666666",
    "isActive": true,
    "segments": "",
    "companyId": "2",
    "creationDate": "2023-04-20T15:31:21Z",
    "cards": [
        {
            "_id": "649c76f7b29c1e11cc02cc2a",
            "amount": 200000.0,
            "code": "1000000019",
            "companyId": "2",
            "created": "2023-06-28T18:07:51Z",
            "isConsumed": false,
            "status": "ENABLED",
            "storeCode": "BLC",
            "terminalCode": "1_1-100",
            "transactionId": "BLC_202306281507861",
            "type": "1",
            "version": 3,
            "customerId": "2",
            "contractCode": "1",
            "activation": "2023-06-28T18:20:09Z",
            "typeName": "Tipo 1"
        },
        {
            "_id": "64d2acb914e33806ecc54531",
            "amount": 6000.0,
            "code": "1000000048",
            "companyId": "2",
            "created": "2023-08-08T20:59:37Z",
            "isConsumed": false,
            "status": "ENABLED",
            "storeCode": "BLC",
            "terminalCode": "1_1-100",
            "transactionId": "BLC_202308081759646",
            "type": "1",
            "version": 6,
            "activation": "2023-08-08T21:00:41Z",
            "customerId": "2",
            "contractCode": "1",
            "lastPurchaseDate": "2023-08-11T18:19:00Z",
            "typeName": "Tipo 1"
        }
    ],
    "coupons": []
}

...

Consola: Servicios REST de Consulta

...

Bloco de código

language	xml
theme	Emacs
title	Ejemplo

{
    "_id": "6054129516f79ab3103ad3ac",
    "companyId": "napse",
    "code": "s_verdes3095535912",
    "status": "ENABLED",
    "type": "s_verdes",
    "amount": 20.0,
    "customerId": "3095535912",
    "created": "2021-03-19T02:55:17Z",
    "activation": "2021-03-19T02:55:17Z",
    "transactionId": "napse_1_1_20210319203011",
    "storeCode": "1",
    "terminalCode": "1",
    "isConsumed": false,
    "version": 2,
    "lastPurchaseDate": "2021-03-19T02:56:30Z",
    "typeName": "StickersTarjetas Verdes",
    "cardHistory": [
        {
            "date": "2021-03-19T23:30:15Z",
            "createdAt": "2021-03-19T02:56:30Z",
            "card": "-",
            "cardAction": "SALE",
            "storeCode": "1",
            "terminalCode": "1",
            "appliedPromotionDetails": [
                {
                    "promotionName": "otorga StickersTarjetas Verdes-54",
                    "promotionCode": "54",
                    "conditionDateRangeDescription": null
                }
            ],
            "customerCode": "-",
            "amount": "20.0",
            "amountPrev": "0.0",
            "transactionId": "napse_1_1_20210319203015",
            "reasonName": null
        },
        {
            "date": "2021-03-19T02:55:17Z",
            "createdAt": "2021-03-19T02:55:17Z",
            "card": "-",
            "cardAction": "ACTIVATION",
            "storeCode": "1",
            "terminalCode": "1",
            "customerCode": "3095535912",
            "amount": "0.0",
            "amountPrev": "0",
            "appliedPromotionDetails": null,
            "transactionId": null,
            "reasonName": null
        }
    ],
    "amountPrev": 0
}

...

Bloco de código

language	xml
theme	Emacs
title	Promociones

<promoCoreRequest>
<operation>getPromotions</operation>
<companyId>2</companyId>
<params>
<promoName>Promo simulacion</promoName>     <promoCode>p70</promoCode>
     <store>1</store>
     <region>1</region
</params>
</promoCoreRequest>

...

Donde:

Operation (obligatorio): valor getPromotions para obtener promociones.

companyId (obligatorio): identificación o código de empresa la cual realiza el request.

stores store (opcional): Tiendas Tienda/s a la que pertenece la / las promociones.

regions region(opcional): Zonass Zona/s a la que pertenece la / las promociones.

promoCode (opcional): Código / os de promociones solicitadas

Image Added

La respuesta es del tipo:

Bloco de código

language	xml
theme	Emacs
title	getPromotions

<?xml version="1.0" encoding="iso-8859-1"?>
<promoCoreResponse>
  	<ack>0</ack>
  	<message value="" />
  	<promotions>
    		<promotion nro="6489c0f7a62e4343b821cc9764fb3542a62e43409cd6f32c" name="Promo simulacionprueba 7.0" code="p70"
			className="com.synthesis.promo.engine.promotion.ModularPromotion" reportParticipants="falsetrue" suggest="not">
      <sets>
        			<sets>
				<set name="6489c0fda62e4343b821cc9a64fb354ea62e43409cd6f32f" type="item" />
      			</sets>
      			<condition type="basic" name="Exists">
        				<parameter key="use-set" value="6489c0fda62e4343b821cc9a64fb354ea62e43409cd6f32f" />
      			</condition>
      <benefits>
        			<benefits>
				<benefit instance="PercentageDiscount" nro="6489c122a62e4343b821cc9d64fb3564a62e43409cd6f332">
          					<parameter key="displayMessage" value="Promo simulacionprueba 7.0" />
          					<parameter key="printerMessage" value="Promo simulacionprueba 7.0" />
          					<parameter key="TLOGMessage" value="Promo simulacionprueba 7.0" />
          					<parameter key="applicationMethod" value="resume" />
          					<parameter key="prorationMethod" value="proportional" />
          					<parameter key="applicationPriceType" value="benefited-price" />
          					<parameter key="name" value="6489c0f7a62e4343b821cc9764fb3542a62e43409cd6f32c" />
          					<parameter key="percent" value="50" />
           value="50" />
					<parameter key="unit" value="qty" />
          					<parameter key="prorateBCP" value="false" />
          					<parameter key="recoveryValue" value="0" />
          					<parameter key="recoveryType" value="" />
          					<applied-elements>
            						<use-set name="6489c0fda62e4343b821cc9a" max="1.064fb354ea62e43409cd6f32f" attribute="qty" />
          					</applied-elements>
        				</benefit>
      			</benefits>
    		</promotion>
  	</promotions>
</promoCoreResponse>

Donde se observa:

ack: resultado del request, donde 0 es procesamiento correcto. (Ver códigos de respuesta ack mas arriba en este documento).

message: es el mensaje de error resultante.

promotions: tag general que contiene los elementos promotion retornados en la respuesta. Cada elemento promotion, contiene todos los elementos y tags que contiene una promoción.

...

{ "companyId": "{{COMPANYID}}", "catalog": "CatalogCustomerType", "params": [], "items": [ {

.

Expandir

title	Importación Catálogo: Cliente, Tipo Identificación, Género y Tipo Cliente

Un cliente está conformado por los siguientes datos.

(Datos como gender, identificationType, customerType, addressCountry, addressState, y addressCity, corresponden al código de cada uno de ellos y deberán importarse previamente antes de realizar cualquier operación sobre un cliente. En el caso particular de addressCountry, addressState, y addressCity, deberán importarse en ese orden debido a que se validará que una provincia/estado esté dentro de un país, y que una ciudad esté dentro de una provincia.)

Campo	Tipo de dato	Observaciones
code	string	Corresponde al código que se le asignara al cliente en Promo. (requerido)
name	string	Nombre de cliente. (requerido)
lastName	string	Apellido del cliente. (requerido)
gender	string	Genero del cliente (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de género "catalogGender" previamente cargados.). Opcional
birthDate	string	Fecha de nacimiento del cliente. Formato: año-mes-día siendo el año de cuatro dígitos, y el mes y el día de dos dígitos. Opcional
identificationType	string	Tipo de identificación del cliente. (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de tipo de identificación "catalogIdType" previamente cargados.). Opcional
identifier	string	Numero de identificación del cliente. (requerido)
identificationExpiration	string	Fecha de expiración de la identificación del cliente. Opcional
nacionality	string	Nacionalidad del cliente. Opcional
email	string	e-Mail del cliente. Opcional
customerType	string	Tipo de cliente (requerido) / / (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de tipo cliente "catalogIdType" previamente cargados.)
address	string	Dirección del cliente. Opcional
addressCountry	string	País del cliente. (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de Pais "catalogCoutry" previamente cargados.). Opcional
addressState	string	Provincia de residencia del cliente. (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de Provincia "catalogState" previamente cargados.). Opcional
addressCity	string	Ciudad de residencia del cliente. (en caso de "Validar catálogos relacionados al catálogo de clientes" este en "true", el dato definido en este campo deberá coincidir con alguno de los códigos de Ciudad "catalogCity" previamente cargados.). Opcional
addressPostalCode	string	Código Postal. Opcional
phone	string	Teléfono. Opcional
isActive	booleano	Indicara si al momento del alta el cliente estará Activo o Inactivo. Deberá definirse como true o false. Requerido
segments	string	Segmento/s asociado al cliente. Opcional

{ "companyId": "napse", "catalog": "catalogCustomer", "params": [], "items": [{ "operation": "I", "code":"949450", "name":"John", "lastName":"Promo", "gender":"2", "birthDate":"03-05-1959

Bloco de código

language	xml
theme	Emacs

language	xml
theme	Emacs

{
    "companyId": "napse",
    "catalog": "catalogCustomer",
                "identificationType":"01",
    "params": [],
            "identifier":"4688779900",
                "identificationExpiration":"31-12-2030","items": [{
                "nacionality":"Arg",
                "email":"[email protected]""operation": "I",
                "customerTypecode":"111949450",
                "addressname":"Av.Livertad 123John",
                "addressCountrylastName":"100Promo",
                "addressStategender":"2002",
                "addressCitybirthDate":"30003-05-1959",
                "addressPostalCodeidentificationType":"999901",
                "phoneidentifier":"4578962034688779900",
                "isActiveidentificationExpiration":"true31-12-2030",
                "segments":"4650"
    }]
}

Cuando desde la consola se indique que deben de Validar catálogos relacionados al catálogo de clientes, sera requerida la carga de los catalogos relacionados previo a la carga del catalogo de cliente.

Se importan entonces las entidades relacionadas previo a la importación de los clientes.

Catálogo IDTYPE. Este catálogo define los tipos de documento o identificacion válidos.

Bloco de código

theme	Emacs

{
       "companyIdnacionality": "{{COMPANYID}}Arg",
                "catalogemail": "CatalogIdType[email protected]",
      "params": [],
    "items": [
    "customerType":"111",
    {
            "codeaddress":"Av.Livertad 123"dni",
                "descriptionaddressCountry": "Documento de identidad100",
                "operationaddressState": "I200",
        },
        {"addressCity":"300",
                "codeaddressPostalCode": "le9999",
                "descriptionphone": "Libreta de enrolamiento457896203",
                "operationisActive": "Itrue",
            }    "segments":"4650"
    }]
}

Catálogo GENDERCuando desde la consola se indique que deben de Validar catálogos relacionados al catálogo de clientes, sera requerida la carga de los catalogos relacionados previo a la carga del catalogo de cliente.

Se importan entonces las entidades relacionadas previo a la importación de los clientes.

Catálogo IDTYPE. Este catálogo define los tipos de género documento o identificacion válidos.

Bloco de código

theme	Emacs

{
    "companyId": "{{COMPANYID}}",
    "catalog": "CatalogGenderCatalogIdType",
    "params": [],
    "items": [
        {
            "code": "Mdni",
            "description": "MaleDocumento de identidad",
            "operation": "I"
        },
        {
            "code": "Fle",
            "description": "FemaleLibreta de enrolamiento",
            "operation": "I"
        }
    ]
}

Catálogo CUSTOMERTYPEGENDER. Este catálogo define los tipos de clientes género válidos

Bloco de código

theme	Emacs

Bloco de código

theme	Emacs

{
    "codecompanyId": "vip{{COMPANYID}}",
            "description"catalog": "Cliente vipCatalogGender",
            "operation"params": "I"[],
        },"items": [
        {
            "code": "goldM",
            "description": "Cliente goldMale",
            "operation": "I"
        },
        {
            "code": "silverF",
            "description": "Cliente silverFemale",
            "operation": "I"
        }
    ]
}

Catálogo COUNTRYCUSTOMERTYPE. Este catálogo define los países tipos de clientes válidos.

Bloco de código

theme	Emacs

{
    "companyId": "{{COMPANYID}}",
    "catalog": "CatalogCountryCatalogCustomerType",
    "params": [],
    "items": [
        {
            "code": "arvip",
            "description": "ArgentinaCliente vip",
            "operation": "I"
        },
        {
            "code": "itgold",
            "description": "ItaliaCliente gold",
            "operation": "I"
        },
        {
            "code": "essilver",
            "description": "EspañaCliente silver",
            "operation": "I"
        }
    ]
}

Catálogo STATECOUNTRY. Este catálogo define las provincias válidaslos países válidos.

Bloco de código

theme	Emacs

{
    "companyId": "{{COMPANYID}}",
    "catalog": "CatalogStateCatalogCountry",
    "params": [],
    "items": [
        {
            "code": "bsasar",
            "description": "Buenos AiresArgentina",
            "country": "ar",
            "operation": "I"
        },
        {
            "code": "corit",
            "description": "CórdobaItalia",
            "country": "ar",
            "operation": "I"
        },
    ]
}

Catálogo CITY. Este catálogo define las ciudades válidas

Bloco de código
{ "companyId": "{{COMPANYID}}", "catalog": "CatalogCity", "params": [], "itemscode": [ "es", { "code"description": "tigEspaña", "descriptionoperation": "TigreI", } ] }

Catálogo STATE. Este catálogo define las provincias válidas.

Bloco de código

theme	Emacs

{
    "statecompanyId": "bsas{{COMPANYID}}",
            "operationcatalog": "ICatalogState",
    "params": [],
     },"items": [
        {
            "code": "lmbsas",
            "description": "LosBuenos molinosAires",
            "statecountry": "corar",
            "operation": "I"
        },
        {
            "code": "sidrcor",
            "description": "San isidroCórdoba",
            "statecountry": "bsasar",
            "operation": "I"
        }
    ]
}

Importación de nuevos clientes.

Una vez realizadas las importaciones anteriores, y considerando sus códigos, se pueden realizar altas, modificaciones, y eliminaciones de clientes.

Por ej. en este caso se dan de alta dos clientes:

Bloco de código

theme	Emacs

Catálogo CITY. Este catálogo define las ciudades válidas

Bloco de código

{
    "companyId": "{{COMPANYID}}",
    "catalog": "CatalogCustomerCatalogCity",
    "params": [],
    "items": [
        {
            "code": "cod1tig",
            "namedescription": "AlbertoTigre",
            "lastNamestate": "Pérezbsas",
            "genderoperation": "MI",
        },
    "birthDate": "1950-01-01",    {
            "identificationTypecode": "lelm",
            "identifierdescription": "11112222Los molinos",
            "identificationExpirationstate": "2050-01-01cor",
            "nacionalityoperation": "argentinoI",
            "email": "[email protected]"},
            "customerType": "vip",{
            "addresscode": "diagonal 12 2233sidr",
            "addressCountrydescription": "arSan isidro",
            "addressStatestate": "bsas",
            "addressCityoperation": "tigI",
        }
    "addressPostalCode": "2222",
      ]
}

Importación de nuevos clientes.

Una vez realizadas las importaciones anteriores, y considerando sus códigos, se pueden realizar altas, modificaciones, y eliminaciones de clientes.

Por ej. en este caso se dan de alta dos clientes:

{ "companyId": "2"

"catalog":

"catalogCustomer", "params":

[],

"items": [

"operation": "I",

"code": "

8

cod2",

"name": "

John

Ángela",

"lastName": "

Promo

Gonzales",

"gender": "

h

F",

"birthDate": "

03

1960-

05

01-

1959

01",

"identificationType": "dni",

"identifier": "

4688779900

99998888",

"identificationExpiration": "

31

2050-

12

01-

2030

01",

"nacionality": "

Arg

argentina",

"email": "

John@Promo

angela@gmail.com",

"customerType": "

EMPLEADO

gold",

"address":

"Av.Livertad 123

 "diagonal 50 2211",

"addressCountry": "

arg

ar",

"addressState": "

bsas

cor",

"addressCity": "

tig

lm",

"addressPostalCode": "

9999

5050",

            "phone": "

457896203

55555555",

"isActive": "true",

segments

operation": "

4650

I"

,

"condiva":"Responsable Inscripto"

}

]
}

Bloco de código

theme	Emacs

{
      "phonecompanyId": "11111111{{COMPANYID}}",
            "isActive"catalog": "true",
       CatalogCustomer",
     "operationparams": "I"[],
        },"items": [
        {
            "code": "cod2cod1",
            "name": "ÁngelaAlberto",
            "lastName": "GonzalesPérez",
            "gender": "FM",
            "birthDate": "19601950-01-01",
            "identificationType": "dnile",
            "identifier": "9999888811112222",
            "identificationExpiration": "2050-01-01",
            "nacionality": "argentinaargentino",
            "email": "angela@gmailalberto@gmail.com",
            "customerType": "goldvip",
            "address": "diagonal 5012 22112233",
            "addressCountry": "ar",
            "addressState": "corbsas",
            "addressCity": "lmtig",
            "addressPostalCode": "50502222",
            "phone": "5555555511111111",
            "isActive": "true",
            "operation": "I"
        }
    ]
}

Aviso

title	IMPORTANTE

Cuando se agrega un atributo de elemento a un cliente; éste se debe agregar en el Json al importar el catálogo de cliente

Bloco de código

language	xml
theme	Emacs
title	Importación de catalogo de clientes

Eliminación y actualización de clientes.

En el siguiente ejemplo, se elimina el primer cliente (campo operation en R) y se actualiza el segundo cliente (campo operation en U) cambiando el email y el teléfono

Bloco de código

theme	Emacs

Aviso

title	IMPORTANTE

Cuando se agrega un atributo de elemento a un cliente; éste se debe agregar en el Json al importar el catálogo de cliente

Bloco de código

language	xml
theme	Emacs
title	Importación de catalogo de clientes

{
    "companyId": "

2",
    "catalog": "

CatalogCustomer

catalogCustomer",
    "params": [],
    "items": [{

{

 "operation": "I",
                "code":

cod1

8",
                "name":

Alberto

John",
                "lastName":

Pérez

Promo",
                "gender":

M

h",
                "birthDate":

1950

03-

01

05-

01

1959",
                "identificationType":

le

dni",
                "identifier":

11112222

4688779900",
                "identificationExpiration":

2050

31-

01

12-

01

2030",
                "nacionality":

argentino

Arg",
                "email":

alberto@gmail

John@Promo.com",
                "customerType":"EMPLEADO",

"vip

           "address":"Av.Livertad 123",
                "

address

addressCountry":"arg",

"diagonal 12 2233",

 "addressState":"bsas",
                "addressCity":"tig",
                "

addressCountry

addressPostalCode":

ar

9999",
                "

addressState

phone":

bsas

457896203",
                "

addressCity

isActive":

tig

true",
                "

addressPostalCode

segments":

2222

4650",
                "

phone

condiva":"Responsable

"11111111

Inscripto"

,

}]
}

Eliminación y actualización de clientes.

En el siguiente ejemplo, se elimina el primer cliente (campo operation en R) y se actualiza el segundo cliente (campo operation en U) cambiando el email y el teléfono

Bloco de código

theme	Emacs

{
       "isActivecompanyId": "true{{COMPANYID}}",
    "catalog": "CatalogCustomer",
       "operationparams": "R"[],
        },"items": [
        {
            "code": "cod2cod1",
            "name": "ÁngelaAlberto",
            "lastName": "GonzalesPérez",
            "gender": "FM",
            "birthDate": "19601950-01-01",
            "identificationType": "dnile",
            "identifier": "9999888811112222",
            "identificationExpiration": "2050-01-01",
            "nacionality": "argentinaargentino",
            "email": "gonzales@gmailalberto@gmail.com",
            "customerType": "goldvip",
            "address": "diagonal 5012 22112233",
            "addressCountry": "ar",
            "addressState": "corbsas",
            "addressCity": "lmtig",
            "addressPostalCode": "50502222",
            "phone": "9090909011111111",
            "isActive": "true",
            "operation": "UR"
        },
    ]
}

Expandir

title	Importación Catalogo Departamento

Para la importación de Departamentos por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

    {
   "companyId         "code": "napsecod2",
   "catalog         "name": "catalogDepartmentÁngela", 

            "paramslastName": []"Gonzales",
    "items": [
        {"gender": "F",
            "codebirthDate": "Elec1960-01-01",
            "nameidentificationType": "Electronicsdni",
            "operationidentifier": "I99998888",

        },
        {"identificationExpiration": "2050-01-01",
            "codenacionality": "Packargentina",
            "nameemail": "Pack[email protected]",
            "operationcustomerType": "Igold",

        },
    "address": "diagonal 50  {2211",
            "codeaddressCountry": "Almaar",
            "nameaddressState": "Almacéncor",
            "operationaddressCity": "Ilm",

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
"addressPostalCode": "5050",
       "status": "200",
    "descriptionphone": "catalogDepartment90909090",
    "detail": {
        "resultisActive": "oktrue",
            "detailoperation": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."U"
        }
    }]
}

Expandir

title	Importación Catalogo EventoDepartamento

Para la importación de Catálogo de Evento Departamentos por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogEventTransactioncatalogDepartment", 
   "params": [],
    "items": [
        {
            "code": "50Elec",
            "name": "Evento 1Electronics",
            "operation": "I"

        },
        {
            "code": "51Pack",
            "name": "Evento 2Pack",
            "operation": "I"

        },
        {
            "code": "52Alma",
            "name": "Evento 3Almacén",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	Inputoutput

{
    "status": "200",
    "description": "catalogEventTransactioncatalogDepartment",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo Tipo TransacciónEvento

Para la importación de Tipos Catálogo de Transacción Evento por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogEventTransactionTypecatalogEventTransaction", 
   "params": [],
    "items": [
        {
            "code": "BIG50",
            "name": "BIGEvento TICKET1",
            "operation": "I"

        },
        {
            "code": "VEM51",
            "name": "VENTAEvento EMPLEADO2",
            "operation": "I"

        },
        {
            "code": "REG52",
            "name": "MESAEvento DE REGALOS3",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	outputInput

{
    "status": "200",
    "description": "catalogEventTransactionTypecatalogEventTransaction",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo FamiliaTipo Transacción

Para la importación de Familia Tipos de Transacción por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	Inputinput

{
   "companyId":"napse",
   "catalog":"catalogFamilycatalogEventTransactionType", 
   "params": [],
    "items": [
        {
            "code": "PrinBIG",
            "name": "PrintersBIG TICKET",
            "operation": "I"

        },
        {
            "code": "LaptVEM",
            "name": "LaptopsVENTA EMPLEADO",
            "operation": "I"

        },
        {
            "code": "DVDPREG",
            "name": "DVDMESA DE PlayersREGALOS",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
    "status": "200",
    "description": "catalogFamilycatalogEventTransactionType",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo CategoríaFamilia

Para la importación de Categoría Familia por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	inputInput

{
   "companyId":"napse",
   "catalog":"catalogCategorycatalogFamily", 
   "params": [],
    "items": [
        {
            "code": "PS3G",
            "name": "PS3 VideogamesPrin",
            "familyCodename": "VGCoPrinters",
            "operation": "I"

        },
        {
            "code": "AlmaCarLapt",
            "name": "Caramelos",
            "familyCode": "AlmaDu"Laptops",
            "operation": "I"

        },
        {
            "codeTypecode": "AlmaConDVDP",
            "name": "Confites",
            "familyCode": "AlmaDu"DVD Players",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
    "status": "200",
    "description": "catalogCategorycatalogFamily",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo SubcategoríaCategoría

Para la importación de Subcategoría Categoría por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogSubCategorycatalogCategory", 
   "params": [],
    "items": [
        {
            "code": "AlmaDesPS3G",
            "name": "DescafeinadoPS3 Videogames",
            "categoryCodefamilyCode": "AlmaCafVGCo",
            "operation": "I"

        },
        {
            "codeTypecode": "AlmaInsAlmaCar",
            "name": "InstantaneoCaramelos",
            "categoryCodefamilyCode": "AlmaCafAlmaDu",
            "operation": "I"

        },
        {
            "codeType": "AlmaCapAlmaCon",
            "name": "En cápsulasConfites",
            "categoryCodefamilyCode": "AlmaCafAlmaDu",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	outuptoutput

{
    "status": "200",
    "description": "catalogSubCategorycatalogCategory",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo FormatoSubcategoría

Para la importación de Formato Subcategoría por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogFormatcatalogSubCategory", 
   "params": [],
    "items": [
        {
            "code": "111AlmaDes",
            "name": "Formato ADescafeinado",
            "categoryCode": "AlmaCaf",
            "operation": "I"

        },
        {
            "codeType": "112AlmaIns",
            "name": "Formato B"Instantaneo",
            "categoryCode": "AlmaCaf",
            "operation": "I"

        },
        {
            "codeType": "113AlmaCap",
            "name": "En cápsulas",
    "Formato C        "categoryCode": "AlmaCaf",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	outputoutupt

{
    "status": "200",
    "description": "catalogFormatcatalogSubCategory",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Expandir

title	Importación Catalogo ÍtemFormato

Para la importación de Ítem Formato por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogItem", 
   "params": [],
    "items": [
        {
            "code": "111",
            "name": "PlayStation 4",
            "unitpricecatalog": "1000.00catalogFormat", 
            "level1"params": "Gen"[],
    "items": [
       "level2": "Cat11", {
            "level3code": "SubCat11111",
            "level4name": "1Formato A",
            "supplieroperation": "1I",

        },
    "brand": "Consola Sony Play Station 4 Ps4 1206 500 Gb",
            "detail": "Modelo: Playstation 4 1206&nbsp    {
            "codeType": "112",
            "detail2name": "Incluye cable de alimentaci&oacuteFormato B",
            "operation": "I"

        },
        {
            "codecodeType": "112113",
            "name": "XBOXFormato OneC",
            "unitepriceoperation": "9900.00I",

        }
    "level1": "Gen",
     ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
    "status": "200",
    "level2description": "Cat11catalogFormat",
    "detail": {
        "level3result": "SubCat12ok",
              "level4detail": "1",
            "supplier": "1",
            "brand": "Xbox One X 1tb, 4k", 
            "detail": "XBOX One X cuenta con reproductor 4K HDR, y te permite grabar y transmitir tus partidas en 4K 60 FPS a través de MixerSe generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

Expandir

title	Importación Catalogo Ítem

Para la importación de Ítem por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
   "companyId":"napse",
   "catalog":"catalogItem", 
   "params": [],
    "items": [
        {
            "code": "111",
            "detail2name": "Disfruta de tus películas favoritas gracias al reproductor Blu-ray 4K Ultra HD o disfruta de apps como NetFlix.PlayStation 4",
            "unitprice": "1000.00",
            "operationlevel1": "IGen",

        },
        {"level2": "Cat11",
            "codelevel3": "113SubCat11",
            "namelevel4": "Nintendo Switch1",
            "unitepricesupplier": "13300.001",
            "level1brand": "Gen",
            "level2": "Cat11Consola Sony Play Station 4 Ps4 1206 500 Gb",
            "detail": "Modelo: Playstation 4 1206&nbsp",
            "level3detail2": "SubCat13Incluye cable de alimentaci&oacute",
            "level4": "1",
            "supplieroperation": "1I",

            "brand": "Consola Nintendo},
 Switch 32gb Neon",      {
            "detail": "La consola Nintendo Switch está diseñada para acompañarte dondequiera que vayas, transformándose de consola para el hogar a consola portátil en un instante."code": "112",
            "name": "XBOX One",
             "detail2": "Memoria Interna 32GB de memoria NAND"uniteprice": "9900.00",
            "operationlevel1": "IGen",

           }
 "level2": "Cat11,
        ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
    "statuslevel3": "200SubCat12",
            "descriptionlevel4": "catalogItem1",
            "detailsupplier": {"1",
              "resultbrand": "okXbox One X 1tb, 4k", 
              "detail": "Se generóXBOX One X cuenta con reproductor éxito4K elHDR, registroy dete importación.permite Puedegrabar very sutransmitir estadotus correspondientepartidas en el monitor4K 60 FPS a través de importación.Mixer",
    }
}

Expandir

title	Importación Catalogo Tiendas

Para la importación de Tiendas por medio del servicio REST, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
        "companyIddetail2":"napse "Disfruta de tus películas favoritas gracias al reproductor Blu-ray 4K Ultra HD o disfruta de apps como NetFlix.",
   "catalog         "operation": "catalogStoreI", 

   "params": [],
    "items": [ },
        {
            "code": "1113",
            "name": "TiendaNintendo 1Switch",
            "operationuniteprice": "I13300.00"
,
        },
        {"level1": "Gen",
            "codelevel2": "2Cat11",
            "namelevel3": "Tienda 2SubCat13",
            "level4": "1",
            "operationsupplier": "I1"

        },
,
            "brand": "Consola Nintendo Switch 32gb Neon",      
   {
         "detail": "La consola Nintendo Switch está diseñada  "code": "3",
            "name": "Tienda 3para acompañarte dondequiera que vayas, transformándose de consola para el hogar a consola portátil en un instante.",
            "detail2": "Memoria Interna 32GB de memoria NAND",
            "operation": "I"

        }
          ]


}

Bloco de código

language	xml
theme	Emacs
title	output

{
    "status": "200",
    "description": "catalogStorecatalogItem",
    "detail": {
        "result": "ok",
        "detail": "Se generó con éxito el registro de importación. Puede ver su estado correspondiente en el monitor de importación."
    }
}

...

Aviso

Al importar una promoción se debe tener en cuenta el workflow asociado al usuario que está llevando a cabo la importación.

Si el usuario no tiene asociado un workflow (en la vista Administración de Usuarios/Asociación a workflows)

,

la

promoción

misma se importará con el

primer workflow de la lista de asociación.

El usuario tiene asociado un workflow, la promoción se importará con el workflow asociado al usuario.

El usuario tiene asociado más de un workflow, la promoción se importará con el primer workflow de la lista. Dicha lista está ordenada en forma alfabética; no por orden de creación

workflow general por default.

...

Servicio de

...

Canje de Puntos Por Catalogo

Como soporte al Nuevo beneficio de Canje de Puntos por Catalogo (ver mas arriba), se deben especificar la tabla de productos que poseen equivalente en puntos a través de un catalogo definido para tal uso.

...

Así tendremos que un ejemplo de request para insertar registros en este catálogo será:

Bloco de código

language	jsxml
theme	RDarkEmacs
linenumbers	true

{
    "companyId": "napse",
    "catalog": "CatalogRedeemBenefit",
    "params": [],
    "items": [
        {
            "store": "1",
            "code": "10",
            "points": "10.5",
            "discountValue":"15" ,
            "discountType": "perc",
            "operation": "I"
        },
        {
            "store": "1",
            "code": "20",
            "points": "20.5",
            "discountValue":"20" ,
            "discountType": "fix",
            "operation": "I"
        },
        {
            "store": "1",
            "code": "30",
            "points": "50",
            "discountValue":"25" ,
            "discountType": "nprice",
            "operation": "I"
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 21

Nova versão Atual

Chave

Consola: Servicios REST de Consulta

Servicio de

Canje de Puntos Por Catalogo

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 21

Nova versão Atual

Chave

Consola: Servicios REST de Consulta

Servicio de

Canje de Puntos Por Catalogo