# Chile Express

# 1. Consultar regiones

GET /api/shipping/coverage/regions

El método devuelve un listado de las regiones con sus códigos respectivos. Se utilizan para consultar cobertura.

REQUEST

Va en el header.

provider: ChileExpress. Campo obligatorio.

pass: Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

provider: ChileExpress
pass: a6979b4160c6465f85776f43b6c40ffb

RESPONSE

[
    {
        "regionId": "R1",
        "regionName": "TARAPACA",
        "ineRegionCode": 1
    },
    {
        "regionId": "R2",
        "regionName": "ANTOFAGASTA",
        "ineRegionCode": 2
    },
    {
        "regionId": "R3",
        "regionName": "ATACAMA",
        "ineRegionCode": 3
    }
]

# 2. Consultar cobertura

POST /api/shipping/coverage/

Devuelve los códigos de cobertura según la región y el tipo de cobertura. Se debe realizar una consulta para obtener código del origen y otra para el código de destino. Ambos se piden para generar envío o cotizar.

REQUEST

# provider_data

provider: ChileExpress. Campo obligatorio.

PASS: (Tipo de dato: string) Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

# shipment_data

region: (Tipo de dato: string) Código de región (regionId) obtenido en "Consultar regiones" sobre el que se quiere obtener cobertura. Campo obligatorio.
type: (Tipo de dato: string) Código de tipo de cobertura. Valores "0" Todas, "1" Comunas, "2" Sectores dentro de una comuna. Campo obligatorio.

{
    "provider_data":{
        "provider": "ChileExpress"
        "PASS": "a6979b4160c6465f85776f43b6c40ffb"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": ""
            }
        },
        "destino":{
            "postal": {
                "codigoPostal": ""
            }
        },
        "id_externo": "",
        "fecha_alta": "",
        "modalidad_envio": "",
        "currency": "",
        "type": "0",
        "productoAEntregar": "",
        "region": "R5"
    }
}

RESPONSE

codigoLocalidad: Código a ingresar en "codigoPostal" al generar envío o cotizar.
cobertura: Nombre de la cobertura. Se usa en CONTRATO_DOMICILIO de Consultar oficinas comerciales.
codigoRegion: Código de la región ingresado al enviar la consulta.

[
    {
        "codigoLocalidad": "ALGA",
        "codigoRegion": "R5",
        "cobertura": "ALGARROBO"
    },
    {
        "codigoLocalidad": "CALL",
        "codigoRegion": "R5",
        "cobertura": "CALLE LARGA"
    },
    {
        "codigoLocalidad": "CART",
        "codigoRegion": "R5",
        "cobertura": "CARTAGENA"
    }
]

# 3. Consultar oficinas comerciales

GET /api/subsidiary/

Devuelve un array con las oficinas comerciales en donde se puede retirar el envío.

REQUEST

Los campos van en el header.

provider: ChileExpress. Campo obligatorio.
oficinas: Código de tipo de oficina. Valores: "0" Sucursales propias, "4" Tiendas Pick Up. Campo obligatorio.
cobertura: Nombre de la cobertura obtenido en consultar Cobertura. Campo obligatorio.
region: Código de región devuelto en consultar Cobertura. Campo obligatorio.

pass: Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

provider: ChileExpress
oficinas: 0
cobertura: ALGARROBO
region: R5,
pass: a6979b4160c6465f85776f43b6c40ffb

RESPONSE

region: Región a la que pertenece la oficina comercial. Utilizar para generar un envío con retiro en oficina comercial.
localidad: Localidad a la que pertenece la oficina comercial. Utilizar para generar un envío con retiro en oficina comercial.
calle: Utilizar para generar un envío con retiro en oficina comercial.
numero: Utilizar para generar un envío con retiro en oficina comercial.
telefono
infoAdicional: Información complementaria de la dirección.
nombreOficina: Nombre de oficina.
codigoOficina: Código de oficina. Se debe ingresar en "destino.sucursal.id" para generar un envío con retiro en oficina comercial.

En caso de no existir oficina en esa región devuelve "No existe una oficina asociada a esta comuna"

 [
    {
        "region": "VALPARAISO",
        "localidad": "ALGARROBO",
        "calle": "AVENIDA CARLOS ALESSANDRI",
        "numero": 1628,
        "infoAdicional": "LOCAL 9",
        "telefono": "35 2481133",
        "nombreOficina": "ALGARROBO",
        "codigoOficina": 667
    }
]

# 4. Cotizar envío

POST /api/shipping/price

Devuelve un array con los servicios disponibles.

REQUEST

# provider_data

provider: (Tipo de dato: string). Nombre del OOLL ("ChileExpress"). Campo obligatorio
USER:(Tipo de dato: string). Número de Tarjeta Cliente Chilexpress (TCC). Campo obligatorio.
PASS:(Tipo de dato: string). Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

# shippment_data

origen.postal.codigoPostal: (Tipo de dato: string). Código de localidad (codigoLocalidad) de origen obtenido en Consultar cobertura. Campo obligatorio
destino.postal.codigoPostal: (Tipo de dato: string). Código de localidad (codigoLocalidad) de destino obtenido en Consultar cobertura. Campo obligatorio
productoAEntregar: (Tipo de dato: string). Tipo de producto a enviar; "1" Documento, "3" Encomienda. Campo obligatorio
bultos.kilo: (Tipo de dato: float). Peso del paquete en kilogramos, separado por punto. Campo obligatorio
bultos.largoCm: (Tipo de dato: float). Largo del paquete en centímetros, separado por punto. Campo obligatorio
bultos.anchoCm:(Tipo de dato: float). Ancho del paquete en centímetros, separado por punto. Campo obligatorio
bultos.altoCm: (Tipo de dato: float). Alto del paquete en centímetros, separado por punto. Campo obligatorio
bultos.valorDeclaradosConImpuestos: (Tipo de dato: string). Valor declarado del paquete. Campo obligatorio

{
    "provider_data":{
        "provider": "ChileExpress",
        "USER": "18578680",
        "PASS": "f25fbe75153b4f8e908e11fb5c958a1d"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "PLCA"
            }
        },
        "destino":{
            "postal": {
                "codigoPostal": "PLCA"
            }
        },
        "id_externo": "",
        "fecha_alta": "",
        "modalidad_envio": "",
        "currency": "",
        "type": "",
        "productoAEntregar": "3",
        "bultos": {
            "kilos": 1.0,
            "largoCm": 1.0,
            "altoCm": 1.0,
            "anchoCm": 1.0,
            "valorDeclaradoConImpuestos": 6000,
            "detalle": ""
        }
    }
}

RESPONSE

costo: Costo del envío.
tipoServicio: Tipo de servicio.
codigoServicio: Código identificador del servicio. Se debe ingresar en "type" de Generar envío.

[
    {
        "costo": 5527,
        "tipoServicio": "PRIORITARIO",
        "codigoServicio": 2
    },
    {
        "costo": 3685,
        "tipoServicio": "EXPRESS",
        "codigoServicio": 3
    }
]

# 5. Generar envío / Logística Inversa

POST /api/shipping/create

Se utiliza para gener un envío.

REQUEST

# provider_data

provider: (Tipo de dato: string). Nombre del OOLL ("ChileExpress"). Campo obligatorio.
USER: (Tipo de dato: string) Número de Tarjeta Cliente Chilexpress (TCC). Campo obligatorio.
CONTRATO_DOMICILIO: (Tipo de dato: string). Código de cobertura de origen obtenido obtenido en Consultar cobertura. Campo obligatorio.
CONTRATO_SUCURSAL: (Tipo de dato: string). Rut (número) asociado al Marketplace sin puntos. Campo obligatorio.
PASS:(Tipo de dato: string). Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

# shippment_data

origen.postal.codigoPostal: (Tipo de dato: string). Código de cobertura de origen obtenido en Consultar cobertura. Campo obligatorio.
origen.postal.calle: (Tipo de dato: string). Campo obligatorio.
origen.postal.numero: (Tipo de dato: string). Campo obligatorio.
origen.postal.piso: (Tipo de dato: string). Campo obligatorio.
origen.postal.dpto: (Tipo de dato: string). Campo obligatorio.
tipo_paquete: (Tipo de dato: string).Tipo de producto enviado: "2" Artículos Personales, "10000331" Celular, "2" Educación, "4" Vestuario, "5" Otros, "7" Tecnología. Campo obligatorio.
modalidad_envio: (Tipo de dato: string). Indicador si es una entrega en oficina comercial (true) o entrega en domicilio (false). En caso de ser (true), se debe agregar el campo "destino.sucursal.id" con "codigoOficina" obtenido en Consultar oficinas comerciales. Campo obligatorio.
tipoServicio: (Tipo de dato: string). ingresar "codigoServicio" obtenido en cotizar envío. Campo obligatorio. Algunos de los posibles valores son: (8) AMPM, (2) PRIORITARIO, (3) EXPRESS, (4) EXTENDIDO, (5) EXTREMO, (41) ENCOMIENDAS GRANDES, (42) ENCOMIENDAS GRANDES EXTENDIDO. (14) EXPRESS LDEV, (15) EXTENDIDO LDEV, (16) EXTREMO LDEV, (43) ENCOMIENDAS GRANDES LDEV (44) ENCOMIENDAS GRANDES EXTENDIDO LDEV.
type: (Tipo de dato: string). En caso de logística inversa enviar el valor "return". Campo obligatorio pra logística inversa.
destino.sucursal.id: (Tipo de dato: string). código obtenido en "codigoOficina" obtenido en Consultar oficinas comerciales si "modalidad_envio" está en "true". 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.depto: (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.
destinatario.nombreCompleto: (Tipo de dato: string). Campo obligatorio.
destinatario.email: (Tipo de dato: string). Campo obligatorio.
destinatario.telefonos: (Tipo de dato: string). Campo obligatorio.
bultos.kilo: (Tipo de dato: float). Peso del paquete en kilogramos, separado por punto. Campo obligatorio.
bultos.largoCm: (Tipo de dato: float). Largo del paquete en centímetros, separado por punto. Campo obligatorio.
bultos.altoCm: (Tipo de dato: float). Alto del paquete en centímetros, separado por punto. Campo obligatorio.
bultos.anchoCm: (Tipo de dato: float). Ancho del paquete en centímetros, separado por punto. Campo obligatorio.
bultos.valorDeclaradoConImpuestos: (Tipo de dato: string). Valor declarado del producto. Campo obligatorio.
productoAEntregar: (Tipo de dato: string). Código del tipo de producto a enviar; "1" Documento, "3" Encomienda. Campo obligatorio.
bultos.detalle: (Tipo de dato: string).ingresar una referencia que permite identificar el envío por parte del cliente. Se recomiendo número de orden que genera el envío. Campo obligatorio.

{
    "provider_data": {
        "provider": "ChileExpress",
        "CONTRATO_DOMICILIO": "PUDA", 
        "CONTRATO_SUCURSAL": "96756430",
        "USER": "18578680",
        "PASS": "d60e278768e24d8894ab748feba80ce5"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "PLCA",
                "calle": "Calle 7",
                "numero": "120",
                "piso": "2",
                "depto": "C",
                "localidad": "",
                "region": "",
                "pais": "",
                "entreCalle": ""
            }
        },
        "fecha_alta": "",
        "tipoServicio": "",
        "tipo_paquete": "1",
        "id_externo": "",  
        "modalidad_envio": false,
                                                                                    
        "direccion_envio": "", 
                                                                          
        "correo": "",
        "currency": "", 
        "type": "3",
        "destino": {
            "sucursal": {
                "id": "706"
            },
            "postal": {
                "codigoPostal": "PROV",
                "calle": "calle 45",
                "numero": "1756",
                "piso": "2",
                "depto": "C",
                "localidad": "",
                "region": "",
                "pais": "",
                "entreCalle": ""
            }
        },
        "remitente": {
            "nombreCompleto": "Alberto Lopez",
            "email": "remitente@andreani.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": "113332244"
        },
        "destinatario": {
            "nombreCompleto": "Juana Gonzalez",
            "email": "destinatario@andreani.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": "1112345678"
        },
        "productoAEntregar": "3",
        "bultos": {
            "kilos": 2.0,
            "largoCm": 1.1,
            "altoCm": 5.0,
            "anchoCm": 35.0,
            "volumenCm": "",
            "valorDeclaradoSinImpuestos": "",
            "valorDeclaradoConImpuestos": "1000",
            "detalle": "65432",
            "idCliente": ""
        }
    }
}

RESPONSE

numeroDeEnvio: Número de la Orden de Transporte (OT). Sirve para identificar el envío.
descripcionServicio: Número del certificado asociado al envío.
hash: Referencia del envío ingresada en el campo "bultos.detalle". Se usa para tracking.
etiqueta: Etiqueta en format Base 64.

{
    "response": "Success",
    "providerStatus": "Creado",
    "numeroDeEnvio": 712105929555,
    "hash": "Secador de pelo",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": 712105929393,
    "etiqueta": "/9j/4AAQSkZJRgABAQEAYABgAAD/ ..."
}

# 6. Reimprimir etiqueta

GET /api/shipping/etiqueta/:id

Este método se debe utilizar para reimprimir la etiqueta. La etiqueta original se devuelve al generar el 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: ChileExpress. Campo obligatorio.
pass:(Tipo de dato: string). Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

provider: ChileExpress
pass: d60e278768e24d8894ab748feba80ce5

RESPONSE

Devuelve la nueva etiqueta en formato Base 64.

# 7. Obtener tracking

GET /api/shipping/:id

REQUEST

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

Todos estos campos van en el header:

provider: ChileExpress. Campo obligatorio.
hash: Referencia del envío devuelta en el campo "hash" del envío. Campo obligatorio.
eventos: debe ir en "0". Campo obligatorio.
rut: Rut (número) asociado al Marketplace sin puntos ni dígito identificador. Ej:(76.002.437-6 va como 76002437) Campo obligatorio.
apiKey:(Tipo de dato: string). Ocp-Apim-Subscription-Key provista por Chile Express. Campo obligatorio.

provider: ChileExpress
eventos: 0
rut: 96756430
hash: 800018359
pass: d60e278768e24d8894ab748feba80ce5

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 PRE-RECEPCION",
    "numeroDeEnvio": "712105922640",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": null
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": "712105922522",
    "etiqueta": ""
}