Create a customer group

Create a customer group for customer specific pricing.

POST/api/v1/{team_slug}/{app_slug}/customer-groups
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/customer-groups

Create a customer group for customer specific pricing.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/customer-groups
  • Summary: Create a customer group
  • Description: Create a customer group for customer specific pricing.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: customer group details
  • Content: application/json (object)

Input Customer Group

PropertyTypeRequiredDetails
discount_percentageintegerNo-
discount_percentage_decimalsintegerNo-
namestringYes-
slugstringYes-
store_group_idstringYes-
typestringYes-

Generated example (synthetic):

{
  "discount_percentage": 0,
  "discount_percentage_decimals": 0,
  "name": "string",
  "slug": "string",
  "store_group_id": "string",
  "type": "string"
}
Responses5 statuses
StatusDescriptionContent
200customer group created successfullyapplication/json (object)
400Invalid request (e.g. bad payload, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
409Conflict (e.g. already exists)application/json (object)
500Internal server errorapplication/json (object)

200 - object

Customer Group Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Customer Group
PropertyTypeRequiredDetails
app_idstringNo-
created_atstringNo-
discount_percentageintegerNo-
discount_percentage_decimalsintegerNo-
idstringNo-
namestringNo-
slugstringNo-
store_group_idstringNo-
typestringNo-
updated_atstringNo-

Generated example (synthetic):

{
  "data": {
    "app_id": "string",
    "created_at": "string",
    "discount_percentage": 0,
    "discount_percentage_decimals": 0,
    "id": "string",
    "name": "string",
    "slug": "string",
    "store_group_id": "string",
    "type": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

409 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/customer-groups
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: CustomerGroups
  • OpenAPI summary: Create a customer group

Create a customer group

# Create a customer group Create a customer group for customer specific pricing.
POST /api/v1/{team_slug}/{app_slug}/customer-groups
Purpose

Create a customer group for customer specific pricing.

Required inputs

app_slug path team_slug path

Primary response

200 ยท customer group created successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/customer-groups

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/customer-groups` - Summary: Create a customer group - Description: Create a customer group for customer specific pricing. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/customer-groups` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: customer group details - Content: application/json (object) ### Input Customer Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `discount_percentage` | integer | No | - | | `discount_percentage_decimals` | integer | No | - | | `name` | string | Yes | - | | `slug` | string | Yes | - | | `store_group_id` | string | Yes | - | | `type` | string | Yes | - | **Generated example (synthetic):** ```json { "discount_percentage": 0, "discount_percentage_decimals": 0, "name": "string", "slug": "string", "store_group_id": "string", "type": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | customer group created successfully | application/json (object) | | 400 | Invalid request (e.g. bad payload, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 409 | Conflict (e.g. already exists) | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Customer Group Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Customer Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `app_id` | string | No | - | | `created_at` | string | No | - | | `discount_percentage` | integer | No | - | | `discount_percentage_decimals` | integer | No | - | | `id` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `store_group_id` | string | No | - | | `type` | string | No | - | | `updated_at` | string | No | - | **Generated example (synthetic):** ```json { "data": { "app_id": "string", "created_at": "string", "discount_percentage": 0, "discount_percentage_decimals": 0, "id": "string", "name": "string", "slug": "string", "store_group_id": "string", "type": "string", "updated_at": "string" }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 409 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/customer-groups` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/customer-groups` - OpenAPI tag: CustomerGroups - OpenAPI summary: Create a customer group