API reference · Customers · Customer Groups

List Customer Groups

Method: GET
Route: /customer/group/byGroup
Base URL: https://ws.autorei.net
Token: Requires Bearer token

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

Description

Queries your store's customer groups by name or by external id.

Request Body (JSON)

Field	Type	Required	Description
Search criteria	—	Yes	It is not a field — it is a group. Send `name` or `externalId`.
`name`	array	Conditional	Group names.
`externalId`	array	Conditional	Group external ids.

Business rules

The criteria are always arrays

name and externalId must be arrays, even for a single value: {"name": ["Atacado"]}. A scalar value is rejected.

Response · 200

Object with the groups key — an array with one object per group found. With no match, you get {"groups": []}.

Field	Type	Description
`internalId`	integer	Group internal id. It is what deletion asks for.
`name`	string	Group name.
`externalId`	string	Group external id. `null` when not provided.
`groupTypeId` · `groupTypeName`	string	Linked group type. `null` when there is none.
`details.showToSeller`	boolean	Whether the group is shown to the sales rep.
`details.enableGroupDisplayInRegistration`	boolean	Whether the group appears in registration.
`details.enableGroupDisplayInMyAccount`	boolean	Whether the group appears in the customer's account.
`details.applicationGroupDocumentType`	string	Document type the group applies to: `all`, `pj`, `iepr` or `pf`.
`details.restrictionDeliveryType`	string	Delivery restriction: `no_restriction`, `restrict_all_except_pickup_in_store`, `restrict_all_except_carrier` or `restrict_all_except_deliveries`.
`details.restrictionPaymentType`	string	Payment restriction: `no_restriction`, `restrict_online_payment` or `restrict_offline_payment`.

The three details fields return the same key you sent on group creation.

Errors

Code	When
400	No criteria provided, a scalar criterion instead of an array, or all arrays empty. The reason comes in the message.
401	Token missing, malformed or expired.

Example request

curl --request GET 'https://ws.autorei.net/customer/group/byGroup' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": [
    "Atacado Sudeste"
  ]
}'

Example responses

200Success — one group found

{
  "groups": [
    {
      "internalId": 4470801,
      "name": "Atacado Sudeste",
      "externalId": "GRP-ATC-SE",
      "groupTypeId": null,
      "groupTypeName": null,
      "details": {
        "showToSeller": true,
        "enableGroupDisplayInRegistration": true,
        "enableGroupDisplayInMyAccount": false,
        "applicationGroupDocumentType": "pj",
        "restrictionDeliveryType": "no_restriction",
        "restrictionPaymentType": "restrict_offline_payment"
      }
    }
  ]
}

Used in

Use casesComplex retail and B2B2C: the typical path through the API

POST Create Customer Group /customer/group
DELETE Delete Customer Group /customer/group
PUT Link Customer to a Group /customer/:document/priceType/:customerGroupId
DELETE Unlink Customer from a Group /customer/:document/priceType/:customerGroupId

← See the group: Customers

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