Ir al contenido principal

Integración Open API

(Versión 1.0)

Actualizado hace más de 3 meses

Integración Open API en OrderGrid

OrderGrid permite la integración fluida con aplicaciones de terceros mediante Open API, lo que posibilita una gestión eficiente de pedidos e inventario a través de distintas plataformas. El propósito de esta API es permitir que las aplicaciones cliente se comuniquen programáticamente con OrderGrid. Con Open API, los clientes de OrderGrid pueden:

  • Enviar pedidos desde su plataforma directamente a la app de OrderGrid.

  • Sincronizar datos de inventario.

  • Acceder a información de reportes y mucho más.

Tipos de integraciones Open API

OrderGrid admite dos tipos de integraciones Tienda API, cada una diseñada para cubrir distintas necesidades de fulfilment:

Tienda API (Integración de almacén único)

Crea una tienda que envía todos los pedidos entrantes a un único warehouse designado. El warehouse seleccionado recibe todos los pedidos que la tienda envía a la app de OrderGrid.

Tienda API DTC (Integración dinámica de almacenes)

Crea una tienda con enrutamiento flexible, permitiendo dirigir pedidos a varios warehouses. Los pedidos pueden enrutarse según:

  • Reglas de enrutamiento predefinidas dentro de OrderGrid.

  • El warehouse de fulfilment especificado en el order payload.

Con estas opciones de integración, OrderGrid se adapta a los requisitos de fulfilment de cada cliente, optimizando las operaciones en uno o varios warehouses.

Configurar la integración Tienda API

Para crear una Tienda API tienda, sigue estos pasos 🪜:

  1. En la página Stores, haz clic en el botón + New Store .

  2. Select Integration: elige Store API de la lista de integraciones disponibles.

  3. Completa Tienda Information:

    • Store Name: asigna un nombre único a tu tienda.

    • Short Description: describe brevemente el propósito de la tienda.

    • Store Currency: selecciona la moneda de las transacciones.

    • Warehouse: elige el warehouse para el procesamiento de pedidos.

  4. Haz clic en Connect para finalizar la configuración.

✅ Requisito:

debe existir un warehouse creado en la compañía Warehouse y añadido a la compañía Client antes de configurar la integración Tienda API.

Configurar la integración Tienda API - DTC

Para crear una Tienda API - DTC tienda, sigue estos pasos 🪜:

  1. En la página Stores, haz clic en el botón + New Store .

  2. Select Integration:

    • elige Store API - DTC en la lista de integraciones.

  3. Agregar información de la tienda:

    • Ingrese los siguientes detalles requeridos:

      • Store Name: nombre único (máx. 40 caracteres).

      • Short Description: descripción breve (máx. 50 caracteres).

      • Store Currency: moneda que usará la tienda en las transacciones.

  4. Connect the tienda:

    • haz clic en Connect para finalizar la configuración.

Una vez creada la Tienda API o Tienda API DTC, necesitarás crear API Keys y Postbacks para completar la configuración de la integración Open API en la app de OrderGrid.

Crear API keys

🔐 Acceso requerido:
​
solo los usuarios con rol Admin pueden acceder a esta página.

Para crear API keys en la app de OrderGrid, sigue estos pasos 🪜:

  1. Navega a ☰ > Settings > API Keys.

  2. API Key: haz clic en New API Key para crear una API key.

  3. Webhook Key: haz clic en New Webhook Key para crear una Webhook key.

  4. Shipping Key: haz clic en New Shipping Key para crear una Shipping key.

⚠️ Eliminar una clave API:
​
una API key puede eliminarse haciendo clic en Delete junto a la key. Si ya existe una conexión activa que use esa key, eliminarla puede causar problemas significativos.

Configurar Postbacks

Con los postbacks, la API permite enviar diversos eventos de la app a aplicaciones cliente externas. Al configurar una tienda en OrderGrid, los usuarios pueden establecer Event Based Callbacks. Los siguientes Events pueden disparar callbacks:

  • Order Packed (Pedido empacado)

  • Order Short Picked (Pedido con recogida incompleta)

  • Order Shipped (Pedido enviado)

  • Order Voided (Pedido anulado)

  • Picking Started (Recogida iniciada)

  • Item Picked (Artículo recogido)

  • Item Short Picked (Artículo recogido incompleto)

  • Inventory Changes (Cambios de inventario)

  • Lane Assignment: Assign/Transfer Staging Lane (Asignación de carril: asignar/transferir carril de staging)

  • Unloading (Descarga)

  • Purchase Order (Orden de compra)

  • Goods Received Note (Nota de recepción de mercancías)

  • Order Returned (Pedido devuelto)

  • Move Order (Orden de traslado)

Cada event puede enviar solicitudes POST a diferentes Callback URLs. Se usará Username y Password para Basic Auth. Los Payloads estarán en formato JSON.

Para configurar postbacks, sigue estos pasos 🪜:

  1. Navega a ☰ > Settings > PostBacks.

  2. Haz clic en + Post back .

  3. Añade la información necesaria:

    • Selecciona Postback type.

    • Añade el Postback URL.

  4. Para Basic Authentication:

    • Añade Username.

    • Añade Password.

  5. Haz clic en Save .

⚠️ Eliminar una devolución de datos:
​
un postback puede eliminarse haciendo clic en Delete junto al postback creado.

Utilize OrderGrid Backend API documentation.

Para acceder a la documentación, haz clic en este enlace: OrderGrid Backend API documentation.
​

Esta documentación ofrece información detallada sobre cómo usar la OrderGrid backend API, incluidos ejemplos de payloads, y te ayudará a completar la integración API con la app de OrderGrid.

¿Ha quedado contestada tu pregunta?