Sales Staff
Sales staff management
Get Sales Staffs
GET https://api-b2b.bigcommerce.com/api/v3/io/sales-staffsRequest
Get all sales staffs with pagination
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
- companyId in query - stringUnique ID of company
- minModified in query - integerMinimum modified or assigned timestamp
- sortBy in query with default of updated_at - stringSort byExample: updated_at
Allowed: updated_at | email
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
dataarray[object]
codeinteger
Arthur Morgan assigned to the Van der Linde Gang
{
"data": [
{
"id": 19,
"salesRepName": "Arthur Morgan",
"email": "Arthur.Morgan@rstar.com",
"companyCount": 1,
"roleName": "Sales Rep"
}
],
"meta": {
"message": "Success",
"pagination": {
"totalCount": 1,
"limit": 10,
"offset": 0
}
}
}
Update a Sales Staff
PUT https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs/{salesStaffId}Request
Update a sales staff for company assignment
Authentication
- authToken in header
Parameters
- salesStaffId in path - integerrequiredSales staff ID
Body
array | application/json
companyIdinteger
requiredassignStatusboolean
required
example
[
{
"companyId": 0,
"assignStatus": true
}
]
Response
OK
Body
object | application/json
codeinteger
requireddataobject
required
example-1
{
"code": 200,
"data": {},
"meta": {
"message": "SUCCESS"
}
}
Get a Sales Staff
GET https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs/{salesStaffId}Request
Get sales staff detail information, include which companies are assigned.
Authentication
- authToken in header
Parameters
- salesStaffId in path - integerrequiredSales staff ID
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs/[salesStaffId]' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
dataobject
codeinteger
Response code of success request.Example: 200
example-1
{
"data": {
"id": 12,
"name": "tom",
"email": "user@example.com",
"phoneNumber": "123454321",
"assignedCompanies": [
{
"id": 1,
"bcId": "23",
"companyName": "google",
"bcGroupName": "google"
}
]
},
"code": 200,
"meta": {
"message": "SUCCESS"
}
}
See something you can improve? Edit this file on GitHub
Did you find what you were looking for?