README

Install
Specific methods
Generic methods

Install

With Composer

From command line

composer require enviopack/sdk:0.1.9

As a dependency in your project's composer.json

{
    "require": {
        "enviopack/sdk": "0.1.9"
    }
}

By downloading

Clone/download this repository
Copy lib/enviopack.php to your project's desired folder.

Specific methods

Configure your credentials

Get your API_KEY and SECRET_KEY in the following address: https://app.enviopack.com/configuraciones-api

require_once ('enviopack.php');

$ep = new EnvioPackApi ("API_KEY", "SECRET_KEY");

Methods

Check credentials

$result = $ep->check_credentials();

print_r( $result );

Get default store source address

$result = $ep->source_address();

print_r( $result );

Get source address by ID

$params = array
(
    'id' => '1081',
);

$result = $ep->source_address( $params );

print_r( $result );

Get shipment quotes from available couriers

$params = array
(
    'provincia'       => 'Z', // Santa Cruz
    'codigo_postal'   => '9400',
    'peso'            => '0.35',
    'paquetes'        => '20x2x10',
    'despacho'        => 'S',
    'modalidad'       => 'D',
    'direccion_envio' => '1081', // Change with your source address ID
);

$result = $ep->get_quote( $params );

print_r( $result );

Quote customer home delivery price

$params = array
(
    'provincia'     => 'Z', // Santa Cruz
    'codigo_postal' => '9400',
    'peso'          => '0.35',
    'paquetes'      => '20x2x10',
    'direccion_envio' => '1081', // Change with your source address ID
);

$result = $ep->quote_home_delivery_price( $params );

print_r ($result);

Quote customer branch delivery price

$params = array
(
    'provincia'     => 'Z', // Santa Cruz
    'codigo_postal' => '9400',
    'peso'          => '0.35',
    'paquetes'      => '20x2x10',
    'direccion_envio' => '1081', // Change with your source address ID
);

$result = $ep->quote_branch_delivery_price( $params );

print_r ($result);

Create order

$params = array
(
    "id_externo" => 'external_reference', // Change this
    "nombre"     => 'John',
    "apellido"   => 'Doe',
    "email"      => 'john@doe.com',
    "telefono"   => '1111-5555',
    "localidad"  => 'Río Gallegos',
    "provincia"  => 'Z', // Santa Cruz
    "monto"      => '252.52',
    "fecha_alta" => date( "c" ),
    "pagado"     => true,
);

$result = $ep->create_order( $params );

print_r( $result );

Create shipment

$params = array
(
    "pedido"          => '222555', // Get this from create_order()
    "direccion_envio" => '1081',
    "destinatario"    => 'John Doe',
    "confirmado"      => true,
    "paquetes"        => array(
        array(
            "alto"  => 20,
            "ancho" => 2,
            "largo" => 10,
            "peso"  => 0.35,
        )
    ),
    "despacho"        => "S",
    "modalidad"       => "D",
    "servicio"        => 'N',
    "correo"          => 'oca',
    "calle"           => 'Av. José de San Martín',
    "numero"          => '457',
    "piso"            => null,
    "depto"           => null,
    "codigo_postal"   => '9400',
    "provincia"       => 'Z', // Santa Cruz
    "localidad"       => '133', // Río Gallegos
);

$result = $ep->create_shipment( $params );

print_r( $result );

Get PDF print labels

// Shipment IDs Array. May contain just one element
$shipmentIDS  = array( 
    '111111',
    '222222',
    '333333',
);

$result = $ep->get_print_labels( $params );

print_r( $result );

Generic methods

You can access any resource from the EnvíoPack API using the generic methods. The basic structure is:

$ep->[method]($request)

where request can be:

array(
    "uri" => "The resource URI, relative to https://api.enviopack.com",
    "params" => "Optional. Key=>Value array with parameters to be appended to the URL",
    "data" => "Optional. Object or String to be sent in POST and PUT requests",
    "headers" => "Optional. Key => Value array with custom headers, like content-type: application/x-www-form-urlencoded",
    "authenticate" => "Optional. Boolean to specify if the GET method has to authenticate with credentials before request. Set it to false when accessing public APIs"
)

Examples:

// Get a resource, with optional URL params. Also you can disable authentication for public APIs
$ep->get (
    array(
        "uri" => "/resource/uri",
        "params" => array(
            "param" => "value"
        ),
        "headers" => array(
            "header" => "value"
        ),
        "authenticate" => true
    )
);

// Create a resource with "data" and optional URL params.
$ep->post (
    array(
        "uri" => "/resource/uri",
        "params" => array(
            "param" => "value"
        ),
        "headers" => array(
            "header" => "value"
        ),
        "data" => [data]
    )
);

// Update a resource with "data" and optional URL params.
$ep->put (
    array(
        "uri" => "/resource/uri",
        "params" => array(
            "param" => "value"
        ),
        "headers" => array(
            "header" => "value"
        ),
        "data" => [data]
    )
);

// Delete a resource with optional URL params.
$ep->delete (
    array(
        "uri" => "/resource/uri",
        "params" => array(
            "param" => "value"
        ),
        "headers" => array(
            "header" => "value"
        )
    )
);

enviopack / sdk

Maintainers

Details