Esta API le permite enviar datos de sus ventas a Shoptimiza. Esto se puede hacer para

Ayudar a construir las primeras recomendaciones lo más rápido posible
Si un comerciante dispone de tienda física y tienda online puede utilizar los datos de la primera para construir recomendaciones para la segunda

El primer paso es construir nuestro fichero de ventas. El fichero de ventas es un listado con todas las ventas realizadas. Con el último año de ventas es suficiente.

Cada línea del fichero representa una venta mediante un objeto JSON. El objeto tiene dos campos:

key es el ID del pedido. Debe ser de tipo String.
items es un array de ID de los productos del pedido. Los ID son tipo String

Ejemplo de fichero:

{"key":"122","items":["508","563","572","807"]}
{"key":"139","items":["516"]}
{"key":"144","items":["641"]}
{"key":"155","items":["508"]}

En el ejemplo anterior observamos 4 ventas: 122, 139, 144 y 155. En el 122 se vendieron los productos 508, 563, 572, 807.
Sólo nos interesan los distintos productos que se vendieron. No nos interesa si se vendieron más de una misma unidad del mismo producto. Así, si en el pedido 888 vendimos 1000 unidades del producto 123 nuestra línea sería:

{"key":"888","items":["123"]}

¿Qué hacemos con el fichero?

El fichero podemos subirlo a Shoptimiza o podemos colgarlo en un servidor web.

Subir el fichero a Shoptimiza

Tenemos implementado un cliente en Nodejs que puedes utilizar para subir el fichero. Si eres más de c# puedes utilizar esta clase para empezar

Para subir el fichero haciendo un POST a la dirección https://api.shoptimiza.com/v1/sites/$API_KEY/sales-file sustituyendo $API_KEY por tu clave API. El cuerpo de la consulta será el fichero. Además debes incorporar a tu request la cabecera X-Shoptimiza-Auth que está documentada aquí.

El fichero deberá subirse de forma regular (cada 7 días) para que podamos actualizar nuestras recomendaciones.

Si optas por esta estrategia debes configurar la cuenta Shoptimiza para que no consuma datos del sitio web. Para ello debes entrar en la cuenta, ir a "configuración" y desactivar el pull data.

Colgar el fichero en un servidor web

Puedes colgar el fichero en un servidor web y Shoptimiza lo descargará cada 7 días. Una vez que hayas colgado el fichero accede a la cuenta Shoptimiza del comercio y, en la sección "configuración", en "origen de datos", habilita el "pull data" y añade la url del fichero. Ten en cuenta que cualquiera que conozca la Url ¡Podrá bajarse el fichero!

Protegiendo el fichero

Shoptimiza enviará a tu servidor web la cabecera X-Shoptimiza-Auth. Puedes proteger el fichero analizando la cabecera.
Tienes más información sobre la cabecera aquí también disponemos de una librería PHP que te permite validar la cabecera. En nuestra extensión para PrestaShop puedes ver un ejemplo de uso real