Get address

GET 
/address

Get a paginated list of addresses

Request

Header Parameters

Authorization stringrequired

Token de Auth del Usuario

Responses

200

La respuesta de la lista de Direcciones está Paginada; por lo que cada objeto de la lista es de tipo Address. Y se tienen en cosideración cada uno de los puntos de la misma

application/json

Schema

Schema

data object
docs object[]
Array [
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
neighborhood string
placeId string
can_be_deleted boolean
isDefault boolean
createdAt string
updatedAt string
]
hasNextPage boolean
hasPrevPage boolean
limit integer
nextPage integer
page integer
pagingCounter integer
prevPage integer
totalDocs integer
totalPages integer
status integer

Example (from schema)

{
  "data": {
    "docs": [
      {
        "_id": "5d84f846b0f6ba698f544dbf",
        "city": "vigo",
        "company_name": "ABC Logistics",
        "country": "españa",
        "location": {
          "coordinates": [
            -8.7207,
            42.2406
          ],
          "type": "Point"
        },
        "name": "ABC Logistics Vigo",
        "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
        "phone": "+34981234567",
        "province": "Pontevedra",
        "state": "galicia",
        "street_address": "Rúa Concepción Arenal",
        "street_number": "4",
        "zipcode": "36201"
      }
    ],
    "hasNextPage": true,
    "hasPrevPage": true,
    "limit": 0,
    "nextPage": 0,
    "page": 0,
    "pagingCounter": 0,
    "prevPage": 0,
    "totalDocs": 0,
    "totalPages": 0
  },
  "status": 0
}

404

Not Found

Loading...