137 lines
3.7 KiB
YAML
137 lines
3.7 KiB
YAML
post:
|
|
operationId: PostCustomerGroupsGroupCustomersBatch
|
|
summary: Add Customers
|
|
description: Adds a list of customers, represented by id's, to a customer group.
|
|
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
|
|
required:
|
|
- customer_ids
|
|
properties:
|
|
customer_ids:
|
|
description: The ids of the customers to add
|
|
type: array
|
|
items:
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
description: ID of the customer
|
|
type: string
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: >-
|
|
../code_samples/JavaScript/customer-groups_{id}_customers_batch/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: >-
|
|
../code_samples/Shell/customer-groups_{id}_customers_batch/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
|
|
delete:
|
|
operationId: DeleteCustomerGroupsGroupCustomerBatch
|
|
summary: Remove Customers
|
|
description: Removes a list of customers, represented by id's, from a customer group.
|
|
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
|
|
required:
|
|
- customer_ids
|
|
properties:
|
|
customer_ids:
|
|
description: The ids of the customers to remove
|
|
type: array
|
|
items:
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
description: ID of the customer
|
|
type: string
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: >-
|
|
../code_samples/JavaScript/customer-groups_{id}_customers_batch/deleteundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: >-
|
|
../code_samples/Shell/customer-groups_{id}_customers_batch/deleteundefined
|
|
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
|