API

Guía de las API de Qapla’

Las API permiten integrar Qapla’, tanto en lectura como en escritura, con tu sistema de comercio electrónico propio o con aquel para el que aún no se haya implementado un plugin o conector.
La integración habilita operaciones tanto de lectura como de escritura, permitiendo la gestión completa de:

  • Pedidos
  • Envíos
  • Tracking
  • Etiquetas
  • Transportistas
  • Canales
  • Help

Para poder utilizar las API, es necesario conocer las API Keys Privadas asignadas a tu(s) canal(es), que se encuentran en el Panel de Control en:
Configuración > Canales [Nombre canal] > Configurar > Canal > API KEY Privada
Atención: La API Key Privada debe protegerse y mantenerse secreta.

 

Pedidos

Las siguientes API permiten gestionar tus pedidos:

  • pushOrder cargar uno o más pedidos
  • getOrder  recuperar la información de un pedido específico
  • getOrders obtener la lista de pedidos importados
  • updateOrder actualizar un pedido
  • deleteOrder eliminar un pedido
  • undeleteOrder restaurar un pedido eliminado
  • detectOrderCourier permite asignar un transportista a un pedido en función de reglas predefinidas (configuraciones que deben establecerse en el Panel de Control).

Envíos

Las siguientes API permiten gestionar tus envíos:

Tracking

Las siguientes API permiten recuperar información y monitorear el estado de los envíos:

  • getShipment recuperar información y estado de un envío
  • trackingByTimeFrame obtener la lista de envíos que han tenido una actualización de estado en un rango de tiempo solicitado
  • Tracking Script configurando e insertando el Tracking Script de Qapla’ en tu página web, puedes mostrar el historial de tracking en formato HTML, directamente en tu plataforma.
    Para una gestión completa y sincronizada del progreso de los envíos, se recomienda también el uso del Webhook de Envíos.

Plataformas

  • fetchPlatformOrders recibir la lista de pedidos presentes en una plataforma (CMS/Marketplace). Requiere configuración previa de CMS y/o Marketplace.
  • updatePlatformOrder actualizar pedidos presentes en una plataforma. Requiere configuración previa de CMS y/o Marketplace.

Etiquetas

  • createLabel crear un envío y obtener la etiqueta (equivalente a “Crear” y “Imprimir” en el panel de control).
  • confirmLabel transmitir los envíos creados al transportista para finalizar el proceso y devolver el manifiesto (PDF).

createLabel y confirmLabel requieren activación y pueden implicar un coste. Si ya has adquirido el producto, solicita la activación escribiendo a success@qapla.it

  • getLabel obtener una etiqueta previamente creada (PDF, JPG, ZPL).
  • checkLabel verificar el estado de una etiqueta previamente creada.
  • deleteLabel eliminar una etiqueta creada con createLabel.

Transportistas

  • getCouriers solicitar la lista de transportistas (global o por país/región).
  • detectCourier identificar el transportista en base al número de seguimiento proporcionado.
  • getPudos permite solicitar la lista de PUDOs (puntos de recogida/entrega, Pick Up Drop Off points, OOH) de varios transportistas al mismo tiempo. Esta API conlleva un coste y requiere activación. Si ya has adquirido el producto, por favor solicita la activación al Customer Care escribiendo a support@qapla.it
  • getQuotes permite solicitar cotizaciones de envío a varios transportistas y servicios al mismo tiempo. Esta API conlleva un coste y requiere activación. Si ya has adquirido el producto, por favor solicita la activación al Customer Care escribiendo a support@qapla.it

Transportista Virtual

  • apiVirtual actualizar el estado de un envío del transportista virtual.

Canales

getChannel →

  • getChannel obtener información sobre el canal vinculado a la API Key y la empresa que lo creó.
  • checkChannel permite verificar las conexiones con la plataforma y los marketplaces configurados en el canal.
  • createChannel permite crear un nuevo canal.
  • updateChannel permite modificar algunas configuraciones del canal.
  • deleteChannel permite eliminar un canal específico.

Estados de Qapla’

  • getQaplaStatus obtener la lista detallada de los estados de envío de Qapla’

Help

  • Qapla’ Status interpretación del estado del envío con valores estandarizados de Qapla’
  • Courier’s codes lista de códigos de transportistas de Qapla’, en orden alfabético

 

¿Necesitas ayuda?
Si necesitas asistencia, contacta con el Customer Care de Qapla’ escribiendo a support@qapla.it