Caso de uso para BSS B2B Solution

Sincronizar reglas y clientes B2B con su ERP mediante API

Use la API pública de BSS B2B Solution para crear y actualizar reglas de Custom Pricing, Price List, Volume Pricing y datos de registro desde su ERP o PIM con una clave de API, en lugar de editar las reglas a mano.

  • App: BSS B2B Solution
  • Modelo de negocio: Distribuidor
  • Función clave: Public API

Última actualización

Revisado por Hoa Nguyen. Última revisión

Tarjeta de la clave de API en BSS B2B Solution justo después de generar una clave, con la clave oculta y los botones Copy y Download
  • 4,9/5 1.190 reseñas de BSS B2B Solution en Shopify App Store
  • Built for Shopify Insignia que Shopify otorga a las apps que cumplen sus estándares de calidad
  • 20 idiomas compatibles con la app

El problema

Los precios, los clientes y las reglas ya viven en un ERP, un PIM o una hoja de cálculo, y nadie quiere mantenerlos por segunda vez dentro de la app. Copiar los cambios a mano es lento, y los dos sistemas se separan. Los catálogos grandes empeoran el problema cada mes.

El resultado

Su desarrollador o su socio de integración envía las reglas de precio desde el sistema de registro a BSS B2B Solution con una clave de API. Las reglas activas se suben al tema publicado, y la tarjeta Logs and usage muestra cada solicitud y el motivo por el que falló una solicitud fallida.

cómo funciona

Cómo funciona

  1. Compruebe el plan

    La API pública forma parte del plan Platinum. Confirme el plan antes de planificar cualquier trabajo de integración.

  2. Genere la clave de API

    Abra Integrations en la app, busque la tarjeta Public API, haga clic en Get API key y genere la clave. Cópiela o descárguela de inmediato, porque solo se muestra una vez.

  3. Envíe una primera solicitud

    Llame a un endpoint de la versión 1 con el dominio de su tienda y la clave, ya sea como el campo accessKey en el cuerpo o en el encabezado x-bss-b2b-api-key.

  4. Escriba reglas a partir de los datos de su ERP

    Cree, actualice o elimine registros de Custom Pricing, Price List, Volume Pricing, Discount Code y registro con el grupo de endpoints correspondiente, en lote donde el endpoint lo permita.

  5. Suba las reglas activas

    Llame al endpoint de carga del módulo para que las reglas activas lleguen a su tema publicado, como máximo una vez por módulo cada 5 minutos.

  6. Revise los registros

    Abra Logs and usage para ver cada solicitud, su estado y la solicitud y la respuesta completas cuando algo falla.

Para sincronizar precios B2B desde un ERP hacia Shopify, use la API pública de BSS B2B Solution: genere una clave de API en el plan Platinum y luego haga que su desarrollador o su socio de integración cree, actualice y elimine reglas de Custom Pricing, Price List y Volume Pricing desde su sistema de registro, y llame al endpoint de carga para que las reglas activas lleguen al tema publicado. Su equipo deja de volver a escribir precios en una pantalla del admin.

Esta guía es para distribuidores y fabricantes cuyos precios, clases de precio o grupos de clientes ya viven en un ERP, un PIM o un flujo de datos. Explica quién se beneficia, qué cubre y qué no cubre la API, un esquema de integración de cinco pasos, un ejemplo práctico y los límites que conviene tener en cuenta, incluido que no hay endpoint de pedidos. Está escrita para quien decide si construye la integración, y remite a la documentación para desarrolladores para los payloads exactos.

Para quién es esto

La API pública le conviene si la mayoría de estas situaciones describe su tienda:

  • Sus precios se mantienen en un ERP, un PIM o una hoja maestra, y la tienda de Shopify es una segunda copia.
  • Tiene varias clases de precio o grupos de clientes, y un cambio de precio afecta a cientos o miles de variantes.
  • Los precios cambian cada semana o cada día, así que una actualización manual se queda atrás entre una ejecución y la siguiente.
  • Tiene un desarrollador, una agencia o un socio de integración que puede escribir un trabajo programado.
  • Ya exporta datos de precios en CSV y quiere que esos datos fluyan sin que nadie abra la app.

Si su lista de precios cambia unas pocas veces al año, una importación CSV es más sencilla. Vea importar precios mayoristas desde CSV.

Por qué importa

Dos copias de una lista de precios se separan. Alguien actualiza el ERP el lunes, se olvida de la tienda, y el martes un comprador ve el precio del trimestre pasado. El comprador pide al precio equivocado y usted absorbe la diferencia o cancela el pedido, o el comprador pierde la confianza en el portal y llama al equipo de ventas. Cuanto más grande es el catálogo y más clases de precio maneja, con más frecuencia ocurre.

Un flujo de datos corrige la causa y no el síntoma. El ERP sigue siendo el sistema de registro, un trabajo programado escribe los cambios en BSS B2B Solution, y la tienda los sigue. Las tiendas reales quieren esta flexibilidad. Alpha Coffee, un tostador de café, señala que, con acceso a la API, puede mantener Shopify como capa central de comercio y ampliarla hacia plataformas de ERP, CRM o finanzas, y DermaplanePro informa de menos trabajo manual gracias a conexiones de API pública con sistemas externos. Vea los casos de Alpha Coffee y DermaplanePro.

Cómo configurarlo con BSS B2B Solution

Esta sección describe la integración desde el lado del comerciante. Su desarrollador necesita la guía de la API pública para los endpoints y los payloads.

Paso 1: Confirme el plan

La API pública forma parte del plan Platinum. Una tienda puede tener una clave de API a la vez, y el plan también desbloquea Price Lists, que muchas integraciones con ERP usan para precios específicos por cliente. Confirme el plan antes de definir el alcance de cualquier trabajo de integración.

Paso 2: Genere la clave de API

En la app, abra Integrations, busque la tarjeta Public API y elija Get API key. La clave se muestra una sola vez, así que cópiela o descárguela en ese momento y guárdela en un gestor de contraseñas o en una variable de entorno del servidor. Si se filtra, elimínela en la misma tarjeta, lo que detiene a todos los clientes que la usan, y luego genere una nueva.

Página Integrations en el admin de BSS B2B Solution con la tarjeta Public API y su botón Get API key
Abra Integrations y busque la tarjeta Public API.
Tarjeta de la clave de API con el mensaje de que la clave está generada, la clave oculta y los botones Copy y Download
La clave se genera y se muestra una sola vez: cópiela o descárguela de inmediato.

Paso 3: Autentique su primera solicitud

Los endpoints de la versión 1 reciben su dominio `myshopify.com` y la clave, ya sea como `accessKey` en el cuerpo de la solicitud o en el encabezado `x-bss-b2b-api-key`. El endpoint de volume pricing de la versión 2 usa el encabezado `x-api-key`. No se admite un token Bearer y devuelve 401, así que no construya el cliente alrededor del encabezado `Authorization`.

Paso 4: Escriba reglas a partir de los datos de su ERP

Asigne cada clase de precio del ERP a un destino de regla, como una etiqueta de cliente, y llame al grupo de endpoints del módulo que use. La API gestiona reglas de Custom Pricing, Price List y Volume Pricing, reglas de códigos de descuento, registros del formulario de registro y reglas de límite de pedido, con operaciones de crear, actualizar, eliminar y en lote donde el endpoint lo permite. Los endpoints de clientes y productos son consultas de solo lectura que ayudan a construir los payloads de reglas, por ejemplo para buscar clientes por etiqueta o listar productos y colecciones. Las solicitudes se procesan una a la vez, así que el cliente debe poner sus llamadas en cola.

Página Custom Pricing en el admin de BSS B2B Solution con una lista de reglas, sus clientes, descuentos, prioridad y estado
Las reglas que escribe su integración aparecen en las mismas listas de reglas que usa su equipo en el admin.

Paso 5: Suba una vez y luego verifique

Después de un lote de cambios, llame al endpoint de carga del módulo para que todas las reglas activas se escriban en su tema publicado. Los endpoints de carga permiten una solicitud por módulo cada cinco minutos, así que suba una vez al final de la ejecución de sincronización, no después de cada fila. Una solicitud por encima del límite devuelve `429`, y solo se suben las reglas activas. Si sus reglas superan la capacidad de los metafields, la API guarda lo que cabe y devuelve un informe `partial_success` con HTTP 200, así que lea el cuerpo de la respuesta y no solo el código de estado. Luego revise el resultado en la tarjeta Logs and usage bajo Advanced Settings > Public API, que muestra las solicitudes recientes con hora, método, ruta y estado, y muestra la solicitud y la respuesta completas cuando algo falla. La API también puede devolver el precio que obtiene un cliente determinado por ciertos productos, lo que sirve para comparar la app con el ERP.

Colección de la tienda demo para un cliente mayorista, en la que cada producto muestra el precio minorista tachado junto al precio mayorista
Después de la carga, la tienda muestra los precios que vienen de sus datos.

Ejemplo: un distribuidor con tres clases de precio

Este ejemplo usa cifras ilustrativas, no resultados de una tienda real. Un distribuidor mantiene tres clases de precio en su ERP: Retail Partner, Trade y Key Account. En BSS B2B Solution, cada clase es una regla de Price List que apunta a una etiqueta de cliente. Un trabajo nocturno exporta las filas de precio cambiadas, las agrupa por clase y llama al endpoint de guardado en lote para cada Price List. Cuando las tres terminan, el trabajo llama una vez al endpoint de carga de Price List.

Un lunes, el ERP muestra 3.200 precios cambiados. En lugar de que un analista los vuelva a escribir, el trabajo se ejecuta a las 02:00, sube una vez y revisa la tarjeta Logs and usage por si hay solicitudes fallidas. Por la mañana, un comprador Trade que inicia sesión ve los precios del lunes en las páginas de producto y de colección. Una solicitud fallida deja una entrada en el registro con su estado y su cuerpo, y el trabajo la reintenta tras una breve espera.

Página Price Lists en el admin de BSS B2B Solution con el módulo activado y una regla para clientes con sesión iniciada
Una página Price Lists con una regla de lista para un grupo de clientes: el mismo tipo de regla que escribe su integración.

Funciona bien con

La API es una vía de entrada para el motor de precios. Otras páginas explican qué pasa con esas reglas una vez que existen:

La página de precios mayoristas reúne las guías de precios. Entradas útiles del glosario son lista de precios, precio mayorista y etiqueta de cliente.

Página de importación y exportación en BSS B2B Solution con las tarjetas Export e Import y una sección de historial de exportaciones
La página Import and export es la alternativa sin código para catálogos más pequeños.

Límites y errores comunes

  • No hay endpoint de pedidos. La API gestiona reglas de precios y descuentos, registros del formulario de registro y reglas de límite de pedido, además de consultas de solo lectura de clientes, productos y colecciones. Mantenga la sincronización de pedidos en el conector de su ERP para Shopify, y use esta API para precios y grupos de clientes.
  • Una clave por tienda. Eliminar la clave detiene a todos los clientes que la usan, así que, si la rota, actualice la integración de inmediato.
  • La carga tiene límite de frecuencia. Los endpoints de carga permiten una solicitud por módulo cada cinco minutos. El endpoint de volume pricing de la versión 2 permite 60 solicitudes por cada 60 segundos para cada tienda.
  • Los datos de precios tienen topes. Las reglas se guardan en metafields de Shopify con un máximo de 10 claves y 2.000.000 de caracteres por clave. El contenido por encima de los topes se omite y se informa como `partial_success`, así que elimine las reglas inactivas o divida un conjunto de reglas muy grande antes de volver a subir.
  • Los reintentos necesitan una pausa. Las solicitudes se procesan una a la vez, y tras un error del servidor la guía indica que espere hasta tres minutos antes de reintentar.
  • La API no reemplaza el diseño de reglas. La segmentación, la prioridad y las exclusiones siguen las mismas reglas que las reglas creadas a mano, así que pruebe primero una regla en el admin.
  • La API alimenta una tienda con tema. Los precios aparecen a través del app embed de BSS B2B Solution en su tema de Shopify, así que confirme que el embed esté activado después de cualquier cambio de tema.

Lista de verificación de configuración

  • Confirme que la tienda está en el plan Platinum.
  • Decida el sistema de registro de cada clase de precio y a qué etiqueta de cliente corresponde cada clase.
  • Genere la clave de API y guárdela en un gestor de contraseñas o en una variable de entorno.
  • Construya el cliente con `accessKey` o con el encabezado `x-bss-b2b-api-key`, y ponga las solicitudes en cola.
  • Pruebe una regla de principio a fin en una tienda de desarrollo y luego revísela en el admin.
  • Planifique una llamada de carga por módulo al final de cada ejecución de sincronización.
  • Añada alertas para `429` y errores del servidor, y lea la tarjeta Logs and usage tras las primeras ejecuciones.
  • Mantenga la sincronización de pedidos en un conector separado.

Planes y requisitos

La API pública necesita el plan Platinum de BSS B2B Solution, una clave por tienda y el app embed en su tema. Los demás planes y la prueba gratuita de 14 días en los planes de pago están en la página de precios de BSS B2B. Los payloads exactos están en la guía de la API pública, la guía de la API de carga y la guía de la API de Custom Pricing. Instale BSS B2B Solution desde la Shopify App Store y pida a su desarrollador que empiece con una sola Price List.

funciones clave

Qué hace que funcione

Endpoints de reglas

Lea, cree, actualice y elimine reglas de Custom Pricing, Price List y Volume Pricing desde código, incluido el guardado en lote y la eliminación masiva.

Consultas de clientes y productos

Endpoints de solo lectura para encontrar clientes por etiqueta, ID o búsqueda, y para listar productos y colecciones para los payloads de sus reglas.

Carga al tema

Una solicitud sube todas las reglas activas al tema publicado para que la tienda coincida con sus datos.

Logs and usage

Una tarjeta en la app muestra las solicitudes recientes con hora, método, ruta y estado.

Configúrelo con BSS B2B Solution

Instale BSS B2B Solution desde Shopify App Store y siga la guía para activarlo en su tienda.

preguntas frecuentes

Preguntas frecuentes

¿Qué plan incluye la API pública?

El plan Platinum. Una tienda puede tener una clave de API a la vez. Si una clave se filtra, elimínela en la tarjeta Public API de Integrations, y todos los clientes que la usan dejan de funcionar de inmediato. Luego puede generar una clave nueva y actualizar su integración. Trate la clave como una contraseña y guárdela en una variable de entorno del servidor.

¿Puedo sincronizar pedidos mediante la API?

No. La API gestiona reglas de precios y descuentos, registros del formulario de registro y reglas de límite de pedido, además de consultas de solo lectura de clientes, productos y colecciones. No tiene un recurso de pedidos. Los pedidos se quedan en Shopify, así que use las herramientas propias de Shopify si su ERP las necesita, y use esta API para precios y grupos de clientes.

¿Cuáles son los límites de frecuencia?

Los endpoints de carga permiten una solicitud por módulo cada 5 minutos, y una solicitud por encima del límite devuelve 429. El endpoint de Volume Pricing de la versión 2 permite 60 solicitudes por cada 60 segundos para cada tienda y envía encabezados de límite de frecuencia. Agrupe sus cambios y suba una vez al terminar una sincronización, en lugar de después de cada fila.

¿Cómo autentico una solicitud?

Los endpoints de la versión 1 reciben el dominio de su tienda y la clave de acceso, ya sea como accessKey en el cuerpo o en el encabezado x-bss-b2b-api-key. El endpoint de la versión 2 usa el encabezado x-api-key. No envíe la clave como token Bearer, porque ese formato no se admite y la solicitud falla con 401.

¿Qué reglas puedo gestionar con la API?

Puede crear, actualizar y eliminar reglas de Custom Pricing, Price List y Volume Pricing, además de reglas de códigos de descuento, registros del formulario de registro y reglas de límite de pedido, con operaciones en lote en varios endpoints. Los endpoints de clientes, productos y colecciones son consultas de solo lectura para construir los payloads de las reglas. Consulte cada guía para ver las operaciones exactas.

¿Qué pasa si subo más reglas de las que caben?

Los datos de precios se guardan en metafields de Shopify con un máximo de 10 claves y 2.000.000 de caracteres por clave. Si sus reglas activas superan esa capacidad, la API guarda las reglas que caben y devuelve un informe partial_success con HTTP 200, que indica cuántas se omitieron. Elimine las reglas inactivas o divida el conjunto, y luego vuelva a subir.

¿Cómo veo por qué falló una solicitud de la API?

Abra la tarjeta Logs and usage bajo Advanced Settings y Public API. Muestra las solicitudes recientes con hora, método, ruta y estado, con pestañas para Custom Pricing, Volume Pricing y Pricing List. Haga clic en una fila para ver la solicitud y la respuesta completas. Úselo para confirmar que la integración se conecta y para depurar los errores.

¿Necesito la API o basta con una importación CSV?

Si los precios cambian unas pocas veces al año, la importación CSV de la app es más sencilla y no necesita un desarrollador. La API pública tiene sentido cuando los precios viven en un ERP o un PIM y cambian con frecuencia, porque un trabajo programado puede enviar los cambios sin que nadie abra la app. La API necesita el plan Platinum.

Instalar BSS B2B Solution prueba gratuita de 14 días (planes de pago)