Skip to content

Latest commit

 

History

History
228 lines (169 loc) · 6.55 KB

DOCS.md

File metadata and controls

228 lines (169 loc) · 6.55 KB

Documentación Andreani SDK Rest - PHP

Inicialización

require_once __DIR__.'/vendor/autoload.php';

use AlejoASotelo\Andreani;

$ws = new Andreani($user, $pass, $cliente, $debug);

getProvincias()

Lista las provinicas reconocidas según ISO-3166-2:AR:

$result = $ws->getProvincias();

var_dump($result);

getSucursales()

Obtener todas las sucursales de Andreani:

$result = $ws->getSucursales();

var_dump($result);

getSucursalByCodigoPostal($codigoPostal)

Obtener las sucursales recomendadas para un código postal usando la api v2:

$result = $ws->getSucursalByCodigoPostal(1832);

var_dump($result);

getPuntosDeTerceros($contrato, $params = null)

Obtener todas los puntos de terceros (HOP) de Andreani:

$result = $ws->getPuntosDeTerceros('12345678');

var_dump($result);

Parámetros

A continuación se describen los parámetros que acepta $params:

Parámetro Descripción Tipo Obligatorio
contrato Número de contrato que permite filtrar string Sí
admiteEnvios Permite filtrar por admisión de envíos boolean No
entregaEnvios Permite filtrar por entrega de envíos boolean No
codigo Código de la sucursal string No
sucursal Nombre de la sucursal abreviado string No
region Nombre de la región abreviado string No
localidad Nombre de la localidad string No
codigoPostal Código postal atendido por la sucursal string No
canal Canal (B2C) para filtrar string No
seHaceAtencionAlCliente Hace atención al cliente boolean No
conBuzonInteligente Cuenta con Buzón Inteligente boolean No
numero ID de la sucursal no unificado string No
id ID de la sucursal string No
atencionPorCodigoPostal Búsqueda de sucursales por código postal string No

Obtener todas los puntos de terceros para el código postal 1832 y el canal B2C:

$params = [
    'codigoPostal' => 1832,
    'canal' => 'B2C'
];
$result = $ws->getPuntosDeTerceros('12345678', $params);

var_dump($result);

cotizarEnvio($cpDestino, $contrato, $bultos)

Obtener la cotización para un envío según código postal, contrato, bultos, cliente, etc:

$bultos = array(
    array(
        'volumen' => 200,
        'kilos' => 1.3,
        'pesoAforado' => 5,
        'valorDeclarado' => 1200, // $1200
    ),
);

$result = $ws->cotizarEnvio(1832, '300006611', $bultos, 'CL0003750');

var_dump($result);

Ver ejemplo en el archivo examples/cotizarEnvio.php

addOrden($data)

Agrega/crea una orden (envío) pasandole como parámetro $data con la info del envío. Puede ser pasado como un array o como string (json_encode).

Ver ejemplo en el archivo examples/addOrden.php

getEtiqueta($numeroAndreani, $tipo = Andreani::ETIQUETA_ESTANDAR)

Devuelve una etiqueta en formato PDF, que puede ser de bulto o remito a partir del numero andreani brindado en el alta.

$response = $ws->getEtiqueta($numeroAndreani);

if (!is_null($response) && isset($response->pdf)) {
    file_put_contents(__DIR__.'/getEtiqueta.pdf', $response->pdf);
}

Si el envío es un cambio, además de la etiqueta estandar hay que obtener el documento de cambio de la siguiente manera:

$response = $ws->getEtiqueta($numeroAndreani, Andreani::ETIQUETA_DOCUMENTO_DE_CAMBIO);

if (!is_null($response) && isset($response->pdf)) {
    file_put_contents(__DIR__.'/getEtiqueta-documentoDeCambio.pdf', $response->pdf);
}

getTrazabilidad($numeroAndreani, $apiVersion = Andreani::API_V2)

Devuelve la trazabilidad de un envío. La v1 y v2 son practicamente iguales, solo que en el response de la v2 sacaron algunos campos.

V1:

{
    "eventos": [
        {
            "Fecha":"2019-04-11T11:18:47",
            "Estado":"Pendiente de ingreso",
            "EstadoId":1,
            "Motivo":null,
            "MotivoId":0,
            "Submotivo":null,
            "SubmotivoId":0,
            "Sucursal":"",
            "SucursalId":0,
            "Ciclo":""
        }
    ]
}

V2:```json { "eventos": [ { "Fecha": "2021-03-09T11:08:03", "Estado": "Pendiente de ingreso", "EstadoId": 1, "Traduccion": "ENVIO INGRESADO AL SISTEMA", "Sucursal": "Sucursal Genérica", "SucursalId": 999, "Ciclo": "Distribution" } ] }


(!) Nota: en la v2 no devuelve el evento "entregado", estan trabajando para agregarlo. Para solventar este problema usar `getOrden()` y chequear el campo `estado` 
```php
$result = $ws->getTrazabilidad($numeroAndreani);

var_dump($result);

Ver ejemplo en el archivo examples/getTrazabilidad.php

getCodigoQR($informacion)

Devuelve un código QR en formato PNG pasandole como parametro un string. Puede ser el numero de envio o se le puede pasar un JSON.

Ejemplo 1:

$data = [
    'numeroDeEnvio' => $numeroDeEnvio
];

$informacion = json_encode($data);

$response = $ws->getCodigoQR($informacion);

if (!empty($response)) {
    file_put_contents(__DIR__.'/getCodigoQR.png', $response);
}

Ejemplo 2:

$data = [
    'numeroDeEnvio' => $numeroDeEnvio
];

$informacion = json_encode($data);

$response = $ws->getCodigoQR($informacion);

if (!empty($response)) {
    echo '<img src="data:image/png;base64,'.base64_encode($response).'" />';
}

(!) Cancelar envíos

En la nueva API no se pueden cancelar envíos. Andreani toma como cancelado un envío si no entra en distribución.

Proceso completo de Envío

En el archivo examples/procesoDeEnvio.php hay un ejemplo del proceso completo de envío. En cada paso se guarda el response en json y la etiqueta PDF en el último.

Proceso de Envío:

1. Cotizar el Envío
2. Crear una Orden
3. Obtener la Orden
4. Obtener la Trazabilidad
5. Obtener la Etiqueta.