delete: operationId: DeleteCustomerGroupsCustomerGroup summary: Delete a Customer Group description: Deletes a CustomerGroup. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Customer Group schema: type: string x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/customer-groups_{id}/deleteundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/customer-groups_{id}/deleteundefined security: - api_token: [] - cookie_auth: [] tags: - Customer Group responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The ID of the deleted customer group. object: type: string description: The type of the object that was deleted. default: customer_group deleted: type: boolean description: Whether the customer group was deleted successfully or not. default: true '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml get: operationId: GetCustomerGroupsGroup summary: Get a Customer Group description: Retrieves a Customer Group. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Customer Group. schema: type: string - in: query name: expand description: (Comma separated) Which fields should be expanded in the customer group. schema: type: string - in: query name: fields description: (Comma separated) Which fields should be included in the customer group. schema: type: string x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/customer-groups_{id}/getundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/customer-groups_{id}/getundefined security: - api_token: [] - cookie_auth: [] tags: - Customer Group responses: '200': description: OK content: application/json: schema: type: object properties: customer_group: $ref: ../components/schemas/customer_group.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostCustomerGroupsGroup summary: Update a Customer Group description: Update a CustomerGroup. x-authenticated: true parameters: - in: path name: id required: true description: The ID of the customer group. schema: type: string requestBody: content: application/json: schema: type: object properties: name: description: Name of the customer group type: string metadata: description: Metadata for the customer. type: object x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/customer-groups_{id}/postundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/customer-groups_{id}/postundefined security: - api_token: [] - cookie_auth: [] tags: - Customer Group responses: '200': description: OK content: application/json: schema: type: object properties: customer_group: $ref: ../components/schemas/customer_group.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml