Contenido
- Registro y configuración del sistema de almacén
- Obtención de existencias y precios de compra
- Actualización de existencias y precios de compra
- Actualización de existencias y precios de compra iniciada por el sistema
- Actualización de existencias iniciada por el sistema
- Obtención de información sobre productos
- Obtención de información sobre el envío del pedido
La integración se realiza mediante la interfaz de programación de aplicaciones (API), de acuerdo con las reglas de uso de la API. Para esta integración se utilizan los métodos de la API de la sección Almacén.
Registro y configuración del sistema de almacén
Para registrar y configurar el sistema de almacén, se utiliza el método POST /api/v5/integration-modules/{code}/edit. Si ya existe un módulo con el código {code}, el método modifica su configuración; de lo contrario, crea un nuevo módulo de integración para el sistema de almacén. Los parámetros actuales del módulo pueden consultarse mediante el método GET /api/v5/integration-modules/{code}.
Durante el registro deben especificarse el nombre integrationModule[name], el código integrationModule[code], la URL base integrationModule[baseUrl] y el identificador de usuario integrationModule[clientId]. El parámetro clientId permite identificar al usuario en el sistema de almacén cuando se realizan solicitudes de callback. Encontrará más información en el artículo sobre la activación de módulos. También puede indicarse el logotipo del sistema de almacén en integrationModule[logo]; se mostrará en la lista de integraciones de la sección Marketplace.
Para activar los métodos de callback, debe enviarse la configuración del método correspondiente en integrationModule[integrations][store][actions]. Para cada método deben indicarse el código code y la URL url. La URL de la solicitud se forma combinando la configuración base integrationModule[baseUrl] con la url del método concreto.
Los métodos de callback disponibles se configuran como se indica a continuación.
Configuración de la carga de existencias
Para configurar la carga de existencias mediante el método POST /api/v5/integration-modules/{code}/edit, debe indicarse el código de método inventoriesUpload en el array integrationModule[integrations][store][actions]. También deben especificarse en integrationModule[integrations][store][actions][][callPoints] los puntos de llamada desde los que se iniciará la solicitud:
onReserve: al abrir la ventana de reserva de un producto en el pedido;onOrderProductList: al abrir la ventana de selección de productos en el pedido;onProduct: al abrir la ficha del producto.
Configuración de la actualización de existencias tras consultar el sistema de almacén
Para configurar la actualización de existencias mediante el método POST /api/v5/integration-modules/{code}/edit, debe indicarse el código de método inventoriesActualize en el array integrationModule[integrations][store][actions].
Obtención de existencias y precios de compra
El método GET /api/v5/store/inventories permite obtener las existencias y los precios de compra de las variantes. Para cada variante, la información se devuelve desglosada por almacén.
Actualización de existencias y precios de compra
El método POST /api/v5/store/inventories/upload permite actualizar por almacén las existencias y los precios de compra de las variantes. Puede utilizarse tanto para actualizar de inmediato las existencias de un lote pequeño de productos como para actualizar periódicamente todo el catálogo. En el segundo caso, las existencias deben enviarse en lotes de no más de 250 variantes por solicitud hasta completar la actualización del catálogo.
Actualización de existencias y precios de compra iniciada por el sistema
El método de callback POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["store"]["actions"]["inventoriesUpload"]} permite actualizar por almacén las existencias y los precios de compra de las variantes. Para utilizarlo, el sistema de almacén debe estar registrado mediante la API. La llamada se inicia automáticamente al realizarse determinadas acciones, que pueden definirse durante la configuración del sistema de almacén.
Actualización de existencias iniciada por el sistema
El método de callback POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["store"]["actions"]["inventoriesActualize"]} permite actualizar por almacén las existencias de las variantes. Para utilizarlo, el sistema de almacén debe estar registrado mediante la API. La llamada se inicia automáticamente al realizarse determinadas acciones, que pueden definirse durante la configuración del sistema de almacén.
La solicitud enviada por el sistema no incluye clientId.
Obtención de información sobre productos
El método GET /api/v5/store/product-groups permite obtener la lista de grupos de productos.
El método GET /api/v5/store/products permite obtener información sobre los productos y sus variantes.
El método GET /api/v5/store/products/properties permite obtener la lista de propiedades de los productos.
Obtención de información sobre el envío del pedido
Cuando se utiliza un sistema de almacén externo, el envío debe gestionarse en dicho sistema. Para transferir la información del envío del pedido desde el sistema de almacén, debe utilizarse el método POST /api/v5/orders/{externalId}/edit. Deben enviarse el indicador de envío order[shipped], el almacén de envío order[shipmentStore] y la fecha de envío order[shipmentDate].
Importante
El campo
order[shipped]solo puede modificarse mediante la API si existe un sistema de almacén registrado.