API PC ARTS


Operación 1014: Consulta de Direcciones

Método: GET.
Parámetro del header "operation": 1014.
Header:
Parámetro Header
 Valor
 Observaciones
content-type
 application/json
x-session-token
 {{token}}
 Completar con el token asignado a su usuario. Tener en cuenta que en este esquema de autenticación no debe agregar el termino "bearer" antes del token.
operation
 1014
 Completar con el número de operación.

En esta imagen se muestra como configurar la consulta:
Api_header_1014.

Esta operación admite los siguientes parámetros de forma opcional:

Parámetro
Ejemplo observaciones
offset 0 
Parámetro utilizado para la paginación. Indica a partir de qué registro se desea consultar. El valor por defecto es 0 (cero), si no se especifica se tomará ese valor.
limit
 50
Parámetro utilizado para la paginación. Indica la cantidad máxima de registro que devolverá la consulta. Rango válido: 1 a 50, si no se especifica o se pone un valor inválido se tomará el valor por defecto 50.

Tener en cuenta que los parámetros admiten valores únicos. A continuación se muestra imagen de parámetros de consulta opcionales :

Api_params_1014
A continuación, detallamos alguno un ejemplo:

Consulta Direcciones de Entrega

Solicitud:

En este caso no se envía ningún parámetro adicional en la URL, ni body, alcanza con especificar el número de operación en el header.
Se recomienda utilizar los parámetros de paginación en caso de que el total de registros supere los 50.
La consulta devolverá  el listado de direcciones que tiene registradas su empresa como puntos para  envio de mercaderías.

Ejemplo de URL con paginación:    https://api.pcarts.com/operations?offset=0&limit=50

Respuesta:

Si la consulta se efectuó exitosamente deberá devolver un JSON con la lista de direcciones que están registradas como como posibles destinos de entrega de mercadería:

BODY Observaciones
{
    "addresses": [
        {
            "address_id": "11005000052",
            "street": "AV. PUEYRREDON 355",
            "floor": "",
            "room_number": "",
            "city": "CABA",
            "post_code": "1032",
            "province": "Capital Federal",
            "country_id": "AR",
            "ship_cond_id": "33",
            "ship_cond_desc": "Ret Cliente Distrito"
        },
        {
            "address_id": "6050004032",
           "street": "AV. FOREST 356",
            "floor": "",
            "room_number": "",
            "city": "BUENOS AIRES",
            "post_code": "1636",
            "province": "Capital Federal",
            "country_id": "AR",
            "ship_cond_id": "20",
            "ship_cond_desc": "Distribución propia"
        },
        {
            "address_id": "6008004033",
            "street": "AV SAN MARTIN 5790",
            "floor": "",
            "room_number": "",
            "city": "LA TABLADA",
            "post_code": "1766",
            "province": "Gran Buenos Aires",
            "country_id": "AR",
            "ship_cond_id": "20",
            "ship_cond_desc": "Distribución propia"
        },
        {
            "address_id": "6009010956",
            "street": "Av. Santa Fe 3175",
            "floor": "",
            "room_number": "",
            "city": "CI",
            "post_code": "1429",
            "province": "Capital Federal",
            "country_id": "AR",
            "ship_cond_id": "20",
            "ship_cond_desc": "Distribución propia"
        },
        {
            "address_id": "6080013681",
            "street": "AV CABILDO 2020",
            "floor": "",
            "room_number": "",
            "city": "CIUDAD AUTONOMA BUENOS AIRES",
            "post_code": "1428",
            "province": "Capital Federal",
            "country_id": "AR",
            "ship_cond_id": "20",
            "ship_cond_desc": "Distribución propia"
        }
    ],
    "Paging": {
        "offset": 0,
        "limit": 50,
        "total": 5
    }
}
   El Json de respuesta contendrá un array "addresses", detallando  el código de identificación de cada dirección ("address_id")  y la infromación adicional de la misma, incluyendo el modo de envio por defecto para esa dirección ( "ship_cond_id").