Server to Server Management APIs
Sales Staff

Sales Staff

Sales staff management

Get Sales Staffs

GET /sales-staffs

Request

Get all sales staffs with pagination

Authentication

  • authToken in header

Parameters

  • limit in query with default of 10 - integer
    Pagination limit
    Example: 15
  • offset in query - integer
    Pagination offset
    Example: 5
  • orderBy in query with default of DESC - string
    Order by
    Example: ASC

    Allowed: DESC | ASC

  • companyId in query - string
    Unique ID of company
  • minModified in query - integer
    Minimum modified or assigned timestamp
  • sortBy in query with default of updated_at - string
    Sort by
    Example: 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
  • data
    array[object]

  • meta
    object

    Used to response pagination information
    Example: {"pagination":{"limit":10,"offset":0,"totalCount":1}}
  • code
    integer

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 /sales-staffs/{salesStaffId}

Request

Update a sales staff for company assignment

Authentication

  • authToken in header

Parameters

  • salesStaffId in path - integer
    required
    Sales staff ID

Body

array | application/json
  • companyId
    integer
    required

  • assignStatus
    boolean
    required

example

[
{
"companyId": 0,
"assignStatus": true
}
]

Response

OK

Body

object | application/json
  • code
    integer
    required

  • data
    object
    required

  • meta
    object
    required

example-1

{
"code": 200,
"data": {},
"meta": {
"message": "SUCCESS"
}
}

Get a Sales Staff

GET /sales-staffs/{salesStaffId}

Request

Get sales staff detail information, include which companies are assigned.

Authentication

  • authToken in header

Parameters

  • salesStaffId in path - integer
    required
    Sales 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
  • data
    object

  • code
    integer

    Response code of success request.
    Example: 200
  • meta
    object

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?