Marketplace

This is to allow users with different authorization to retrieve specific information about the marketplace.

What do you do with Marketplace?

GET:

POST:

Property Table

Marketplace Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 2489

The id of the marketplace

Name

Optional

string

"Name": "sneakerlabs"

The name of the marketplace

Domain

Optional

string

"Domain": "sneakerlabs.arcadier.io"

The domain name for the marketplace

Logo

Optional

integer

"Logo": 368

The logo id

LogoUrl

Optional

string

"LogoUrl":  "images/2343k-945i495-43r3k2-34j324.png"

The marketplace logo url

SeoTitle

Optional

string

"SeoTitle": "sneakerlabs"

The SEO title for the marketplace

SeoDescription

Optional

string

"SeoDescription": "where sole and feet meet"

The description of the marketplace SEO

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

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the marketplace Amount based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

Homepage

Optional

string

"Homepage": "sneakerlabs"

The homepage of the marketplace

Languages

Optional

array [string]

"Languages": ["en", "zh-CN"]

The list of languages supported in the marketplace

DefaultConsumerLanguageCode

Optional

string

"DefaultConsumerLanguageCode": "en"

The default language for consumer

DefaultMerchantLanguageCode

Optional

string

"DefaultMerchantLanguageCode": "en"

The default language for merchant

IsStripeEnabled

Optional

boolean

"IsStripeEnabled": true

The status if Stripe is enable in the marketplace. Value is true if Stripe is enabled else value is false

IsStripeMandatory

Optional

boolean

"IsStripeMandatory": false

The status of the Stripe payment is mandatory. Value is true if Stripe Payment is mandatory else value is false

IsPayPalEnabled

Optional

boolean

"IsPayPalEnabled": true

The status if PayPal is enable in the marketplace. Value is true if PayPal is enabled else value is false

IsPayPalMandatory

Optional

boolean

"IsPayPalMandatory": false

The status of the PayPal payment is mandatory. Value is true if PayPal Payment is mandatory else value is false

IsOmiseEnabled

Optional

boolean

"IsOmiseEnabled": true

The status if Omise is enable in the marketplace. Value is true if Omise is enabled else value is false

IsOmiseMandatory

Optional

boolean

"IsOmiseMandatory": false

The status of the Omise payment is mandatory. Value is true if Omise Payment is mandatory else value is false

GoogleAnalyticsTrackingId

Optional

string

"GoogleAnalyticsTrackingId":  "UA-12345-12"

The google analytics tracking id of the marketplace

GoogleAnalyticsViewId

Optional

string

"GoogleAnalyticsViewId": "VW-12345-22"

The google analytics view id of the marketplace

Theme

Optional

string

"Theme": "Theme-1"

The marketplace theme type used

MandatoryCustomGatewayDictionary

Optional

Custom Gateway Object

"MandatoryCustomGatewayDictionary": {
  "3302-cash-6ty4z1nk7dfhac15rt1h": false,
  "3302-credit-card-makx3nwfx88csjinzr8q": false,
  "3302-credit-card-o9fopm3j9gykifxa8vgc": false
}


The list of mandatory custom payment gateway that are in the marketplace. The payment gateway is mandatory in the marketplace if the value is true.

CustomDomains

Optional

array [Custom Domain object]

"CustomDomains": [
{
  "Domain": "sneakerlab.com",
  "IsSecure": true,
  "IsDefault": true
}
]

The info of the marketplace custom domain

LinkedOpenIds

Optional

array [OpenIds object]

"LinkedOpenIds": [
{
 "ID": 0,
 "Name": "Google",
  "DisplayName": "Continue with Google",
  "SortOrder": 0
},
{
"ID": 0,
"Name": "Facebook",
"DisplayName": "Continue with Facebook",
"SortOrder": 0
}
]

The list of the linked open ids in the marketplace

AdminUser

Optional

string

"AdminUser": "sneakerHead"

The admin user name for the marketplace

AdminEmail

Optional

string

"AdminEmail": "admin@sneakerlabs.com"

The admin email of the marketplace

Custom Domain Properties

Property Names Property Type Description
Domain

Optional

string

"Domain": "landspacer.com"

The custom domain url address.

IsSecure

Optional

boolean

"IsSecure": true

The custom domain is secure with HTTPS if the value is true else it is false.

IsDefault

Optional

boolean

"IsDefault": true

The custom domain is a default domain when the value is true else it is false.

Linked Open Id Properties

Property Names Property Type Description
ID

Optional

integer

"ID": 10923

The unique ID of the Open Id.

Name

Optional

string

"Name": "JKook"

The name of the Open Id.

DisplayName

Optional

string

"DisplayName": "John Kook"

The display name of the Open Id.

ClientId

Optional

string

"ClientId": "e439jjgjirngkrng49042ngkrng2u9t42gnknjdg02"

The client id of the Open Id.

ClientSecret

Optional

string

"ClientSecret": "fnk204t-42jg204nfgnjfegniKtBmife042ig42jb"

The client secret key of the Open Id.

ReturnUrl

Optional

string

"ReturnUrl": "https://landspacer.com/apitoken"

The return url of the Open Id. Once Oauth is completed, the return url will be the url that Oauth will return to.

Scope

Optional

string

"Scope": "basic"

The scope of Oauth access.The value basic are only for non admin login as admin are only for admin login

SortOrder

Optional

integer

"SortOrder": 1

The order of the Open Id

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