fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
209 lines
5.8 KiB
YAML
209 lines
5.8 KiB
YAML
get:
|
|
operationId: GetCustomerGroups
|
|
summary: List Customer Groups
|
|
description: >-
|
|
Retrieve a list of customer groups. The customer groups can be filtered by
|
|
fields such as `name` or `id. The customer groups can also be sorted or
|
|
paginated.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: q
|
|
description: term to search customer groups by name.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: >-
|
|
The number of customer groups to skip when retrieving the customer
|
|
groups.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- in: query
|
|
name: order
|
|
description: A field to sort order the retrieved customer groups by.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: discount_condition_id
|
|
description: Filter by discount condition ID.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: id
|
|
style: form
|
|
explode: false
|
|
description: Filter by the customer group ID
|
|
schema:
|
|
oneOf:
|
|
- type: string
|
|
description: customer group ID
|
|
- type: array
|
|
description: an array of customer group IDs
|
|
items:
|
|
type: string
|
|
- type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by IDs less than this ID
|
|
gt:
|
|
type: string
|
|
description: filter by IDs greater than this ID
|
|
lte:
|
|
type: string
|
|
description: filter by IDs less than or equal to this ID
|
|
gte:
|
|
type: string
|
|
description: filter by IDs greater than or equal to this ID
|
|
- in: query
|
|
name: name
|
|
style: form
|
|
explode: false
|
|
description: Filter by the customer group name
|
|
schema:
|
|
type: array
|
|
description: an array of customer group names
|
|
items:
|
|
type: string
|
|
description: customer group name
|
|
- in: query
|
|
name: created_at
|
|
description: Filter by a creation date range.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by dates less than this date
|
|
format: date
|
|
gt:
|
|
type: string
|
|
description: filter by dates greater than this date
|
|
format: date
|
|
lte:
|
|
type: string
|
|
description: filter by dates less than or equal to this date
|
|
format: date
|
|
gte:
|
|
type: string
|
|
description: filter by dates greater than or equal to this date
|
|
format: date
|
|
- in: query
|
|
name: updated_at
|
|
description: Filter by an update date range.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: string
|
|
description: filter by dates less than this date
|
|
format: date
|
|
gt:
|
|
type: string
|
|
description: filter by dates greater than this date
|
|
format: date
|
|
lte:
|
|
type: string
|
|
description: filter by dates less than or equal to this date
|
|
format: date
|
|
gte:
|
|
type: string
|
|
description: filter by dates greater than or equal to this date
|
|
format: date
|
|
- in: query
|
|
name: limit
|
|
description: The number of customer groups to return.
|
|
schema:
|
|
type: integer
|
|
default: 10
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
Comma-separated relations that should be expanded in the returned
|
|
customer groups.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: list
|
|
queryParams: AdminGetCustomerGroupsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_customer-groups/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_customer-groups/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Customer Groups
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminCustomerGroupsListRes.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: PostCustomerGroups
|
|
summary: Create a Customer Group
|
|
description: Creates a Customer Group.
|
|
x-authenticated: true
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminPostCustomerGroupsReq.yaml
|
|
x-codegen:
|
|
method: create
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_customer-groups/post.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_customer-groups/post.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Customer Groups
|
|
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
|