Orígenes

API Docs v2

A la hora de crear un envío es obligatorio indicar el origen del mismo. Los orígenes se dan de alta en la cuenta de cada vendedor.

En Zippin, un origen podría ser compartido por mas de una cuenta, por lo que verás que ciertas configuraciones se realizan indicando una cuenta en particular.

Listado de orígenes

GET /addresses
Filtros en el query string:
account_id	int	ID de la cuenta (opcional)

Ejemplo:

GET https://api.zippin.com.ar/v2/addresses?account_id=70

RESPONSE 200
{
    "data": [
        {
            "id": 450,
            "name": "Direccion editada",
            "document": "20-32216766-6",
            "street": "Av Avellaneda",
            "street_number": "4055",
            "street_extras": "Local 34",
            "city": {
                "id": 1729,
                "name": "San Fernando"
            },
            "state": {
                "id": 2,
                "name": "Buenos Aires"
            },
            "zipcode": "1646",
            "phone": "1561222280",
            "email": "ejemplo@tienda.com.ar",
            "hours": {
                "open": "08:00",
                "close": "16:00"
            },
            "dropoff_only": false,
            "accounts": [
                {
                    "id": 70,
                    "name": "Tienda Local San Fernando",
                    "options": {
                        "automatic_status_change": true,
                        "pickup_days": [
                            "1",
                            "2",
                            "3",
                            "4",
                            "5"
                        ],
                        "preparation_time": null,
                        "use_preparation_time": false
                    }
                }
            ]
        },
        {
            (...)
        }
    ],
    "links": {
        "first": "https://api.zippin.com.ar/v2/addresses?page=1",
        "last": "https://api.zippin.com.ar/v2/addresses?page=6",
        "prev": null,
        "next": "https://api.zippin.com.ar/api/v2/addresses?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://api.zippin.com.ar/v2/addresses",
        "per_page": 20,
        "to": 20,
        "total": 2
    }
}

Detalle de un orígen

GET /addresses/{id}

Ejemplo:

GET https://api.zippin.com.ar/v2/addresses/450

RESPONSE 200
{
    "id": 450,
    "name": "Direccion editada",
    "document": "20-3226766-6",
    "street": "Av Avellaneda",
    "street_number": "4055",
    "street_extras": "Local 34",
    "city": {
        "id": 1729,
        "name": "San Fernando"
    },
    "state": {
        "id": 2,
        "name": "Buenos Aires"
    },
    "zipcode": "1646",
    "phone": "1561222280",
    "email": "ejemplo@tienda.com.ar",
    "hours": {
        "open": "08:00",
        "close": "16:00"
    },
    "dropoff_only": false,
    "accounts": [
        {
            "id": 70,
            "name": "Tienda Local San Fernando",
            "options": {
                "automatic_status_change": true,
                "pickup_days": [
                    "1",
                    "2",
                    "3",
                    "4",
                    "5"
                ],
                "preparation_time": null,
                "use_preparation_time": false
            }
        }
    ]
}

Crear un orígen

POST /addresses
Parámetros para el body:
account_id	int	ID de la cuenta
name	string	Nombre del Origen
document	string	CUIT o identificacion del origen
street	string	Calle del domicilio
street_number	string	Número de puerta del domicilio
street_extras	string	Datos adicionales de la dirección de origen
city	string	Localidad
state	string	Provincia
zipcode	string	Código postal del origen
phone	string	Telefono del origen
email	string	E-mail del orígen
hours	object	Objeto con dos claves, "open" y "close", que son strings.
options	objeto de opciones
dropoff_only	boolean	Si es `true`, solo se ofrecerán transportes a los que se puedan imponer los envíos en una sucursal (no hay recolecciones para envios con éste origen).
automatic_status_change	boolean	Si es `true`, el estado del envío cambiará a Listo para Despacho cuando se obtenga la documentación del envío.
pickup_days	array	Indica qué días se podrá hacer recolecciones al origen. Las opciones van del 0 (domingo) al 6 (sábado).
use_preparation_time	boolean	Si es `true`, el estado del envío cambiará a Listo para Despacho a las X horas de creado (X se configura en la siguiente opción).
preparation_time	integer	Cantidad de horas desde la creación para que un envío pase automáticamente a Listo para Despacho.

Ejemplo:

POST https://api.zippin.com.ar/v2/addresses

{
    "account_id": 7,
    "name": "Nueva direccion",
    "document": "20-31631866-6",
    "street": "Av San Martin",
    "street_number": "2345",
    "street_extras": "Nave 2",
    "city": "San Fernando",
    "state": "Buenos Aires",
    "zipcode": "1646",
    "phone": "119922444",
    "email": "sanfernando@tienda.com.ar",
    "hours": {
        "open": "08:00",
        "close": "16:00"
    },
    "options": {
    	"automatic_status_change": false,
    	"pickup_days": [
                    "1",
                    "3",
                    "5"
                ]
    }
}

La creación exitosa devolverá el recurso creado con un status 201.

Actualizar un orígen

PUT /addresses/450
Parámetros para el body:
account_id	int	ID de la cuenta (REQUERIDO EN TODOS LOS REQUESTS)
name	string	Nombre del Origen
document	string	CUIT o identificacion del origen
street	string	Calle del domicilio
street_number	string	Número de puerta del domicilio
street_extras	string	Datos adicionales de la dirección de origen
city	string	Localidad
state	string	Provincia
zipcode	string	Código postal del origen
phone	string	Telefono del origen
email	string	E-mail del orígen
hours	object	Objeto con dos claves, "open" y "close", que son strings.
options	objeto de opciones
dropoff_only	boolean	Si es `true`, solo se ofrecerán transportes a los que se puedan imponer los envíos en una sucursal (no hay recolecciones para envios con éste origen).
automatic_status_change	boolean	Si es `true`, el estado del envío cambiará a Listo para Despacho cuando se obtenga la documentación del envío.
pickup_days	array	Indica qué días se podrá hacer recolecciones al origen. Las opciones van del 0 (domingo) al 6 (sábado).
use_preparation_time	boolean	Si es `true`, el estado del envío cambiará a Listo para Despacho a las X horas de creado (X se configura en la siguiente opción).
preparation_time	integer	Cantidad de horas desde la creación para que un envío pase automáticamente a Listo para Despacho.

Ejemplo:

PUT https://api.zippin.com.ar/v2/addresses/450

{
    "account_id": 7,
    "name": "Nueva direccion editada",
    "hours": {
        "open": "08:00",
        "close": "16:00"
    },
    "options": {
    	"pickup_days": [
                    "2",
                    "4",
                    "6"
                ]
    }
}