Archive
B2B Edition
V2 API
Salesrep

SalesRep

Get Company Sales Reps

GET /companies/{companyId}/sales-reps
⚠️
This endpoint is deprecated.

Request

Get company sales reps' basic info

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

example

curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v2/io/companies/[companyId]/sales-reps' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

{
"code": 200,
"data": {
"firstName": "kobe",
"id": "74",
"lastName": "tiantian"
},
"message": "Success"
}

Update Company Sales reps

PUT /companies/{companyId}/sales-reps
⚠️
This endpoint is deprecated.

Request

Update company reps

Authentication

  • authToken in header

Parameters

  • companyId in path - string
    required
  • authToken in header - string
    required
    Auth token in header.

Body

object | application/json
Request body

  • salesReps    array[object]

example

{
"salesReps": [
{
"id": "string"
}
]
}

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

{
"code": 200,
"data": {
"companyId": "2"
},
"message": "Success"
}

Get Companies & Sales reps

GET /sales-reps/companies
⚠️
This endpoint is deprecated.

Request

Get all companies and their sales reps, default order by company

Authentication

  • authToken in header

Parameters

  • authToken in header - string
    required
    Auth token in header.
  • offset in query - number
    Pagination offset default: 0
  • limit in query - number
    Pagination limit default: 10
  • groupBy in query - number
    Group by('2' for company, '1' for sales reps)
  • orderBy in query - number
    Order by default DESC choice (DESC ASC)

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/io/sales-reps/companies \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'

Response

Response Success

Body

object | application/json

  • code    number

    Response status code

  • data    object

    Response data

  • message    string

    Response message

example

{
"code": 200,
"data": {
"list": [
{
"addressLine1": "",
"addressLine2": "",
"catalogId": "2",
"city": "",
"companyEmail": "kobe.tian@bunldeb2b.com",
"companyId": "34",
"companyName": "KobeCropTest111",
"country": ",",
"description": "KobeCropTest111",
"salesRepCount": "2",
"state": "",
"zipCode": ""
}
],
"pagination": {
"limit": 10,
"offset": 0,
"totalCount": 1
}
},
"message": "SUCCESS"
}
Did you find what you were looking for?
Third party API proxyGet Company Sales Reps