Sitecore API catalog/OrderCloud/Buyer groups

Buyer groups

Buyer groups streamline buyer management in your marketplace. By assigning similar buyers to groups, you can define shared pricing and catalog access and manage changes more easily than accounting for individual buyers.

Operations

List buyer groups

Request

Security
OAuth2(Required scopes: FullAccessBuyerAdminBuyerReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name""Description"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"Name""ID""!Name""!ID"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/buyergroups?search=string&searchOn=ID&sortBy=Name&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(BuyerGroup)
Example:
[
  {
    "ID": "",
    "Name": "",
    "Description": "",
    "DefaultCatalogID": "",
    "xp": {}
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}