Files
medusa-store/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
2023-02-09 09:50:55 +02:00

109 lines
3.0 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:
$ref: >-
../components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
x-codegen:
method: addCustomers
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customer-groups_{id}_customers_batch/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsRes.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:
$ref: >-
../components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml
x-codegen:
method: removeCustomers
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/customer-groups_{id}_customers_batch/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/customer-groups_{id}_customers_batch/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Customer Group
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminCustomerGroupsRes.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