Portal

Portals are the core resource to any project.

The Portal Object
Attributes
Sample Object
Attributes
Type
Description
id
Integer
Unique Id for a Portal
portalName
String
Display name for a Portal
externalPortalId
String
Unique string identifier for a Portal. Example: FK, AMZ, etc.
isBrandStore
​boolean ​
Flag to identify if it is a website portal or marketplace portal
portalLogoUrl
String
Url path for the logo of Portal
status
boolean 
This flag is used to define a Portal Active or Inactive
fields
​object​
The fields which are linked to this portal
createdAt
String
Creation date and time
updatedAt
String
Updation date and time
       {
            "portalLogoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/logo/flipkart.png",
            "createdAt": "2018-08-28T19:07:44.000Z",
            "portalName": "Flipkart",
            "externalPortalId": "FK",
            "isBrandStore": "0",
            "id": 1,
            "fields": [
                {
                    "portalId": "1",
                    "fieldName": "Panel username",
                    "fieldType": "STRING",
                    "optionValues": "null",
                    "createdAt": "2019-01-09T12:51:15.000Z",
                    "updatedAt": "2019-01-29T14:32:20.000Z",
                    "isRequired": "1",
                    "hint": "Seller panel account login username ([email protected])",
                    "id": "8"
                },
                {
                    "portalId": "1",
                    "fieldName": "Panel password",
                    "fieldType": "PASSWORD",
                    "optionValues": "null",
                    "createdAt": "2019-01-09T12:51:15.000Z",
                    "updatedAt": "2019-01-22T11:52:01.000Z",
                    "isRequired": "1",
                    "hint": "null",
                    "id": "9"
                },
                {
                    "portalId": "1",
                    "fieldName": "Flipkart Application Id",
                    "fieldType": "STRING",
                    "optionValues": "null",
                    "createdAt": "2019-01-09T12:51:15.000Z",
                    "updatedAt": "2019-01-22T11:52:01.000Z",
                    "isRequired": "1",
                    "hint": "null",
                    "id": "10"
                },
                {
                    "portalId": "1",
                    "fieldName": "Flipkart location Id",
                    "fieldType": "STRING",
                    "optionValues": "null",
                    "createdAt": "2019-01-09T12:51:15.000Z",
                    "updatedAt": "2019-01-22T11:52:01.000Z",
                    "isRequired": "1",
                    "hint": "null",
                    "id": "11"
                },
                {
                    "portalId": "1",
                    "fieldName": "Flipkart Application Secret",
                    "fieldType": "STRING",
                    "optionValues": "null",
                    "createdAt": "2019-01-09T12:51:15.000Z",
                    "updatedAt": "2019-01-22T11:52:01.000Z",
                    "isRequired": "1",
                    "hint": "null",
                    "id": "12"
                }
            ],
            "updatedAt": "2019-05-31T14:47:27.000Z",
            "status": "1"
        
        }
The Fields Object
Fields
​
Description
id
Integer
Unique auto-increment id for a field
portalId
Integer
The portal for which the field has been created
fieldName
String
Name of the field 
fieldType
String
The Type of the field viz.STRING ,NUMBER ,PASSWORD ,OPTIONS
optionValues
String
The allowed values of the field if the type is options
isRequired
boolean 
Flag to maintain the mandatory check in the field
hint
String
The hint as an additional information if the type is Password
createdAt
String
Created at date and time
updatedAt
String
Updated at Date and time
The  Is Brand Store Object
Is Brand Store Value
Description
1
The defined portal is a brand store/website
0
The defined portal is a marketplace

Filtering

Get All Portals

Last modified 3yr ago

Portal

The `Portal` Object

The `Fields` Object

The `Is Brand Store` Object

Attributes	Type	Description
`id`	Integer	Unique Id for a Portal
`portalName`	String	Display name for a Portal
`externalPortalId`	String	Unique string identifier for a Portal. Example: FK, AMZ, etc.
`isBrandStore`	boolean	Flag to identify if it is a website portal or marketplace portal
`portalLogoUrl`	String	Url path for the logo of Portal
`status`	boolean	This flag is used to define a Portal Active or Inactive
`fields`	object	The fields which are linked to this portal
`createdAt`	String	Creation date and time
`updatedAt`	String	Updation date and time

Fields		Description
`id`	Integer	Unique auto-increment id for a field
`portalId`	Integer	The portal for which the field has been created
`fieldName`	String	Name of the field
`fieldType`	String	The Type of the field viz.`STRING` ,`NUMBER` ,`PASSWORD` ,`OPTIONS`
`optionValues`	String	The allowed values of the field if the type is options
`isRequired`	boolean	Flag to maintain the mandatory check in the field
`hint`	String	The hint as an additional information if the type is Password
`createdAt`	String	Created at date and time
`updatedAt`	String	Updated at Date and time

Is Brand Store Value	Description
1	The defined portal is a brand store/website
0	The defined portal is a marketplace