Guía de integración

Shopify

Esta guía es de uso exclusivo para la integración nativa con Shopify mediante webhooks. Para integraciones personalizadas o lógica avanzada, utilizar la documentación de la ruta estándar.

Paso 1

Ubicación de configuración

Ir a la siguiente ruta dentro de Shopify:

Settings / Configuración

Paso 2

Ubicación de Webhooks

Dentro de configuración, ir a:

Notifications / Notificaciones
Webhooks

Paso 3

Crear webhook

Crear un nuevo webhook.

En esta pantalla Shopify mostrará el secreto con el que los webhooks serán firmados.

Nota importante:

Este valor debe ser compartido con Servientrega, ya que es obligatorio para la configuración de la validación del webhook

Paso 4

Configuración del webhook

Configurar el webhook con los siguientes valores:

Evento: Order Fulfillment
Formato: JSON
URL de entrega:
Webhook API version: 2026-01

http://www.servientregaapi.com/public/integration/{clientKey}/siscore/guias/shopify/order?env=prod

Notas:

El valor de clientKey es proporcionado por Servientrega
La URL de entrega es proporcionada por Servientrega
El secreto mostrado por Shopify debe ser compartido con Servientrega
El parámetro env define el entorno: sandbox para pruebas y prod para producción

Paso 5

Agregar notas en la orden

Antes de completar el fulfillment de la orden, agregar las notas requeridas para la creación de la guía.

Campos obligatorios

nombre_producto
ciudad_destinatario
peso_fisico
peso_volumentrico
alto
ancho
largo

Campos opcionales

cedula_destinatario
contenido
factura
caux1
caux2
caux3
valor_recaudar
piezas

Ejemplo de nota

nombre_producto: PREMIER-DOMICILIO
ciudad_destinatario: AGUADULCE-COCLE
peso_fisico: 1
peso_volumentrico: 0
alto: 10
ancho: 10
largo: 10

Paso 6

Completar la orden

Una vez agregadas las notas, completar el fulfillment
Shopify enviará automáticamente el webhook al API
Se generará la guía correspondiente

Notas importantes

Algunos datos se obtienen directamente de la orden, como el nombre del cliente, teléfono y correo electrónico
El remitente se configura a nivel de sistema y debe ser proporcionado a Servientrega
El formato de ciudad_destinatario debe cumplir con las variables definidas por Servientrega
Si falta un campo obligatorio, la API devolverá error
Se recomienda copiar y pegar los nombres de los campos para evitar errores
El secreto del webhook es obligatorio para validar la autenticidad de las solicitudes enviadas por Shopify