Super Admin
Super Admin manage.
Get a Company SuperAdmins
GET https://api-b2b.bigcommerce.com/api/v3/io/companies/{companyId}/super-adminsRequest
Get a Company's all SuperAdmins
Authentication
- authToken in header
Parameters
- companyId in path - integerrequiredUnique ID of a company objectExample: 14
- limit in query with default of 10 - integerPagination limitExample: 15
- offset in query - integerPagination offsetExample: 5
- q in query - stringSuper admin query string. Supported fields: email, e.g., ?q=xyz@abc.com
- isIncludeExtraFields in query - stringIs show extra fields in the response
Allowed: 0 | 1
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/companies/[companyId]/super-admins' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataarray[object]
required
example-1
{
"code": 0,
"data": [
{
"id": 0,
"createdAt": 0,
"updateAt": 0,
"firstName": "string",
"lastName": "string",
"email": "string"
}
],
"meta": {
"message": "string",
"pagination": {
"limit": 2,
"offset": 0,
"totalCount": 0
}
}
}
Update Company & Super Admins Relationship
PUT https://api-b2b.bigcommerce.com/api/v3/io/companies/{companyId}/super-adminsRequest
Create or delete the super admin relationships of a company.
Authentication
- authToken in header
Parameters
- companyId in path - integerrequiredUnique ID of a company objectExample: 14
Body
object | application/json
superAdminsarray[object]
required
example-1
{
"superAdmins": [
{
"superAdminId": 1,
"isAssigned": true
},
{
"superAdminId": 2,
"isAssigned": true
}
]
}
Response
OK
Body
object | application/json
codenumber
dataarray[]
example-1
{
"code": 200,
"data": [],
"meta": {
"message": "success"
}
}
Update SuperAdmin & Companies Relationship
PUT https://api-b2b.bigcommerce.com/api/v3/io/super-admins/{superAdminId}Request
Create or delete the company relationships of a superAdmin.
Authentication
- authToken in header
Parameters
- superAdminId in path - integerrequiredUnique SuperAdmin IDExample: 11
Body
object | application/json
companiesarray[object]
required
example-1
{
"companies": [
{
"companyId": 1,
"isAssigned": true
},
{
"companyId": 2,
"isAssigned": false
}
]
}
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"data": {},
"meta": {
"message": "SUCCESS"
}
}
Get SuperAdmin with Company Count
GET https://api-b2b.bigcommerce.com/api/v3/io/companies/super-adminsRequest
Get SuperAdmins with Company Count (group by superAdmin)
Authentication
- authToken in header
Parameters
- limit in query with default of 10 - integerPagination limitExample: 15
- offset in query - integerPagination offsetExample: 5
- orderBy in query with default of DESC - stringOrder byExample: ASC
Allowed: DESC | ASC
- q in query - stringSuper admin query string. Supported fields: email, e.g., ?q=xyz@abc.com
- uuid in query - stringUuid of super admin
- maxCreated in query - stringMaximum created timestamp
- minCreated in query - stringMinimum created timestamp
- maxModified in query - stringMaximum modified timestamp
- minModified in query - stringMinimum modified timestamp
- isIncludeExtraFields in query - stringIs show extra fields in the response
Allowed: 0 | 1
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/companies/super-admins \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataarray[object]
required
example-1
{
"code": 200,
"data": [
{
"firstName": "zzz",
"lastName": "aaa",
"email": "zzz@ssalesrep.com",
"id": 9208,
"companyCount": 7,
"uuid": "",
"createdAt": 1622421600,
"updatedAt": 1622421600
},
{
"firstName": "Walter",
"lastName": "White",
"email": "Walter.White@gmail.com",
"id": 293,
"companyCount": 3,
"uuid": "",
"createdAt": 1622421600,
"updatedAt": 1622421600
}
],
"meta": {
"message": "SUCCESS",
"pagination": {
"limit": 2,
"offset": 0,
Get Companies with SuperAdmin Count
GET https://api-b2b.bigcommerce.com/api/v3/io/super-admins/companiesRequest
Get Companies with SuperAdmin Count (group by company)
Authentication
- authToken in header
Parameters
- limit in query with default of 10 - integerPagination limitExample: 15
- offset in query - integerPagination offsetExample: 5
- orderBy in query with default of DESC - stringOrder byExample: ASC
Allowed: DESC | ASC
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/super-admins/companies \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataarray[object]
required
example-1
{
"code": 200,
"data": [
{
"addressLine1": "",
"addressLine2": "",
"catalogId": 2,
"city": "",
"companyEmail": "kobe.tian@bunldeb2b.com",
"companyId": 34,
"companyName": "KobeCropTest111",
"country": ",",
"description": "KobeCropTest111",
"superAdminCount": 2,
"state": "",
"zipCode": ""
}
],
"meta": {
"message": "SUCCESS",
"pagination": {
"limit": 3,
"offset": 1,
"totalCount": 989
}
}
}
Create Super Admin
POST https://api-b2b.bigcommerce.com/api/v3/io/super-adminsRequest
Create a super admin without a company assigned.
Authentication
- authToken in header
Body
object | application/json
Extra Field Values
firstNamestring
requiredFirst name of the SuperAdmin>= 0 characters<= 100 characterslastNamestring
requiredLast name of the SuperAdmin>= 0 characters<= 100 charactersphonestring
Phone number of the SuperAdmin>= 0 characters<= 200 charactersemailstring
requiredEmail of the SuperAdmin>= 0 characters<= 200 charactersuuidstring
UUID of the SuperAdmin>= 0 characters<= 100 characterschannelIdsarray[integer]
BigCommerce channel ID list. If this fields is missing, super admin can access all enabled channels.originChannelIdinteger
BigCommerce channel ID, used for BigCommerce customer origin channel ID. This field takes effect only when the store default b2b channel is not configuredextraFieldsarray[object]
example-1
{
"firstName": "Tom",
"lastName": "Cat",
"phone": "0000000000",
"email": "Tom@gmail.com",
"uuid": ""
}
Response
OK
Body
object | application/json
codenumber
dataobject
example-1
{
"code": 0,
"data": {
"userId": 1,
"customerId": 1
},
"meta": {
"message": "success"
}
}
Get Companies of a Super Admin
GET https://api-b2b.bigcommerce.com/api/v3/io/super-admins/{superAdminId}/companiesRequest
Get companies of a super admin
Authentication
- authToken in header
Parameters
- superAdminId in path - stringrequiredUnique SuperAdmin IDExample: 11
- offset in query - integerPagination offset
- limit in query - integerPagination limit
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/super-admins/[superAdminId]/companies' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
dataarray[object]
required
example-1
{
"code": 0,
"data": [
{
"companyId": 1,
"companyName": "Tom company",
"companyEmail": "Tom@gmail.com"
},
{
"companyId": 1,
"companyName": "Jerry company",
"companyEmail": "Jerry@gmail.com"
}
],
"meta": {
"message": "success",
"pagination": {
"totalCount": 2,
"offset": 0,
"limit": 10
}
}
}
Bulk Create Super Admins
POST https://api-b2b.bigcommerce.com/api/v3/io/super-admins/bulkRequest
Bulk create super admins
Authentication
- authToken in header
Body
array | application/json
firstNamestring
requiredFirst name of the super admin>= 1 characterslastNamestring
requiredLast name of the super admin>= 1 charactersphonestring
requiredPhone number of the super admin>= 1 charactersemailstring
requiredEmail of the super admin>= 1 charactersuuidstring
requiredUUID of the super admin>= 1 characterschannelIdsarray[integer]
BigCommerce channel ID listoriginChannelIdinteger
BigCommerce channel ID, used for BigCommerce customer origin channel ID. This field takes effect only when the store default b2b channel is not configured.extraFieldsarray[object]
example-1
[
{
"firstName": "Tom",
"lastName": "Cat",
"phone": "1000000000",
"email": "Tom21@gmail.com",
"uuid": "21"
},
{
"firstName": "Tom",
"lastName": "Cat",
"phone": "2000000000",
"email": "Tom22@gmail.com",
"uuid": "22"
},
{
"firstName": "Tom",
"lastName": "Cat",
"phone": "3000000000",
"email": "Tom23@gmail.com",
"uuid": "23"
}
]
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"data": {
"superAdminIds": [
51,
52,
53
]
},
"meta": {
"message": "SUCCESS"
}
}
Get a Super Admin Info
GET https://api-b2b.bigcommerce.com/api/v3/io/super-admins/info/{superAdminId}Request
Get super admin info
Authentication
- authToken in header
Parameters
- superAdminId in path - stringrequiredUnique SuperAdmin ID
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/super-admins/info/[superAdminId]' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codeinteger
dataobject
Super Admin modelExample: {"extraFields":[{"fieldName":"string","fieldValue":"string"}]}
example
{
"code": 0,
"data": {
"id": 0,
"createdAt": 1620872672,
"updatedAt": 1620872672,
"firstName": "Tom",
"lastName": "Cat",
"uuid": "string",
"phone": "string",
"channelList": [
{
"channelId": 0,
"channelName": "string",
"iconUrl": "string"
}
],
"extraFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
]
},
"meta": {
"message": "string"
}
}
Update a Super Admin Info
PUT https://api-b2b.bigcommerce.com/api/v3/io/super-admins/info/{superAdminId}Request
Update super admin info
Authentication
- authToken in header
Parameters
- superAdminId in path - stringrequiredUnique SuperAdmin ID
Body
object | application/json
Extra Field Values
firstNamestring
First namelastNamestring
Last nameuuidstring
UUID of super adminphonestring
Phone number of super adminchannelIdsarray[integer]
BigCommerce channel IDs.extraFieldsarray[object]
example
{
"firstName": "Tom",
"lastName": "Cat",
"uuid": "string",
"phone": "string",
"channelIds": [
0
],
"extraFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
]
}
Response
OK
Body
object | application/json
codeinteger
dataobject
Super Admin modelExample: {"extraFields":[{"fieldName":"string","fieldValue":"string"}]}
example
{
"code": 0,
"data": {
"id": 0,
"createdAt": 1620872672,
"updatedAt": 1620872672,
"firstName": "Tom",
"lastName": "Cat",
"uuid": "string",
"phone": "string",
"channelList": [
{
"channelId": 0,
"channelName": "string",
"iconUrl": "string"
}
],
"extraFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
]
},
"meta": {
"message": "string"
}
}
See something you can improve? Edit this file on GitHub
Did you find what you were looking for?