asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated API Reference (#4706)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/api/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
View File

@@ -6,10 +6,10 @@ required:
- prices
properties:
name:
description: The name of the Price List
description: The name of the Price List.
type: string
description:
description: A description of the Price List.
description: The description of the Price List.
type: string
starts_at:
description: The date with timezone that the Price List starts being valid.
@@ -26,7 +26,9 @@ properties:
- sale
- override
status:
description: The status of the Price List.
description: >-
The status of the Price List. If the status is set to `draft`, the prices
created in the price list will not be available of the customer.
type: string
enum:
- active
@@ -42,13 +44,13 @@ properties:
properties:
region_id:
description: >-
The ID of the Region for which the price is used. Only required if
currecny_code is not provided.
The ID of the Region for which the price is used. This is only
required if `currecny_code` is not provided.
type: string
currency_code:
description: >-
The 3 character ISO currency code for which the price will be used.
Only required if region_id is not provided.
This is only required if `region_id` is not provided.
type: string
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
@@ -67,7 +69,7 @@ properties:
type: integer
customer_groups:
type: array
description: A list of customer groups that the Price List applies to.
description: An array of customer groups that the Price List applies to.
items:
type: object
required:
@@ -77,5 +79,6 @@ properties:
description: The ID of a customer group
type: string
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of price list'
description: Tax included in prices of price list
x-featureFlag: tax_inclusive_pricing
type: boolean