Accounts



In this section, we are going to control and edit the user accounts in Arcadier. For onboarding of accounts or account creation, please refer to the authorization section. In Arcadier, everyone is a user account, and Consumer, Merchant and Admin are user accounts with a role attached to it. By default, a newly created user will given the Consumer role. To become a Merchant, you need to convert the Consumer role to a Merchant one.

For authorization, the Consumer, you are only able to read and write your own user account. For Merchant, you are able to read and write yours own and Consumer’s user account. And for Admin, you are able to read and write all user accounts in your marketplace.


Time Zone is more relevant for the Spacetime template. In Arcadier’s database, we are using Coordinated Universal Time (UTC) as the standard time for item scheduling. For Merchants in the Spacetime template, the Merchant’s time zone will determine the timing of their services in the marketplace. This will be helpful For example, a Merchant has indicated using Singapore time (GMT+8) in his settings page, all bookings made by the Consumer will be in the Singapore time zone, regardless of the Consumer’s time zone.

Property Table

User Account Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 7201

The id of the user account

UserId

Optional

integer

"UserId": 7201

The id of the user

UserName

Optional

string

"UserName": "mJordan12"

The user name of the account

FirstName

Optional

string

"UserName": "mJordan12"

The first name of the account

LastName

Optional

string

"LastName": "Jordan"

The last name of user account

DisplayName

Optional

string

"DisplayName": "M. Jordan"

The display name of user account

Role

Optional

string

"Role": "User"

The role of the use. The following are the role that exist in the system:
1 = Master Admin (internal use only)
2 = Admin(Marketplace Admin)
3 = User(Consumer)
4 = Merchant

Onboarded

Optional

boolean

"Onboarded":  true

The status of the user account onboarding. Value will be true if user have completed on boarding while false if it is in progress.

DateJoined

Optional

string

"DateJoined": "2018-02-01T00:00:00Z"

The user joined date

Visible

Optional

boolean

"Visible": true

The user account is soft deleted if value is false else it is visible in the marketplace.Soft deleted will mean that the user account will not be visible in the marketplace but still exist in the marketplace database

PhoneNumber

Optional

string

"PhoneNumber": "321-517-9039"

The contact number of user account

Email

Optional

string

"Email": "jordan@gmail.com"

The emai notificationl of the user account

AddressName

Optional

string

"AddressName": "Tony | Jai"

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

Line1

Optional

string

"Line1": "26 Rosewood"

Street Address Name.

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

Country

Optional

string

"Country": "United State"

The country address

City

Optional

string

"City": "Valparaiso"

The city address

State

Optional

string

"State": "Florida"

The state address

Delivery

Optional

boolean

"Delivery": true

The address use as delivery default

DeliveryDefault

Optional

boolean

"DeliveryDefault": true

The address use as delivery default

Pickup

Optional

boolean

"Pickup": false

If address is use for pickup, value is true else is false

TimeZoneId

Optional

integer

"TimeZoneId":  1

The time zone id. Please refer to the following api to get more info on the id to be use for the timezone:

GET api/account/timezone-list-detail

Images

Optional

array[string]

"Images": ["50a7ccb7-ac05-4b9c-9dff-5f8456e2fcc8.jpg", "412321nkfnjewbeb9314u3.jpg"]


The list of image of the user account

Images

Optional

array[Image Object]

"Images": [
{
  "FileId": "7890",
  "Image": "50a7ccb7-ac05-4b9c-9dff-5f8456e2fcc8.jpg", "412321nkfnjewbeb9314u3.jpg"
}
]

The list of item image object.

PaymentAcceptanceMethods

Optional

Array[PaymentAcceptance Object]

"PaymentAcceptanceMethods": [
   {
  "GatewayId": "stripe",
  "GatewayName": "Stripe",
  "GatewayDescription": "Stripe",
  "GatewayLogo": "https://stripe.com/img/about/logos/logos/blue@2x.png",
  "AccountId": "acct_2AwetiloJlmb",
  "AccountEmail": "ben@gmail.com"
}
]


The list of payment method that is accepted by the merchant

TimeZone

Optional

TimeZone Object

"TimeZone": {
  "ID": 1,
  "Description": "(GMT-12:00) International Date Line West",
  "GmtAdjustment": "GMT-12:00",
  "UseDayLightTime": false,
   "Value": -12
}

The timezone for the account

CustomFields

Optional

Array[CustomField Object]

"CustomFields": [
{
 "Name": "Gender",
 "Code": "7600-Gender-fks9nk",
 "Value": "Male",
 "DataFieldType": "String",
 "DataInputType": "dropdown",
 "Values": [ "Male" ],
 "LanguageCode": "en",
 "ListItems": [
   {
     "Id": 2344,
    "Value": "Male"
    },
    {
     "Id": 2345,
    "Value": "Female"
    }
  ]
}
]

A list of Custom fields that is related to the user account

OpenIdProvider

Optional

string

"OpenIdProvider": "Arcadier-sneakerland.arcadier.io"

The provider of the open id.

Address

Optional

Address object

"Address":  {
 "Line1": "26 Rosewood",
 "Line2": "St. Malden, MA",
 "City": "Valparaiso",
"State": "Florida",
"PostCode": "02148",
"CountryCode": "US",
"FormattedAddress": "26 Rosewood St. Malden, MA Valparaiso Florida 02148 US"
}


The address information

Custom Fields Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 9286

The id of the custom field

ReferenceId

Optional

integer

"ReferenceId":  7781

The reference id of the custom field. If custom field is use for Items, the reference id is ItemId.

Name

Optional

string

"Name": "Gender"

The name of the custom field

Code

Optional

string

"Code": "7600-Gender-fks9nk"

The unique code of the custom field

Value

Optional

string

"Value": "Male"

The custom field value for non checkbox and dropdown input type

Values

Optional

array[string]

"Value": "Male"

The custom field value for non checkbox and dropdown input type

DataFieldType

Optional

string

"DataFieldType": "String"

The data type of the custom field. These are the following value in DataFieldType:

  • "String":For Email, Location, Hyperlink, Text Field

  • "DateTime":Date and Time

  • "Date":Date Only

  • "Int":Int Number

  • "Decimal":For Decimal Number and Percentage

DataInputType

Optional

string

"DataInputType": "dropdown"


The data input type of the custom field. These are the following value in DataInputType:

  • "textfield":display="Text Field"

  • "hyperlink":display="Hyperlink / URL"

  • "email":display="Email"

  • "location":display="Location"

  • "percentage":display="Percentage"

  • "number":display="Number"

  • "checkbox":display="Checkbox"

  • "dropdown":display="Drop Down"

  • "datetime":display="Date / Time picker"

LanguageCode

Optional

string

"LanguageCode": "en"

The language code use for translation of the custom field

ReferenceTable

Optional

String

"ReferenceTable": "Items"

The reference table for the custom field. Possible values are the following:

  • Users

  • Categories

  • Orders

  • Payments

  • CartItems

  • Panels

  • PanelDetails

  • DeveloperPackages

  • Implementations

  • Items

Options

Optional

array[Option Object]

"Options":  [
   {
     "ID": 2344,
    "OptionValue": "Male"
    },
    {
     "ID": 2345,
    "OptionValue": "Female"
    }
]

The custom field options/list of checkbox and dropdown input type

ListItems

Optional

array[ListItem Object]

"ListItems": [
   {
     "Id": 2344,
    "Value": "Male"
    },
    {
     "Id": 2345,
    "Value": "Female"
    }
]

The list of items that are for checkbox or dropdown input type

MinValue

Optional

number

"MinValue": 0

The minimum value of the custom field if data field type is integer or decimal. If data field type is not integer or decimal value is set to 0

MaxValue

Optional

number

"MaxValue": 0

The maximum value of the custom field if data field type is integer or decimal. If data field type is not integer or decimal value is set to 0

IsMandatory

Optional

boolean

"IsMandatory":  false

If custom field is mandatory, the value will be true else it is false

IsDecimal

Optional

boolean

"IsDecimal": false

If custom field data field type is decimal then value is true else it is false

DateOnly

Optional

boolean

"DateOnly": false

If custom field data field type is date then value is true else it is false

PropertyLinks

Optional

array[PropertyLinks object]

"PropertyLinks": [
  {
     "ID":  4113,
     "PropertyID": 9286,
     "CategoryID": 4581,
     "Active": true
  },
  {
     "ID":  4114,
     "PropertyID": 9286,
     "CategoryID": 4580,
     "Active": true
  },
]

List of Item Custom Fields that applicable for specific marketplace categories. If value is null or empty, the custom field will be applied to all categories.

TimeZone Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 1

The id of the time zone. Time zone is a region of the globe that observes a uniform standard time.

Description

Optional

string

"Description": "(GMT-12:00) International Date Line West"

The description of the timezone

GmtAdjustment

Optional

string

"GmtAdjustment": "GMT-12:00"

The Greenwich Mean Time offset for the time zone

UseDayLightTime

Optional

boolean

"UseDayLightTime": false

If timezone use daylight saving, value will be true else false

Value

Optional

number

"Value": -12

The Greenwich Mean Time numeric offset value for the time zone

Images Properties

Property Names Property Type Description
FileId

Optional

integer

"FileId": 4590

Unique identification number for the image file.

Image

Optional

string

"Image": "images/items/items-7781-epicreact.jpg"

The URL for the image

Payment Method Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 137

The id of payment method type

Name

Optional

string

"Name": "7213-stripe--8ec9b713-7c87-4d00-87ce-f3b78e820b40-as3t1kq9wkqn8dhdbgzo"

The unique name of the payment method

GatewayId

Optional

string

"GatewayId": "stripe"

Unique number of the payment gateway.

GatewayName

Optional

string

"GatewayName":  "Stripe"

The name of the payment gateway.

GatewayDescription

Optional

string

"GatewayDescription": "New standard in online payment"

The gateway description

GatewayLogo

Optional

string

"GatewayLogo": "https://stripe.com/img/about/logos/logos/blue@2x.png"

The gateway logo

AccountId

Optional

string

"AccountId": "acct_2T0mjR350mF"

The account id of the gateway

AccountEmail

Optional

string

"AccountEmail": "johnwick@gmail.com"

The email for the related gateway account.

Base64

Optional

string

"Base64": "https://stripe.com/img/about/logos/logos/blue@2x.png"

The payment logo

PaymentName

Optional

string

"PaymentName": "Stripe"

The payment name

PaymentType

Optional

string

"PaymentType": "mastercard in stripe"

The type of payment method

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?
0 out of 0 found this helpful