Skip to main content

Create - Addresses

POST 
/api/address

Request to create an address in the system. This address will automatically be associated with you, and you can use the _id to designate it as the origin/destination of the Auctions when you create them.

Please note that we will need certain data to verify the address, as well as to determine the actual location of the address. In case of doubts or issues, GPS will be used to determine if the address is correct or not.

Request​

Body

    lat string

    Address latitude

    lng string

    Address longitude

    phone integer

    Address phone

    name string

    Address name

    company_name string

    Address company name

Responses​

Example response

Schema
    status integer
    data object

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _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.

Loading...