DEVDOCS-5967-b

bigcommerce · Dec 13, 2024 · 5993a01 · 5993a01
1 parent ff627f8
commit 5993a01
Showing 1 changed file with 82 additions and 86 deletions.
diff --git a/reference/customers.v2.yml b/reference/customers.v2.yml
@@ -1426,105 +1426,101 @@ components:
         discount_rules:
           oneOf:
           - type: array
-            description: A collection of discount rules that are automatically applied to customers who are members of the group.
+            title: price list
+            description: A singe discount rule that references a price list.
             items:
               type: object
               properties:
                 type:
                   type: string
                   enum:
                     - price_list
-                    - all
-                    - category
-                    - product
-                method:
-                  type: string
-                  enum:
-                    - percent
-                    - fixed
-                    - price
-                amount:
-                  type: string
-                  description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-                  example: "5.0000"
                 price_list_id:
                   type: integer
                   description: If a customer group is assigned to a price list,`method` and `amount` are not shown. `type` and `price_list_id` are returned.
                   example: 3
+              required:
+                - type
+                - price_list
+              minItems: 1
+              maxItems: 1
           - type: array
-            description: A collection of category-level discount rules that are automatically applied to customers who are members of the group.
-            items:
-              type: object
-              properties:
-                type:
-                  type: string
-                  enum:
-                    - price_list
-                    - all
-                    - category
-                    - product
-                method:
-                  type: string
-                  enum:
-                    - percent
-                    - fixed
-                    - price
-                amount:
-                  type: string
-                  description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-                  example: "5.0000"
-                category_id:
-                  type: integer
-                  description: If a customer group is assigned to a category, `method` and `amount` are not shown. `type` and `category_id` are returned.
-                  example: 3
-          - type: array
-            description: A collection of product-level discount rules that are automatically applied to customers who are members of the group.
-            items:
-              type: object
-              properties:
-                type:
-                  type: string
-                  enum:
-                    - price_list
-                    - all
-                    - category
-                    - product
-                method:
-                  type: string
-                  enum:
-                    - percent
-                    - fixed
-                    - price
-                amount:
-                  type: string
-                  description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-                  example: "5.0000"
-                product_id:
-                  type: integer
-                  description: If a customer group is assigned to a product,`method` and `amount` are not shown. `type` and `product` are returned.
-                  example: 3
-          - type: array
-            description: A collection of storewide discount rules that are automatically applied to customers who are members of the group.
+            title: category or product
+            description: A collection of category-level or product-level discount rules.
             items:
-              type: object
-              properties:
-                type:
-                  type: string
-                  enum:
-                    - price_list
-                    - all
-                    - category
-                    - product
-                method:
-                  type: string
-                  enum:
-                    - percent
-                    - fixed
-                    - price
-                amount:
-                  type: string
-                  description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-                  example: "5.0000"
+                oneOf:
+                  - type: object
+                    title: category
+                    properties:
+                      type:
+                        type: string
+                        enum:
+                          - category
+                      method:
+                        type: string
+                        enum:
+                          - percent
+                          - fixed
+                          - price
+                      amount:
+                        type: string
+                        description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
+                        example: "5.0000"
+                      category_id:
+                        type: integer
+                        description: If a customer group is assigned to a category, `method` and `amount` are not shown. `type` and `category_id` are returned.
+                        example: 3
+                    required:
+                    - type
+                    - method
+                    - amount
+                    - category_id
+                  - type: object
+                    title: product
+                    properties:
+                      type:
+                        type: string
+                        enum:
+                          - product
+                      method:
+                        type: string
+                        enum:
+                          - percent
+                          - fixed
+                          - price
+                      amount:
+                        type: string
+                        description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
+                        example: "5.0000"
+                      product_id:
+                        type: integer
+                        description: If a customer group is assigned to a product,`method` and `amount` are not shown. `type` and `product` are returned.
+                        example: 3
+                    required:
+                      - type
+                      - method
+                      - amount
+                      - product_id
+                  - type: object
+                    title: all (store-wide)
+                    properties:
+                      type:
+                        type: string
+                        enum:
+                          - all
+                      method:
+                        type: string
+                        enum:
+                          - percent
+                          - fixed
+                          - price
+                      amount:
+                        type: string
+                        description: A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
+                        example: "5.0000"
+                    required:
+                      - type
+                    minItems: 1
         is_group_for_guests:
           type: boolean
           description: Describes whether the group is for guests. There can only be one customer group for guests at a time.