CRM 360  - Integración de Promociones




REVISIONES


Fecha

Versión

Autor

Descripción

 

1.0Versión Inicial

 

1.15.0Viviana García Igualación Documento a versión actual



CONTENIDO



Acerca del documento

CRM360 es una solución de Napse para analizar la conducta y el comportamiento de compra de sus clientes, promoviendo así, potenciales oportunidades de interés y retención. 

Este manual está destinado a todos los sistemas de punto de venta que se integren con CRM360 mediante el uso de servicio REST o por Archivo.

A continuación, se dará detalle del servicio REST disponible y el de Archivo, destinado a nutrir la base de datos de promociones.



Importación de Promociones

Mediante API REST 

Este método posee la especificación detallada ante la creación o actualización de promociones.

Este servicio permite el envío de hasta 100 datos.


Método REST basado en el formato JSON. Ejemplo:

EndPoint

[POST] https://[dirección-ip]:[puerto]/api/v1/importData/promotions

POST - REQUEST

HEADER

Elemento

Valor

x-access-token
Token obtenido a través del servicio "Authenticate"

Ejemplo:

x-access-token:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE


BODY

Ejemplo con POSTMAN: Content Type - raw JSON

Elemento

Descripción

Tipo de dato

Requerido

companyCodeCódigo de compañía, provisto para la empresa que contrata el servicio.StringSi
lotNúmero de identificación de loteStringNo
promotions
Listado de PromocionesJSONSi


{
      "companyCode":"napse",
      "lot":"100005043",
      "promotions": [...]
}



Mediante ARCHIVO

Este método posee la especificación detallada ante la creación o actualización de promociones.

Este servicio permite el envío de hasta 100 datos.


Método REST basado en el formato JSON. Ejemplo:

EndPoint

[POST] https://[dirección-ip]:[puerto]/api/v1/importData/blob/promotions


POST - REQUEST

HEADER

Elemento

Valor

x-access-token
Token obtenido a través del servicio "Authenticate"

Ejemplo:

x-access-token:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE


BODY 

Ejemplo con POSTMAN: Content Type - form-data

Elemento

Valor

file                          Filearchivo.json


Especificación del dato Promotions


#

Campo

Tipo

Descripción

Requerido

1codestringRefiere al código de promoción.Si
2namestringRefiere al nombre de la promoción .Si
3descriptionstringRefiere a la descripción de la promoción.No
4startAt

dateTime

Vigencia: Fecha de inicio. Formato YYYY-MM-DD HH:MM:SSSi
5endAtdateTimeVigencia: Fecha de inicio. Formato YYYY-MM-DD HH:MM:SSSi
6imagenstringRefiere a la imagen de la promoción. jpgNo
7channelCodestringCódigo interno del Canal.Si
8TypestringRefiere al tipo de promoción .Si
9

benefit [{

SKU

name

quantity

percentage

benefitValue

location [{

storeCode

terminalCode

}]

}]

}]

lista

Especificación de la Promoción

Beneficio

      • SKU: Refiere al código de identificación del producto.
      • Name: Refiere al nombre del producto.
      • quantity: Refiere al máximo de unidades del producto para cumplirse a promoción
      • Percentage: Porcentaje del descuento.
      • BenefitValue: Valor del beneficio si es por monto.
      • Location
          • StoreCode: Código interno del Tienda.
          • TerminalCodeCódigo de la Terminal.



PAUSADO

V2


Especificación de dato type 

#

Parámetros

Formato

Detalle

1codeStringRefiere al código del tipo de Promo.
2
name
StringRefiere al nombre del tipo de Promo: Monetario o no monetario


Ejemplo:

{
   "code": "10361",
   "description": "PGC 25% RFS MERCADO_SURTIMAX_JUDY",
   "name": "25% RFS MERCADO-10361",
   "type": "TP001",
   "endAt": "2020-12-01T04:59:00",
   "startAt": "2020-11-30T05:00:00"
}