Docs
Powered by

# 🚚 Jipink - Documentaci贸n de API

Jipink es un proveedor de servicios de env铆o que permite generar env铆os, obtener etiquetas y consultar el estado de los mismos.

# 📋 脥ndice

  • 1. Generar Env铆o
  • 2. Obtener Etiqueta
  • 3. Obtener Tracking

# 1. Generar Env铆o

# Endpoint 

POST /api/shipping/create

# Descripci贸n

Permite generar un nuevo env铆o en la plataforma de Jipink.

# Estructura del Request

# 🔐 Provider Data

Campo Tipo Descripci贸n Obligatorio
provider string Nombre del proveedor (Jipink) ✅
USER string Token de autorizaci贸n ✅

# 📦 Shipment Data

# 📍 Datos de Origen
Campo Tipo Descripci贸n Obligatorio
origen.postal.calle string Calle del remitente ✅
origen.postal.numero string N煤mero de la direcci贸n ✅
origen.postal.firstName string Primer nombre del remitente ✅
origen.postal.lastName string Apellido del remitente ✅
origen.postal.localidad string Ciudad de origen (Ej: Banfield) ✅
origen.postal.region string Provincia de origen (Ej: Buenos Aires) ✅
origen.postal.codigoPostal string C贸digo postal de origen ✅
# 📍 Datos de Destino
Campo Tipo Descripci贸n Obligatorio
destino.postal.calle string Calle del destinatario ✅
destino.postal.numero string N煤mero de la direcci贸n ✅
destino.postal.localidad string Ciudad de destino (Ej: Burzaco) ✅
destino.postal.region string Provincia de destino (Ej: Buenos Aires) ✅
destino.postal.codigoPostal string C贸digo postal de destino ✅
# 👤 Datos del Remitente
Campo Tipo Descripci贸n Obligatorio
remitente.email string Email del remitente ✅
remitente.telefonos string Tel茅fono del remitente ✅
# 👤 Datos del Destinatario
Campo Tipo Descripci贸n Obligatorio
destinatario.nombreCompleto string Nombre completo del destinatario ✅
destinatario.documentoNumero string N煤mero de documento del destinatario ✅
destinatario.email string Email del destinatario ✅
destinatario.telefonos string Tel茅fono del destinatario ✅
# ⚙️ Configuraci贸n del Env铆o
Campo Tipo Descripci贸n Obligatorio
tipoServicio string Tipo de operaci贸n: DELIVERY, RETURN, EXCHANGE ✅
idCliente string ID 煤nico del env铆o generado por el cliente ✅
# 📦 Campos para Paquetes
Campo Tipo Descripci贸n Obligatorio
bultos.kilos number Peso del paquete en kilogramos ✅
bultos.largoCm number Largo del paquete en cent铆metros ✅
bultos.altoCm number Alto del paquete en cent铆metros ✅
bultos.anchoCm number Ancho del paquete en cent铆metros ✅
bultos.numeroPaquete number Indica n煤mero de paquete ✅
tipo_paquete string Si se trata de un paquete a agregar a un env铆o original deber谩 ir en "true" ✅ (obligatorio para paquetes)
id_externo string id devuelto en el env铆o original ✅ (obligatorio para paquetes subsiguientes. El primer paquete se crea autom谩ticamente si el tipo_paquete es true)

# Ejemplo de Request 

{
    "provider_data": {
        "provider": "Jipink",
        "USER": "Bearer PAT-TKzXMPWaA1J82rjBLY6kDoEdweGR76Qb3-ZDjCkEg4x_-_XbAsAMSrhILEIVn7DlEorHb-6wOvZ7T3hz7f_WqJgqMMzcZmA0so"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "1407",
                "calle": "Burgos",
                "numero": "120",
                "piso": "2",
                "depto": "C",
                "localidad": "Almagro",
                "region": "Buenos Aires",
                "pais": "AR",
                "entreCalle": "",
                "firstName": "Alberto",
                "lastName": "Fern谩ndez"
            }
        },
        "fecha_alta": "",
        "tipoServicio": "DELIVERY",
        "tipo_paquete": "",
        "id_externo": "",
        "modalidad_envio": "",
        "direccion_envio": "",
        "correo": "andreani",
        "currency": "",
        "type": "",
        "destino": {
            "sucursal": {
                "id": ""
            },
            "postal": {
                "codigoPostal": "1025",
                "calle": "20 de Septiembre",
                "numero": "1756",
                "piso": "2",
                "depto": "C",
                "localidad": "Villa Devoto",
                "region": "Buenos Aires",
                "pais": "AR",
                "entreCalle": ""
            }
        },
        "remitente": {
            "nombreCompleto": "",
            "email": "remitente@andreani.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": "113332244"
        },
        "destinatario": {
            "nombreCompleto": "Juana Gonzalez",
            "email": "destinatario@andreani.com",
            "documentoTipo": "DNI",
            "documentoNumero": "33999888",
            "telefonos": "1112345678"
        },
        "productoAEntregar": "",
        "bultos": {
            "kilos": "",
            "largoCm": "",
            "altoCm": "",
            "anchoCm": "",
            "volumenCm": "",
            "valorDeclaradoSinImpuestos": "",
            "valorDeclaradoConImpuestos": "",
            "detalle": "",
            "idCliente": "6543"
            "numeroPaquete": "1"
        }
    }
}

# Response

La API puede devolver dos tipos de respuesta seg煤n el tipo de operaci贸n:

# 📦 Response - Creaci贸n de Env铆o

Campo Tipo Descripci贸n
response string Estado de la respuesta
providerStatus string Estado del env铆o en Jipink
numeroDeEnvio string N煤mero de env铆o (usado para obtener etiqueta)
idPadre number ID de transacci贸n del env铆o, deber谩 agregarse en id_externo para agregar un paquete al env铆o original
hash string Hash del env铆o
sucursalDeDistribucion object Informaci贸n de la sucursal de distribuci贸n
sucursalDeRendicion object Informaci贸n de la sucursal de rendici贸n
sucursalDeImposicion object Informaci贸n de la sucursal de imposici贸n
numeroDePermisionaria string N煤mero de permisionaria
descripcionServicio string Descripci贸n del servicio
etiqueta string URL de la etiqueta 
{
    "response": "Success",
    "providerStatus": "Creado",
    "numeroDeEnvio": "S67O2",
    "idPadre": 1061,
    "hash": null,
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": null,
    "etiqueta": ""
}

# 📦 Response - Paquete A帽adido

Campo Tipo Descripci贸n
response string Estado de la respuesta
providerStatus string Estado del env铆o en Jipink ("Package added")
numeroDeEnvio string N煤mero de env铆o del padre
numeroDeEnvioPaquete string N煤mero de env铆o para obtener etiqueta de paquete
idPadre number ID del paquete padre
idPaquete number ID de transacci贸n del paquete agregado
package object Informaci贸n del paquete agregado
package.package_number number N煤mero de paquetes agregados al env铆o original
package.origin string Env铆o original
sucursalDeDistribucion object Informaci贸n de la sucursal de distribuci贸n
sucursalDeRendicion object Informaci贸n de la sucursal de rendici贸n
sucursalDeImposicion object Informaci贸n de la sucursal de imposici贸n
numeroDePermisionaria string N煤mero de permisionaria
descripcionServicio string Descripci贸n del servicio
etiqueta string URL de la etiqueta 
{
    "response": "Success",
    "providerStatus": "Package added",
    "numeroDeEnvioPaquete": "S2RP7",
    "numeroDeEnvio": "S3YLB",
    "idPadre": 1136,
    "idPaquete": 1138,
    "package": {
        "package_number": 2
    },
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": null,
    "etiqueta": ""
}

# 2. Obtener Etiqueta

# Endpoint 

GET /api/shipping/etiqueta/:id

# Descripci贸n

Devuelve la URL de la etiqueta para un env铆o espec铆fico.

# Par谩metros

# Path Parameters

Campo Tipo Descripci贸n Obligatorio
id string N煤mero de env铆o ✅

# Headers

Campo Tipo Descripci贸n Obligatorio
provider string Nombre del proveedor (Jipink) ✅
user string Token de autorizaci贸n ✅

# Ejemplo de Headers 

provider: Jipink
user: Bearer PAT-TKzXMPWaA1J82rjBLY6kDoEdweGR76Qb3-ZDjCkEg4x_-_XbAsAMSrhILEIVn7DlEorHb-6wOvZ7T3hz7f_WqJgqMMzcZmA0so

# Response 

{
    "url": "https://jipink.s3.us-west-2.amazonaws.com/lms/6f11d1b4-ba0f-422c-af19-8a18f833da2b.pdf"
}

# 3. Obtener Tracking

# Endpoint 

GET /api/shipping/:id

# Descripci贸n

Devuelve el estado actual del env铆o.

# Par谩metros

# Path Parameters

Campo Tipo Descripci贸n Obligatorio
id string N煤mero de env铆o ✅

# Headers

Campo Tipo Descripci贸n Obligatorio
provider string Nombre del proveedor (Jipink) ✅
user string Token de autorizaci贸n ✅

# Ejemplo de Headers 

provider: Jipink
user: Bearer PAT-TKzXMPWaA1J82rjBLY6kDoEdweGR76Qb3-ZDjCkEg4x_-_XbAsAMSrhILEIVn7DlEorHb-6wOvZ7T3hz7f_WqJgqMMzcZmA0so

# Response

Campo Tipo Descripci贸n
response string Estado de la respuesta
providerStatus string Estado actual del env铆o
numeroDeEnvio string N煤mero del env铆o
sucursalDeDistribucion object Informaci贸n de la sucursal de distribuci贸n
sucursalDeRendicion object Informaci贸n de la sucursal de rendici贸n
sucursalDeImposicion object Informaci贸n de la sucursal de imposici贸n
numeroDePermisionaria string N煤mero de permisionaria
descripcionServicio string Descripci贸n del servicio
url string URL con informaci贸n adicional del env铆o 
{
    "response": "Success",
    "providerStatus": "TO_COLLECT",
    "numeroDeEnvio": "S8Y9G",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": null
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": "",
    "url": "https://jip.ink/s/S8Y9G"
}

# 锟斤拷 Notas Importantes

  • Todos los endpoints requieren autenticaci贸n mediante el token Bearer
  • El numeroDeEnvio es necesario para obtener la etiqueta y consultar el tracking
  • Los estados de env铆o pueden variar seg煤n el tipo de servicio seleccionado
  • La URL de tracking proporciona informaci贸n adicional en la plataforma de Jipink

# 🔗 Recursos Adicionales

漏 Copyright 2025. All rights reserved.