# Red Pack

# 1. Consultar cobertura

POST /api/shipping/coverage/

Devuelve los servicios ofrecidos en determinada área.

REQUEST

# provider_data
  • provider: (Tipo de dato: string) Red Pack. Campo obligatorio.

  • API_KEY: (Tipo de dato: string). Client_id provisto por Red Pack. Campo obligatorio.,

  • API_SECRET: (Tipo de dato: string) Client_secret provisto por Red Pack. Campo obligatorio.,

  • USER: (Tipo de dato: string). Username para loguearse en la plataforma de Red pack. Campo obligatorio.,

  • PASS: (Tipo de dato: string). Password para loguearse en la plataforma de Red pack. Campo obligatorio.

# shipment_data
  • origen.postal.codigoPostal: (Tipo de dato: string). Código postal de origen.Campo obligatorio.

  • destinatario.postal.codigoPostal: (Tipo de dato: string). Código postal de destino.Campo obligatorio.

{
    "provider_data":{
        "provider": "Red Pack",
        "API_KEY": "app-redpack-web", 
        "API_SECRET": "R3dPack&2020", 
        "USER": "MARTINK137", 
        "PASS": "137137"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "03940"
            }
        },
        "destino":{
            "postal": {
                "codigoPostal": "03940"
            }
        },
        "id_externo": "",
        "fecha_alta": "",
        "modalidad_envio": "",
        "currency": "",
        "type": "",
        "productoAEntregar": "",
        "region": ""
    }
}

RESPONSE

  • coverageType: Array de tipo de servicios comprendidos en la cobertura.
{
    "x": [
        {
            "origin": {
                "zipCodeOrigin": 3940,
                "suburbOrigin": "BENITO JUAREZ_"
            },
            "destiantion": {
                "zipCodeDestination": 3940,
                "suburb": "BENITO JUAREZ (MEX)",
                "state": "CIUDAD DE MEXICO"
            },
            "coverageType": [
                {
                    "coverage": "NORMAL",
                    "deliveryTime": 24,
                    "serviceType": {
                        "serviceType": "EXPRESS",
                        "deliveryType": "OCURRE",
                        "auxiliary": [
                            "CREDITO CONSTRUCTOR",
                            "",
                            "10:30"
                        ]
                    }
                },
                {
                    "coverage": "NORMAL",
                    "deliveryTime": 48,
                    "serviceType": {
                        "serviceType": "ECOEXPRESS",
                        "deliveryType": "DOMICILIO",
                        "auxiliary": [
                            "CREDITO CONSTRUCTOR",
                            "",
                            "10:30"
                        ]
                    }
                }
            ],
            "resultWS": [
                {
                    "status": 1,
                    "description": "GENERACIÓN CORRECTA",
                    "severity": 3
                }
            ]
        }
    ]
}

# 2. Consultar tipos de servicios

GET /api/shipping/services

Devuelve los tipos de servicios que ofrece el OOLL

REQUEST

  • provider: (Tipo de dato: string) Red Pack. Campo obligatorio.

  • apiKey: (Tipo de dato: string). Client_id provisto por Red Pack. Campo obligatorio.,

  • apiSecre: (Tipo de dato: string) Client_secret provisto por Red Pack. Campo obligatorio.,

  • user: (Tipo de dato: string). Username para loguearse en la plataforma de Red pack. Campo obligatorio.,

  • pass: (Tipo de dato: string). Password para loguearse en la plataforma de Red pack. Campo obligatorio.

RESPONSE

  • coverageType: Array de tipo de servicios comprendidos en la cobertura.
"x": [
        {
            "id": 0,
            "description": "CORREO INTERNO",
            "shortname": "GUIASCINT"
        },
        {
            "id": 1,
            "description": "EXPRESS",
            "shortname": "GUIASPREP"
        },
        {
            "id": 2,
            "description": "ECOEXPRESS",
            "shortname": "GUIASPAQ"
        },
        {
            "id": 3,
            "description": "INTERNACIONAL",
            "shortname": "GUIASINT15"
        },
    ]

# 3. Generar envío

POST /api/shipping/create

Se utiliza para gener un envío.

REQUEST

# provider_data
  • provider: (Tipo de dato: string) Red Pack. Campo obligatorio.

  • API_KEY: (Tipo de dato: string). Client_id provisto por Red Pack. Campo obligatorio.,

  • API_SECRET: (Tipo de dato: string) Client_secret provisto por Red Pack. Campo obligatorio.,

  • USER: (Tipo de dato: string). Username para loguearse en la plataforma de Red pack. Campo obligatorio.,

  • PASS: (Tipo de dato: string). Password para loguearse en la plataforma de Red pack. Campo obligatorio.

# shippment_data
  • origen.postal.codigoPostal: (Tipo de dato: string). Código postal de origen. Campo obligatorio.

  • origen.postal.calle: (Tipo de dato: string). Campo obligatorio.

  • origen.postal.numero: (Tipo de dato: string). Campo obligatorio.

  • origen.postal.localidad: (Tipo de dato: string). Campo obligatorio.

  • origen.postal.pais: (Tipo de dato: string). Campo obligatorio.

  • origen.postal.region: (Tipo de dato: string). Campo obligatorio.

  • remitente.nombreCompleto: (Tipo de dato: string). Campo obligatorio.

  • remitente.email: (Tipo de dato: string). Campo obligatorio.

  • remitente.telefonos: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.codigopostal: (Tipo de dato: string). Código de cobertura de destino obtenido obtenido en Consultar cobertura. Campo obligatorio.

  • destino.postal.calle: (Tipo de dato: string).Campo obligatorio.

  • destino.postal.numero: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.piso: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.departamento: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.pais: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.localidad: (Tipo de dato: string). Campo obligatorio.

  • destino.postal.region: (Tipo de dato: string). Campo obligatorio.

  • destinatario.nombreCompleto: (Tipo de dato: string). Campo obligatorio.

  • destinatario.email: (Tipo de dato: string). Campo obligatorio.

  • destinatario.telefonos: (Tipo de dato: string). Campo obligatorio.

  • items: (Tipo de dato: array). Campo obligatorio.

  • items.cantidad: (Tipo de dato: string). Cantidad de un mismo producto. Campo obligatorio.

  • items.kilos: (Tipo de dato: string). Peso en Kg. Campo obligatorio.

  • items.altoCm: (Tipo de dato: string). Altura en Cm. Campo obligatorio.

  • items.anchoCm: (Tipo de dato: string). Ancho en Cm. Campo obligatorio.

  • items.largoCm: (Tipo de dato: string). Largo en Cm. Campo obligatorio.

  • items.descripcion: (Tipo de dato: string). Título del producto. Campo obligatorio.

  • currency: (Tipo de dato: string). Tipo de moneda. Campo obligatorio.

  • modalidad_envio: (Tipo de dato: string). Tipo de delivery. (Valores posibles: 1-Ocurre, 2-Domicilio). Campo obligatorio.

  • id_externo: (Tipo de dato: string). Id Client de Red Pack. Campo obligatorio.

  • tipoServicio: (Tipo de dato: string). Tipo de servicio. Para pruebas en develop enviar siempre 1. (Valores posibles: 1-Express, 2-Ecoexpress, 4-Metropolitano). Campo obligatorio.

  • type: (Tipo de dato: string). Tipo de envío. (Valores posibles: 1-Paquete, 2-Sobre). Campo obligatorio.

  • valor_envio: (Tipo de dato: string). Valor estimado del envío (shipping value). Campo obligatorio.


{
    "provider_data": {
        "provider": "Red Pack",
        "API_KEY": "app-redpack-web", 
        "API_SECRET": "R3dPack&2020", 
        "USER": "MARTINK137", 
        "PASS": "137137"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "62250",
                "calle": "Domingo Diez",
                "numero": "120",
                "piso": "1",
                "departamento": "C",
                "localidad": "El Empleado",
                "region": "Monterrey",
                "pais": "MEX",
                "entreCalle": ""
            }
        },
        "fecha_alta": "",
        "tipoServicio": 1,
        "tipo_paquete": "",
        "id_externo": "119579",
        "modalidad_envio": 2,             
        "direccion_envio": "",                                                             
        "correo": "", 
        "currency": "MXN",
        "type": 1,
        "flow": "",
        "valor_envio": 999.99,
        "destino": {
            "sucursal": {
                "id": ""
            },
            "postal": {
                "codigoPostal": "03940",
                "calle": "AV INSURGENTES SUR",
                "numero": "1602",
                "piso": "1",
                "departamento": "C",
                "localidad": "Benito Juárez",
                "colonia": "Crédito Constructor",
                "region": "CDMX",
                "pais": "MEX",
                "entreCalle": "Entre estas calles"
            }
        },
        "remitente": {
            "nombreCompleto": "Gymco",
            "email": "remitente@andreani.com",
            "documentoTipo": "DNI",
            "documentoNumero": "33111222",
            "telefonos": "113332244"
        },
        "destinatario": {
            "nombreCompleto": "Juana Gonzalez",
            "email": "destinatario@andreani.com",
            "documentoTipo": "DNI",
            "documentoNumero": "33999888",
            "telefonos": "1112345678"
        },
        "productoAEntregar": "Aire Acondicionado",
        "items": [{
            "cantidad": "1",
            "kilos": "1",
            "largoCm": "5",
            "altoCm": "5",
            "anchoCm":" 5",
            "volumenCm": "",
            "valorContraReembolso": "",
            "valorDeclaradoConImpuestos": "",
            "sku": "",
            "descripcion": "Bermuda"
        }, 
        {
            "cantidad": "1",
            "kilos": "1",
            "largoCm": "5",
            "altoCm": "5",
            "anchoCm":" 5",
            "volumenCm": "",
            "valorContraReembolso": "",
            "valorDeclaradoConImpuestos": "",
            "sku": "",
            "descripcion": "Camisa"
        }]
    }
}

RESPONSE

  • numeroDeEnvio: Número de envío. Se utilizará para obtener estado de envío y etiqueta.

  • descripcionServicio: Devuelve un array con información.

{
    "response": "Success",
    "providerStatus": "Creado",
    "numeroDeEnvio": 026268602,
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": [],
    "etiqueta": ""
}

# 4. Imprimir etiqueta

GET /api/shipping/etiqueta/:id

Este método devuelve la etiqueta del envío en formato base64.

REQUEST

  • id: Número de envío. Va en el id de la url como ruta parametrizada. Campo obligatorio.

Este campo van en el header:

  • provider: (Tipo de dato: string) Red Pack. Campo obligatorio.

  • apiKey: (Tipo de dato: string). Client_id provisto por Red Pack. Campo obligatorio.,

  • apiSecre: (Tipo de dato: string) Client_secret provisto por Red Pack. Campo obligatorio.,

  • user: (Tipo de dato: string). Username para loguearse en la plataforma de Red pack. Campo obligatorio.,

  • pass: (Tipo de dato: string). Password para loguearse en la plataforma de Red pack. Campo obligatorio.

  • equivalence: (Tipo de dato: string). Campo obligatorio.

provider: Red Pack
apiKey: app-redpack-web
apiSecret: R3dPack&2020
user: MARTINK137
pass: 137137
equivalence: 

RESPONSE

Devuelve una etiqueta para cada uno de los productos/paquetes.

{
    "label 1":...,
    "label 2":...
}

# 5. Obtener tracking

GET /api/shipping/:id

REQUEST

Este método devuelve la etiqueta del envío.

REQUEST

  • id: Número de envío. Va en el id de la url como ruta parametrizada. Campo obligatorio.

Este campo van en el header:

  • provider: (Tipo de dato: string) Red Pack. Campo obligatorio.

  • apiKey: (Tipo de dato: string). Client_id provisto por Red Pack. Campo obligatorio.,

  • apiSecre: (Tipo de dato: string) Client_secret provisto por Red Pack. Campo obligatorio.,

  • user: (Tipo de dato: string). Username para loguearse en la plataforma de Red pack. Campo obligatorio.,

  • pass: (Tipo de dato: string). Password para loguearse en la plataforma de Red pack. Campo obligatorio.

provider: Red Pack
apiKey: app-redpack-web
apiSecret: R3dPack&2020
user: MARTINK137
pass: 137137

RESPONSE

  • providerStatus: Estado del envío.

  • numeroDeEnvio: Número de envío ingresado como id.

  • descripcionServicio: Número de certificado asociado al envío.

{
    "response": "Success",
    "providerStatus": "EN PREPARACION",
    "numeroDeEnvio": "026268602",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": null
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": ""
}