Addresses



In Arcadier, addresses can be used by many different functionalities in the system. By using the different properties, you are able to use addresses for the following: 

  1. Pickup Location
  2. Address book in the checkout page
  3. User’s address in login and settings page
  4. Item’s location

In Arcadier, the address book in the checkout page and the user’s address in login and settings pages are using the same things. Simply set delivery to “true” if you want to use this particular address in those pages. Pickup location in Arcadier meant a prearranged place where the Consumer goes to collect their item from the Merchant. Once created, these Pickup location will appear in the Item upload page for the Merchant to select which pickup point is available for that particular item. The Merchant has an endpoint to list out all the pickup is “true” addresses and then link the PickupAddresses ID to the item during item creation. 



For Spacetime, location is mandatory during item upload so that the items can be shown in a map. Once the Merchant create an item, a location ID will also be created. Even if items are using the same address, different Address ID will be created.



For authorization, the Consumer, you are only able to read and write your own addresses. Except for Consumer - Get Pickup Method by Item ID, it allows Consumer and Guests to read all Pickup locations for a particular Item, so that one can choose a location for checkout. For Merchant, you are able to read and write yours own and Consumer’s addresses. And for Admin, you are able to read and write all user’s addresses in your marketplace. 

Property Table

Pickup Method Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 8010

Unique identification number of the pick up method/ address.

Active

Optional

boolean

"Active": true

Address status. Value equal to true mean it is available while false mean it is soft delete from the system. Soft delete of the address will mean that address will not be shown available in the marketplace but it still exist in the marketplace database.

Address

Optional

string

"Address": "26 Rosewood St. Malden, MA 02148"

The pick up address.

AddressName

Optional

string

"AddressName": "Tony | Jai"

For Bespoke Marketplace, the address name used for delivery receipt if it is different from the person paying for the item.The address name will shown as “Addressee First Name | Addressee Last Name”.

Line1

Optional

string

"Line1": "26 Rosewood"

Street Address Name - line 1.

Line2

Optional

string

"Line2": "St. Malden, MA"

Street Address Name - line 2.

PostCode

Optional

string

"PostCode": "02148"

Postal code or Zip code of the address.

Latitude

Optional

number

"Latitude": 42.4326041

The latitude coordinate of the address.

Longitude

Optional

number

"Longitude": -71.05571959999997

The longitude coordinate of the address.

CountryCode

Optional

string

"CountryCode": "US"

The address country code based on ISO 3166 alpha-2
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

CountryName

Optional

string

"CountryName": "United States"

The address's country name

StateName

Optional

string

"StateName": "Massachusetts"

The address's state name

Delivery

Optional

boolean

"Delivery": true

The address is use as the delivery address when the value is true else the value should be false

DeliveryDefault

Optional

boolean

"DeliveryDefault": true

We are currently not using this

Pickup

Optional

boolean

"Pickup": true

The address is use as the pickup address when the value is true else the value should be false

DeliveryType

Optional

string

"DeliveryType": "pickup"

The delivery type should be either pickup or delivery

Location Properties

Property Names Property Type Description
Id

Optional

integer "Id": 10912

Unique identification number for the location.
Country

Optional

string

"Country": "United State"


The location country.

Line1

Optional

string

"Line1": "26 Rosewood"


The location line address.

CountryCode

Optional

string

"CountryCode": "US"


The location country code.

City

Optional

string

"City": "St. Malden"


The location city.

Latitude

Optional

number

"Latitude": 42.4326041

The latitude coordinate of the location.

Longitude

Optional

number

"Longitude": -71.05571959999997

The longitude coordinate of the location.

PostCode

Optional

string

"PostCode": "02148"

Postal code or Zip code of the location.

State

Optional

string

"StateName": "MA"

The location state.

Addresses properties

Property Names Property Type Description
Id

Optional

integer "Id": 8010

Unique identification number of the pick up method/ address.

UserId

Optional

integer "UserId": 7201 

The id of the user
Active

Optional

boolean "Active": true

Address status. Value equal to true mean it is available while false mean it is soft delete from the system. Soft delete of the address will mean that address will not be shown available in the marketplace but it still exist in the marketplace database.
Address

Optional

string "Address": "26 Rosewood St. Malden, MA 02148"

The pick up address.
AddressName

Optional

string "AddressName": "Tanoo|Joyekurun"

Name used for delivery receipt if it is different from the person paying for the item. Tanoo is First Name, and Joyekurun is Last Name.

Line1

Optional

string "Line1": "26 Rosewood"

Street Address Name - line 1.
Line2

Optional

string "Line2": "St. Malden, MA"

Street Address Name - line 2.
PostCode

Optional

string "PostCode": "02148"

Postal code or Zip code of the address.
Latitude

Optional

number
"Latitude": 42.4326041

The latitude coordinate of the address.

Longitude

Optional

number "Longitude": -71.05571959999997

The longitude coordinate of the address.
CountryCode

Optional

string "CountryCode": "US"

The address country code based on ISO 3166 alpha-2
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
CountryName

Optional

string "CountryName": "United States"

The address's country name
StateName

Optional

string "StateName": "Massachusetts"

The address's state name
Delivery

Optional

boolean "Delivery": true

The status to use the address as default. True means yes for default address while false means no.
DeliveryDefault

Optional

boolean "DeliveryDefault": true

We are currently not using this
Pickup

Optional

boolean "Pickup": true

True means address is for pickup while false means not
DeliveryType

Optional

string "DeliveryType": "pickup"

The type of delivery method. Delivery or Pickup
FormattedAddress

Optional

string

"FormattedAddress": "1209 Caldwell Road East Rochester NY 14445 US"


The formatted address.

Was this article helpful?
3 out of 3 found this helpful