Conectarse al API Cubyn

El API Cubyn es la manera más flexible de integrar sus sistemas con los de Cubyn.

Permite:

• importar la información de sus envíos
• hacer el seguimiento sus envíos: estado de entrega y número de rastreo
• suscribirse a todo cambio de estado de sus envíos

Puede encontrar todos los documentos relativos a nuestro API en esta web: http://developers.cubyn.com

Conexión al API Cubyn

Antes de conectarse al API de Cubyn, necesita añadir la aplicación API Cubyn a su cuenta. Para eso, conéctese en su interfaz Cubyn y:

1. Diríjase a la pestaña Aplicaciones
2. Haga clic en el botón +
3. Haga clic en Instalar (al lado del icono API Cubyn)
4. Introduzca el nombre de aplicación que quiere que aparezca en su cuenta
5. Confirmar

Para conectarse a la aplicación desde su servicio, necesita recuperar su clave API. La podrá conseguir en la información de la aplicación que acaba de crear. Esa información está disponible haciendo clic sobre la llave inglesa que aparece en la pestaña Aplicaciones

La conexión API permite:

1. Envío de mercancías

Para hacer un envío de mercancías, necesita introducir el número de paquetes por enviar y darnos el detalle de cada producto: SKU, nombre del producto, código de barras y cantidad. Hay que rellenar esa información en los campos indicados de la solicitud de envío de mercancías. La puede encontrar aquí.

{
 "packingUnits": 2,
 "items": [{
    "sku": "SKU1",
    "productName": "Name1",
    "barcode": "123456789",
    "quantity": 4
 },
 {
    "sku": "SKU2",
    "productName": "Name2",
    "barcode": "234567890",
    "quantity": 90
 }]
}

En respuesta recibirá la identificación WIO (pid) correspondiente al envío de mercancías y el número de paquetes y productos declarados.

{
 ...
 "pid": "184569",
 ...
 "declaredPackingUnits": 2,
 "receivedPackingUnits": 0,
 "completedPackingUnits": 0,
 "declaredItems": 94,
 "storedItems": 0,
 "createdAt": "2020-05-25T09:37:29.000Z",
 "updatedAt": "2020-05-25T09:37:29.000Z",
 "receiptStartedAt": null,
 "validatedAt": "2020-05-25T09:37:29.000Z",
 "completedAt": null,
 "deletedAt": null,
 ...
}

          2. Supervisión del inventario

Puede hacer el seguimiento de su inventario en tiempo real con la solicitud disponible aquí.

Esa solicitud le proporcionará diferentes informaciones para cada SKU como el nombre del producto en camino, disponible, en proceso y enviados, y también el/los código(s) de barra correspondiente(s).

[
 {
 ...
 "sku": "iPhone_10_32G_new",
 "sanitizedSku": "IPHONE-10-32G-NEW",
 "name": "iPhone 10 32G new",
 "isVirtual": false,
 "isBundle": false,
 "createdAt": "2020-05-07T14:59:45.000Z",
 "updatedAt": "2020-05-07T14:59:45.000Z",
 ...
 "stock": {
    "hadStockInbounded": true,
    "quantityAvailable": 7,
    "quantityOutbounded": 0,
    "quantityInbounding": 0,
    "quantityOutbounding": 1,
    ...
 },
 ...
 },
...
]

          3. Creación de envío

Para crear envios, tiene que proporcionar diferentes datos sobre el destinatario, los SKU de los productos y la cantidad que desea enviar. El detalle de la información necesaria para la creación de un envío está disponible aquí.

{ 
 "type":"SHIPMENT",
 "firstName":"Sophie", 
 "lastName":"Martin", 
 "items":[ 
 { 
    "reference":"SKU1", 
    "count":1 
 } 
 ], 
 "orderRef": "Order1", 
 "address":{ 
    "line1":"13 rue Lecourbe", 
    "zip":"75007", 
    "city":"Paris",
    "country":"France", 
    "additionalInformation":"code 9898" 
 },
 "value": 10.99
}

En respuesta a la solicitud enviada, recibirá una síntesis de la expedición con la información correspondiente.

{
 ...
 "trackingId": "CUB131958015",
 "status": "CREATED",
 ...
 "address": {
 "line1": "13 rue Lecourbe",
 "line2": "",
 "zip": "75007",
 "city": "Paris",
 "state": "",
 "country": "FR",
 "additionalInformation": "code 9898"
 },
 "firstName": "Sophie",
 "lastName": "Martin",
 "value": 10.99,
 "deliveryMode": "standard",
 "deliverySigned": false,
 "objectCount": 1,
 "insurance": 0,
 "isAdvalorem": false,
 "orderRef": "Order1",
 "createdAt": "2020-05-25T10:07:28.000Z",
 "updatedAt": "2020-05-25T10:07:28.000Z",
 ...
 "items": [
 {
 "reference": "SKU1",
 "count": 1
 }
 ],
 ...
}

       

         4. Rastreo de los envíos

Con la solicitud disponible aquí, puede hacer el rastreo de sus envíos.

Para obtener el detalle del envío (información del destinatario y estado del envío) puede introducir el ID al final de la solicitud. Pero también podrá acceder a esa información sin indicar el ID.

 

         5. Webhook

En los ajustes de la aplicación API Cubyn, puede añadir el URL del Webhook al que le podemos enviar las informaciones de sus paquetes.

Enviamos la información cuando va a cambiar el estado del envío en nuestros almacenes o cuando se ha realizado el envío. Puede seleccionar las razones por las que le avisamos en los ajustes de la aplicación API Cubyn.

Nuestros sistemas van a generar pedidos POST con tres informaciones principales:

• el cambio en su entrega que generó el envío de solicitud
• su clave API
• el detalle de su parcel

La sección Webhook (del capítulo Rastreo de los envíos, disponible aquí) contiene el detalle de los tres datos mencionados anteriormente.

Atención: para optimizar la seguridad de su sistema, le recomendamos que nos transmita un URL de webhook en formato HTTPs y que compare a menudo su clave API con la que aparece en las solicitudes enviadas.

🚨 Para el envío de los Webhooks, es indispensable que el pedido correspondiente se haya creado mediante la clave API de la conexión. No se envía ningún Wehbook para los pedidos creados manualmente.

Anexos

1. Añadir un archivo a su envío

En algunos casos, es necesario añadir un archivo a su envío. El capítulo Parcel attachement (de la sección Guide disponible aquí) describe el trámite para añadir un archivo. Al realizar ese trámite recibirá la confirmación que se añadió el archivo a su envío.

      2. Construir la página de tracking Cubyn

Cubyn ofrece una página de rastreo común a todas las empresas de transporte con las que trabajamos. Recomendamos mucho su uso. Para eso, solo necesita crear su número de rastreo e ir, con este mismo, a la página de rastreo. El detalle del trámite está disponible aquí.

      3. Envío con Cubyn Relay

Para enviar sus paquetes a un punto de recogida, tiene que declarar la relayPickupRef. Es la ubicación del punto de recogida. Para escogerlo, le recomendamos usar nuestro programa online. Pero como trabajamos con Mondial Relay, puede escoger su punto de recogida con ese plugin.

Más información sobre esa interfaz disponible aquí.

     4. Hacer pruebas del espacio Sandbox

Cubyn ofrece un espacio Sandbox en el que podrá probar su integración antes de empezar. Pidanos una cuenta Sandbox aquí: onboarding@cubyn.com

Más información sobre esa interfaz disponible aquí.