Customer Groups

Customer groups can be accessed through the API via the customer_groups base URL:

$ curl https://app.handshake-app.com/api/v2/customer_groups

• Supported list methods: GET
• Supported detail methods: GET

We currently do not have write-support for customer groups via the API, assuming that most users will set these up manually.

If you have a particular need for POST or PUT support for customer groups, please write to us and let us know!

Fields

customerGroup.name (string)

The full user-visible name of this customer group.

customerGroup.id (string)

The ID of this customer group, which is typically only ever used in bulk imports and exports.

customerGroup.currency (string)

The three-letter currency code (e.g. "USD", "GBP" etc) that applies to this customer group.

Example

{
    "cdate": "2011-01-18", 
    "ctime": "2011-01-18T12:52:03Z", 
    "currencyCode": "USD", 
    "entityType": "CustomerGroup", 
    "id": "US", 
    "isDefault": true, 
    "mtime": "2011-01-31T12:04:19Z", 
    "name": "US Retailers", 
    "objID": 946, 
    "owner": "system", 
    "resource_uri": "/api/v2/customer_groups/946", 
    "uuid": "3e605828-9721-4c5a-8e80-68551a364ac0"
}