# Enviopack

# 1. Generar envío

POST /api/shipping/create

El método permite generar un envío.

# provider_data

provider: (Tipo de dato: string). Enviopack. Campo obligatorio.
API_KEY: (Tipo de dato: string). Api key provista por Enviopack. Campo obligatorio.
API_SECRET: (Tipo de dato: string). Api secret provista por Enviopack. Campo obligatorio.

# shippment_data

destinatario.nombreCompleto: (Tipo de dato: string). Nombre y apellido. Campo obligatorio.
destinatario.email: (Tipo de dato: string). Campo obligatorio.
destinatario.telefono: (Tipo de dato: string). Campo obligatorio.
id_externo: (Tipo de dato: string). Número de orden. Campo obligatorio.
tipoServicio: (Tipo de dato: string). Tipo de servicio. Campo obligatorio. Valores posibles
- N: para el servicio estándar
- P: para el servicio prioritario
- X: para el servicio express
- R: para el servicio de devoluciones
type: (Tipo de dato: string). Indica si el operador logístico debe retirar el paquete desde el depósito del vendedor o si el vendedor lo llevará a una sucursal. Valores posibles: D para retiro por domicilio, S para retiro por sucursal. Campo obligatorio.
modalidad_envio: (Tipo de dato: string). Modalidad de envío. Los valores posibles son D para domicilio o S para sucursal. Campo obligatorio.
fecha_alta: Tipo de dato: string. Fecha en que se genera el pedido. (Ejemplo: "2016-04-26 13:52:00") Campo obligatorio.
correo: (Tipo de dato: string). El campo hace referencia al OOLL que se utilizará a través de Enviopack. Si el envío es a domicilio, en el campo de "correo" deberá informarse el valor ID devuelto por el webservice de correos. ATENCIÓN: El campo puede ir vacío solo si en la plataforma de Enviopack se generó una regla para adjudicar OOLL por defaulr y otra para confirmar envío. Caso contrario deberá completarse (Campo obligatorio). Si bien los valores que puede asumir este campo son:
- andesmar
- andreani_bigger
- andreani
- cccargas
- chazki
- demonte
- hop
- oca
- rayo_entregas
- urbano
destino.sucursal.id: (Tipo de dato: string). Si el envío es a sucursal, en el campo "sucursales" deberá enviarse el valor ID devuelto el método "Obtener sucursales" (Ver punto 5). Campo obligatorio si el envío es a sucursal.
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.
destino.postal.codigoPostal: (Tipo de dato: string). Campo obligatorio.
destino.postal.localidad: (Tipo de dato: string). Campo obligatorio.
destino.postal.region: (Tipo de dato: string). Id de provincia. Los IDs de provincias están bajo el estándar ISO_3166-2:AR sin el prefijo "AR-". Campo obligatorio.
direccion_envio: (Tipo de dato: integer). ID que identifica la dirección, por donde el correo pasara a retirar la mercadería a enviar. Puede ser número de depósito. Campo obligatorio.
bultos.altoCm: (Tipo de dato: integer) En cm. sin dígitos decimales. Campo obligatorio.
bultos.anchoCm: (Tipo de dato: integer) En cm. sin dígitos decimales. Campo obligatorio.
bultos.largoCm:(Tipo de dato: integer) En cm. sin dígitos decimales. Campo obligatorio.
bultos.kilos: (Tipo de dato: float) En kg. con hasta 2 dígitos decimales. Campo obligatorio.
bultos.valorDeclaradoConImpuestos: (Tipo de dato: float) Con hasta 2 dígitos decimales. Campo obligatorio.

REQUEST

{
    "provider_data": {
        "provider": "Enviopack",
        "API_KEY": "b0f7fa25018f0259d893526e674cd23541568609",
        "API_SECRET": "bc3c1bfdcb259881445d88468da03d93d8782a0d" 
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "1191",
                "calle": "Medrano",
                "numero": "700",
                "piso": "2",
                "depto": "b",
                "localidad": "Almagro",
                "region": "CABA",
                "pais": "Argentina",
                "entreCalle": ""
            }
        },
        "fecha_alta": "2016-04-26 13:52:00",
        "tipoServicio": "N",
        "tipo_paquete": "",
        "id_externo": "9350",  
        "modalidad_envio": "D",
        "direccion_envio": 14466, 
        "correo": "andreani",                                                
        "currency": "",
        "type": "S",
        "destino": {
            "sucursal": {
                "id": ""
            },
            "postal": {
                "codigoPostal": "1405",
                "calle": "Ambrosetti",
                "numero": "435",
                "piso": "3",
                "depto": "a",
                "localidad": "Caballito",
                "region": "C",
                "pais": "Argentina",
                "entreCalle": ""
            }
        },
        "remitente": {
            "nombreCompleto": "Juan Valdez",
            "email": "juanperez@gmail.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": "011 4965-1453",
            "marca": "POW"
        },
        "destinatario": {
            "nombreCompleto": "Juan Perez",
            "nombre": "Juana",
            "apellido": "Gonzalez",
            "email": "uanperez@gmail.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefono": "011 4965-1453"
        },
        "productoAEntregar": "",
        "bultos": {
            "kilos": 2.5,
            "largoCm": 4,
            "altoCm": 52,
            "anchoCm": 42,
            "volumenCm": "",
            "valorDeclaradoSinImpuestos": "",
            "valorDeclaradoConImpuestos": 1234.50,
            "detalle": "",
            "idCliente": ""
        }
    }
}

RESPONSE

numeroDeEnvio: Número de envío. Se usa para generar etiqueta y tracking.

{
    "response": "Success",
    "providerStatus": "Creado",
    "numeroDeEnvio": 7019137,
    "tracking_number": "",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": null,
    "etiqueta": ""
}

# 2. Obtener etiqueta

GET /api/shipping/etiqueta/:id

El método devuelve el pdf de la etiqueta de envío.

REQUEST

Va en el header.

provider: Enviopack. Campo obligatorio.
APIKEY: Api key provista por Enviopack. Campo obligatorio.
APISECRET: Api secret provista por Enviopack. Campo obligatorio.

provider: Enviopack
APIKEY: b0f7fa25018f0259d893526e674cd23541568609
APISECRET: bc3c1bfdcb259881445d88468da03d93d8782a0d

RESPONSE

Devuelve la etiqueta en formato pdf.

# 3. 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: Enviopack. Campo obligatorio.
APIKEY: Api key provista por Enviopack. Campo obligatorio.
APISECRET: Api secret provista por Enviopack. Campo obligatorio.

provider: Enviopack
APIKEY: b0f7fa25018f0259d893526e674cd23541568609
APISECRET: bc3c1bfdcb259881445d88468da03d93d8782a0d

RESPONSE

providerStatus: Devuelve el status del envío.
fecha: Informa la fecha y hora en que se creó el envío.

{
    "response": "Success",
    "providerStatus": "El envío esta en el depósito del vendedor",
    "numeroDeEnvio": "7019137",
    "fecha": "29/06 16:05",
    "mensaje": "El envío esta en el depósito del vendedor",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": null
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": "",
    "etiqueta": ""
}

# 4. Obtener localidades

GET /api/shipping/coverage/regions

REQUEST

Todos estos campos van en el header:

provider: Enviopack. Campo obligatorio.
APIKEY: Api key provista por Enviopack. Campo obligatorio.
APISECRET: Api secret provista por Enviopack. Campo obligatorio.
provincia: Id de provincia provisto por Enviopack. Campo obligatorio. La opciones son:
- "id": "B", "nombre": "Buenos Aires"
- "id": "C", "nombre": "Capital Federal"
- "id": "K", "nombre": "Catamarca"
- "id": "H", "nombre": "Chaco"
- "id": "U", "nombre": "Chubut"
- "id": "X", "nombre": "Córdoba"
- "id": "W", "nombre": "Corrientes"
- "id": "E", "nombre": "Entre Ríos"
- "id": "P", "nombre": "Formosa"
- "id": "Y", "nombre": "Jujuy"
- "id": "L", "nombre": "La Pampa"
- "id": "F", "nombre": "La Rioja"
- "id": "M", "nombre": "Mendoza"
- "id": "N", "nombre": "Misiones"
- "id": "Q", "nombre": "Neuquén"
- "id": "R", "nombre": "Río Negro"
- "id": "A", "nombre": "Salta"
- "id": "J", "nombre": "San Juan"
- "id": "D", "nombre": "San Luis"
- "id": "Z", "nombre": "Santa Cruz"
- "id": "S", "nombre": "Santa Fe"
- "id": "G", "nombre": "Santiago del Estero"
- "id": "V", "nombre": "Tierra del Fuego"
- "id": "T", "nombre": "Tucumán"

provider: Enviopack
APIKEY: b0f7fa25018f0259d893526e674cd23541568609
APISECRET: bc3c1bfdcb259881445d88468da03d93d8782a0d
provincia: C

RESPONSE

Devuelve un array de localidades con sus respectivos id.

id: id de la localidad.
nombre: nombre de la localidad.

[
    {
        "id": "134",
        "nombre": "Barracas",
        "provincia": {
            "id": "C",
            "nombre": null
        }
    }
        "id": "135",
        "nombre": "Belgrano",
        "provincia": {
            "id": "C",
            "nombre": null
        }
    }
        "id": "373",
        "nombre": "Boedo",
        "provincia": {
            "id": "C",
            "nombre": null
        }
    }
]

# 5. Obtener sucursales

GET /api/subsidiary

REQUEST

Todos estos campos van en el header:

provider: Enviopack. Campo obligatorio.
APIKEY: Api key provista por Enviopack. Campo obligatorio.
APISECRET: Api secret provista por Enviopack. Campo obligatorio.
localidad: Id de localidad devuelta por método "Obtener sucursales" (Ver punto 4). Campo obligatorio.

provider: Enviopack
APIKEY: b0f7fa25018f0259d893526e674cd23541568609
APISECRET: bc3c1bfdcb259881445d88468da03d93d8782a0d
localidad: 144

RESPONSE

Devuelve un array de localidades con sus respectivos id.

id: id de la sucursal.

[
    {
        "id": 53,
        "codigo": "PLO",
        "nombre": "Palermo",
        "calle": "Godoy Cruz",
        "numero": "2746",
        "piso": null,
        "depto": null,
        "codigo_postal": "1425",
        "localidad": {
            "id": "144",
            "nombre": "Palermo",
            "provincia": {
                "id": "C",
                "nombre": null
            }
        },
        "telefono": "4775-9390",
        "horario": "Lun a Vie 8:30 a 12:30 hs. - 15 a 19 hs. | Sab 8:30 a 12:30 hs.",
        "latitud": -34.57816033,
        "longitud": -58.42504504,
        "correo": {
            "id": "oca",
            "nombre": "OCA",
            "tiene_sucursales": true,
            "requiere_remito_legal": false,
            "permite_usar_seguro": true,
            "usa_distribucion_enviopack": true
        }
    }
]