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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
--- a/docs/api/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
+++ b/docs/api/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
@@ -0,0 +1,79 @@
+type: object
+required:
+  - name
+  - description
+  - type
+  - prices
+properties:
+  name:
+    description: The name of the Price List
+    type: string
+  description:
+    description: A description of the Price List.
+    type: string
+  starts_at:
+    description: The date with timezone that the Price List starts being valid.
+    type: string
+    format: date
+  ends_at:
+    description: The date with timezone that the Price List ends being valid.
+    type: string
+    format: date
+  type:
+    description: The type of the Price List.
+    type: string
+    enum:
+      - sale
+      - override
+  status:
+    description: The status of the Price List.
+    type: string
+    enum:
+      - active
+      - draft
+  prices:
+    description: The prices of the Price List.
+    type: array
+    items:
+      required:
+        - amount
+        - variant_id
+      properties:
+        region_id:
+          description: >-
+            The ID of the Region for which the price is used. 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.
+          type: string
+          externalDocs:
+            url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+            description: See a list of codes.
+        amount:
+          description: The amount to charge for the Product Variant.
+          type: integer
+        variant_id:
+          description: The ID of the Variant for which the price is used.
+          type: string
+        min_quantity:
+          description: The minimum quantity for which the price will be used.
+          type: integer
+        max_quantity:
+          description: The maximum quantity for which the price will be used.
+          type: integer
+  customer_groups:
+    type: array
+    description: A list of customer groups that the Price List applies to.
+    items:
+      required:
+        - id
+      properties:
+        id:
+          description: The ID of a customer group
+          type: string
+  includes_tax:
+    description: '[EXPERIMENTAL] Tax included in prices of price list'
+    type: boolean