List - Addresses

GET 
/api/address

These are the addresses you have enabled to be used as origin/destination for the Auctions. Please note that you cannot set the same address as both origin and destination.

Request

Header Parameters

apikey stringrequired

Apikey of a company linked to a user

Responses

200

The response of the Address list is paginated, so each object in the list is of type Address. Each point of it is taken into consideration.

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}$
Internal ID for database usage.
city string
Possible values: non-empty
City of the address
company_name stringrequired
Possible values: non-empty
Name of the destination company. It will be used for data verification.
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
GPS location position
name string
Possible values: non-empty
Name (or nickname) you give to the address for your use
name_address stringrequired
Possible values: non-empty
Complete data
phone string
Possible values: non-empty
User's contact phone number
province string
Possible values: non-empty
Province of the address
state string
Possible values: non-empty
Province or Community of the address. In case it's not compatible with the address format, it may remain empty.
street_address string
Possible values: non-empty
Physical address; street, avenue, etc.
street_number string
Possible values: non-empty
House number of the address
zipcode stringrequired
Possible values: non-empty
Postal code of the address. It will depend on the country for the use of one format or another.
]
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
}

Loading...