Skip to content
platform
EN PT

API reference · Sales Rep Module

List Sales Reps

Method
GET
Route
/sellerModule/listSellers
Base URL
https://ws.autorei.net
Query parameters in the example
limit=20 offset=0
Token
Requires Bearer token
Test in Postman

Opens this request in the public API documentation, the official source of the reference.

Description

Lists the sales reps of your store, with the permissions of each one. This is where you find the sales rep id, which the other routes of the module ask for.

Query Parameters

Parameter Type Required Description
limit integer No Sales reps per page. Default 20, no ceiling.
offset integer No First sales rep of the page. Default 0.
email string No Partial search by login e-mail, case-insensitive.

Response · 200

Array with one object per sales rep. Comes back [] when there is no sales rep, or when the offset goes past the last one.

Field Type Description
id uuid Sales rep id. It is a UUID, not an integer — it is the value the other routes of the module ask for in the path.
username string Sales rep login e-mail.
document string Sales rep CPF or CNPJ.
restrictedCustomers boolean Whether the sales rep serves only their own customer portfolio.
enabledFreight boolean Whether they can change the freight.
enabledInsertFreight boolean Whether they can insert freight.
enabledCustomerRegistration boolean Whether they can register a customer.
enableDiscountItemValue boolean Whether they can give a discount on the item value.
enableAddItemValue boolean Whether they can add value to the item.
enableDiscountBranch boolean Whether they can use the branch discount.
enableDiscountFranchise boolean Whether they can use the franchise discount. Only comes back true when enableDiscountBranch is also true.
enableDiscountSeller boolean Whether they can use their own discount.
enableCoupon boolean Whether they can apply a coupon.
enableChatSupport boolean Whether they serve customers through chat.
enableRestrictedCustomers boolean Restricted customer portfolio attribute, stored on the sales rep.
enableRestrictedGroupsAttendant boolean Whether they serve only restricted customer groups.
attendantCode string Sales rep code in your system. Comes back "" when not provided.
allowedSellersId array Ids of the sales reps this sales rep can look up. Comes back [] when there are none.
profile object Sales rep profile (id, code, name). Comes back null when there is no profile.
createdAt · updatedAt string Creation and last change, in UTC.

Errors

Code When
401 Token missing, malformed or expired.

Example request

curl --request GET 'https://ws.autorei.net/sellerModule/listSellers?limit=20&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — a store sales rep

[
  {
    "id": "7c3f1a8e-4b62-4d05-9e17-5a2c8d3f6b04",
    "username": "vendedor@lojaexemplo.com.br",
    "document": "528.871.928-41",
    "restrictedCustomers": true,
    "enabledFreight": false,
    "enabledInsertFreight": false,
    "enabledCustomerRegistration": false,
    "enableDiscountItemValue": true,
    "enableAddItemValue": false,
    "enableDiscountBranch": true,
    "enableDiscountFranchise": false,
    "enableDiscountSeller": false,
    "enableCoupon": true,
    "enableChatSupport": false,
    "createdAt": "2026-09-01T13:42:07.512034Z",
    "updatedAt": "2026-09-01T13:42:07.512034Z",
    "attendantCode": "VEND-001",
    "enableRestrictedCustomers": true,
    "enableRestrictedGroupsAttendant": false,
    "allowedSellersId": [],
    "profile": null
  }
]

Used in

Related endpoints

← See the group: Sales Rep Module

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.