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
161 lines
4.2 KiB
YAML
161 lines
4.2 KiB
YAML
get:
|
|
operationId: GetDiscounts
|
|
summary: List Discounts
|
|
x-authenticated: true
|
|
description: >-
|
|
Retrieve a list of Discounts. The discounts can be filtered by fields such
|
|
as `rule` or `is_dynamic`. The discounts can also be paginated.
|
|
parameters:
|
|
- in: query
|
|
name: q
|
|
description: term to search discounts' code field.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: rule
|
|
description: Filter discounts by rule fields.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- fixed
|
|
- percentage
|
|
- free_shipping
|
|
description: Filter discounts by type.
|
|
allocation:
|
|
type: string
|
|
enum:
|
|
- total
|
|
- item
|
|
description: Filter discounts by allocation type.
|
|
- in: query
|
|
name: is_dynamic
|
|
description: Filter discounts by whether they're dynamic or not.
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: is_disabled
|
|
description: Filter discounts by whether they're disabled or not.
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: limit
|
|
description: The number of discounts to return
|
|
schema:
|
|
type: number
|
|
default: '20'
|
|
- in: query
|
|
name: offset
|
|
description: The number of discounts to skip when retrieving the discounts.
|
|
schema:
|
|
type: number
|
|
default: '0'
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
Comma-separated relations that should be expanded in each returned
|
|
discount.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: list
|
|
queryParams: AdminGetDiscountsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_discounts/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_discounts/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Discounts
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminDiscountsListRes.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: PostDiscounts
|
|
summary: Create a Discount
|
|
x-authenticated: true
|
|
description: >-
|
|
Create a Discount with a given set of rules that defines how the Discount is
|
|
applied.
|
|
parameters:
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
Comma-separated relations that should be expanded in the returned
|
|
discount.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: >-
|
|
Comma-separated fields that should be retrieved in the returned
|
|
discount.
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminPostDiscountsReq.yaml
|
|
x-codegen:
|
|
method: create
|
|
queryParams: AdminPostDiscountsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_discounts/post.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_discounts/post.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Discounts
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminDiscountsRes.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
|