658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
75 lines
2.1 KiB
YAML
75 lines
2.1 KiB
YAML
get:
|
|
operationId: GetCustomerGroupsGroupCustomers
|
|
summary: List Customers
|
|
description: >-
|
|
Retrieve a list of customers in a customer group. The customers can be
|
|
filtered by the `q` field. The customers can also be paginated.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the customer group.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: limit
|
|
description: The number of customers to return.
|
|
schema:
|
|
type: integer
|
|
default: 50
|
|
- in: query
|
|
name: offset
|
|
description: The number of customers to skip when retrieving the customers.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
Comma-separated relations that should be expanded in the returned
|
|
customers.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: q
|
|
description: a term to search customers by email, first_name, and last_name.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: listCustomers
|
|
queryParams: AdminGetGroupsGroupCustomersParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_customer-groups_{id}_customers/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Customer Groups
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminCustomersListRes.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
|