Ubicaciones de cuenta

Una cuenta puede crear ubicaciones que pueden tener distintos usos. Todo parte de una dirección guardada, y sus usos incluyen:

• Pueden ser usados como origen de envíos (o destino de devoluciones)

• Pueden ser usados como almacenes propios de la cuenta, y poder gestionar stock de sus productos.

• Pueden habilitarse como puntos de entrega de envíos.

Ubicaciones como orígenes de envío

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.

Listar orígenes

GET /v2/addresses

Query Parameters

Name	Type	Description
account_id	int	ID de la cuenta

200: OK

{
    "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": "[email protected]",
            "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 /v2/addresses/{id}

Obtiene el detalle de un origen.

Path Parameters

Name	Type	Description
id*	int	ID del origen

200: OK

{
    "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": "[email protected]",
    "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 orígen

POST /v2/addresses

Request Body

Name	Type	Description
account_id*	int	ID de la cuenta
name*	string	Nombre del Origen
document*	string	CUIT/RUT 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 (piso, depto, local)
city*	string	Localidad (AR) | Comuna (CL) | Municipio (MX)
state*	string	Provincia (AR) | Region (CL) | Estado (MX)
zipcode*	string	Código postal del origen (opcional en CL)
phone*	string	Telefono del origen
email*	string	E-mail del orígen
hours*	object
hours.open*	string	Horario de apertura. Ej. "09:00"
hours.close*	string	Horario de cierre. Ej. "18:00"
options*	object
options.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).
options.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.
options.pickup_days*	array	Indica qué días se podrá hacer recolecciones al origen. Las opciones van del 0 (domingo) al 6 (sábado).
options.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).
options.preparation_time*	int	Cantidad de horas desde la creación para que un envío pase automáticamente a Listo para Despacho.
logistic_types	array	Array con los códigos de los logistic_types aceptados para este origen. Si se modifica, se debe enviar también default_logistic_type.
default_logistic_type	string	Código del logistic_type por defecto. Es obligatorio si se modifican los logistic_types.

201: Created

// Ejemplo Request:
{
    "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": "[email protected]",
    "logistic_types":[
                        "crossdock",
                        "carrier_pickup"
                    ],
    "default_logistic_type": "crossdock",
    "hours": {
        "open": "08:00",
        "close": "16:00"
    },
    "options": {
    	"automatic_status_change": false,
    	"pickup_days": [
                    "1",
                    "3",
                    "5"
                ]
    }
}

Modificar orígen

PUT /v2/addresses/{id}

Path Parameters

Name	Type	Description
id*	int	ID del origen

Request Body

Name	Type	Description
account_id*	int	ID de la cuenta. Siempre es requerido en todos los requests.
name	string	Nombre del Origen
document	string	CUIT/RUT 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 (piso, depto, local)
city	string	Localidad (AR) | Comuna (CL)
state	string	Provincia (AR) | Region (CL)
zipcode	string	Código postal del origen (opcional en CL)
phone	string	Telefono del origen
email	string	E-mail del orígen
hours	object
hours.open	string	Horario de apertura. Ej. "09:00"
hours.close	string	Horario de cierre. Ej. "18:00"
options	object
options.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).
options.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.
options.pickup_days	array	Indica qué días se podrá hacer recolecciones al origen. Las opciones van del 0 (domingo) al 6 (sábado).
options.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).
options.preparation_time	int	Cantidad de horas desde la creación para que un envío pase automáticamente a Listo para Despacho.
logistic_types	array	Array con los códigos de los logistic_types aceptados para este origen. Si se modifica, se debe enviar también default_logistic_type.
default_logistic_type	string	Código del logistic_type por defecto. Es obligatorio si se modifican los logistic_types.

200: OK

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