chore(docs): Updated API Reference (v2) (#9033)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: AdminCreateCollection
 required:
   - title
-  - metadata
 properties:
   title:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: AdminCreateCustomerGroup
 required:
   - name
-  - metadata
 properties:
   name:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml

@@ -9,12 +9,7 @@ required:
   - labels
   - order
   - order_id
-  - shipping_option_id
   - data
-  - packed_at
-  - shipped_at
-  - delivered_at
-  - canceled_at
   - metadata
 properties:
   location_id:
@@ -28,18 +23,6 @@ properties:
   delivery_address:
     type: object
     description: The fulfillment's delivery address.
-    required:
-      - first_name
-      - last_name
-      - phone
-      - company
-      - address_1
-      - address_2
-      - city
-      - country_code
-      - province
-      - postal_code
-      - metadata
     properties:
       first_name:
         type: string
@@ -95,8 +78,6 @@ properties:
         - sku
         - quantity
         - barcode
-        - line_item_id
-        - inventory_item_id
       properties:
         title:
           type: string

www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml

@@ -4,8 +4,6 @@ x-schemaName: AdminCreatePriceList
 required:
   - title
   - description
-  - starts_at
-  - ends_at
 properties:
   title:
     type: string
@@ -48,8 +46,6 @@ properties:
         - currency_code
         - amount
         - variant_id
-        - min_quantity
-        - max_quantity
       properties:
         currency_code:
           type: string

www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml

@@ -1,5 +1,6 @@
 type: object
 description: SUMMARY
+x-schemaName: AdminCreateShippingProfile
 required:
   - name
   - type
@@ -15,4 +16,3 @@ properties:
   metadata:
     type: object
     description: The shipping profile's metadata.
-x-schemaName: AdminCreateShippingProfile

www/apps/api-reference/specs/admin/components/schemas/AdminLinkPriceListProducts.yaml

@@ -0,0 +1,11 @@
+type: object
+description: The removal details.
+properties:
+  remove:
+    type: array
+    description: The products to remove from the price list.
+    items:
+      type: string
+      title: remove
+      description: The ID of a product.
+x-schemaName: AdminLinkPriceListProducts

www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml

@@ -5,8 +5,8 @@ required:
   - return_requested_total
   - order_change
   - currency_code
-  - id
   - version
+  - id
   - region_id
   - customer_id
   - sales_channel_id
@@ -465,14 +465,14 @@ properties:
     type: string
     title: currency_code
     description: The order preview's currency code.
-  id:
-    type: string
-    title: id
-    description: The order preview's ID.
   version:
     type: number
     title: version
     description: The order preview's version.
+  id:
+    type: string
+    title: id
+    description: The order preview's ID.
   region_id:
     type: string
     title: region_id

www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml

@@ -1,8 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminPostClaimsItemsActionReqSchema
-required:
-  - reason_id
 properties:
   quantity:
     type: number

www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml

@@ -2,10 +2,10 @@ type: object
 description: SUMMARY
 x-schemaName: AdminPostClaimsShippingActionReqSchema
 properties:
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The claim's custom price.
+    title: custom_amount
+    description: The claim's custom amount.
   internal_note:
     type: string
     title: internal_note

www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml

@@ -8,10 +8,10 @@ properties:
     type: string
     title: shipping_option_id
     description: The claim's shipping option id.
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The claim's custom price.
+    title: custom_amount
+    description: The claim's custom amount.
   description:
     type: string
     title: description

www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml

@@ -2,10 +2,10 @@ type: object
 description: SUMMARY
 x-schemaName: AdminPostExchangesShippingActionReqSchema
 properties:
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The exchange's custom price.
+    title: custom_amount
+    description: The exchange's custom amount.
   internal_note:
     type: string
     title: internal_note

www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml

@@ -8,10 +8,10 @@ properties:
     type: string
     title: shipping_option_id
     description: The exchange's shipping option id.
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The exchange's custom price.
+    title: custom_amount
+    description: The exchange's custom amount.
   description:
     type: string
     title: description

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml

@@ -4,8 +4,6 @@ x-schemaName: AdminPostOrderClaimsReqSchema
 required:
   - type
   - order_id
-  - reason_id
-  - metadata
 properties:
   type:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: AdminPostOrderEditsReqSchema
 required:
   - order_id
-  - metadata
 properties:
   order_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml

@@ -2,10 +2,10 @@ type: object
 description: SUMMARY
 x-schemaName: AdminPostOrderEditsShippingActionReqSchema
 properties:
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The order edit's custom price.
+    title: custom_amount
+    description: The order edit's custom amount.
   internal_note:
     type: string
     title: internal_note

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml

@@ -8,10 +8,10 @@ properties:
     type: string
     title: shipping_option_id
     description: The order edit's shipping option id.
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The order edit's custom price.
+    title: custom_amount
+    description: The order edit's custom amount.
   description:
     type: string
     title: description

www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: AdminPostOrderExchangesReqSchema
 required:
   - order_id
-  - metadata
 properties:
   order_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml

@@ -1,8 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminPostReceiveReturnsReqSchema
-required:
-  - metadata
 properties:
   internal_note:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: AdminPostReturnsReqSchema
 required:
   - order_id
-  - metadata
 properties:
   order_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml

@@ -1,8 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminPostReturnsReturnReqSchema
-required:
-  - metadata
 properties:
   location_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml

@@ -2,10 +2,10 @@ type: object
 description: SUMMARY
 x-schemaName: AdminPostReturnsShippingActionReqSchema
 properties:
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The return's custom price.
+    title: custom_amount
+    description: The return's custom amount.
   internal_note:
     type: string
     title: internal_note

www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml

@@ -8,10 +8,10 @@ properties:
     type: string
     title: shipping_option_id
     description: The exchange's shipping option id.
-  custom_price:
+  custom_amount:
     type: number
-    title: custom_price
-    description: The exchange's custom price.
+    title: custom_amount
+    description: The exchange's custom amount.
   description:
     type: string
     title: description

www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml

@@ -61,6 +61,10 @@ properties:
     type: boolean
     title: manage_inventory
     description: The parent's manage inventory.
+  inventory_quantity:
+    type: number
+    title: inventory_quantity
+    description: The parent's inventory quantity.
   hs_code:
     type: string
     title: hs_code

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml

@@ -1,8 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateCollection
-required:
-  - metadata
 properties:
   title:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml

@@ -1,8 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateCustomerGroup
-required:
-  - metadata
 properties:
   name:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml

@@ -1,10 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdatePriceList
-required:
-  - description
-  - starts_at
-  - ends_at
 properties:
   title:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml

@@ -1,9 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateSalesChannel
-required:
-  - description
-  - metadata
 properties:
   name:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml

@@ -1,9 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateStockLocation
-required:
-  - address_id
-  - metadata
 properties:
   name:
     type: string
@@ -14,13 +11,7 @@ properties:
     description: The stock location's address.
     required:
       - address_1
-      - address_2
-      - company
-      - city
       - country_code
-      - phone
-      - postal_code
-      - province
     properties:
       address_1:
         type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml

@@ -1,11 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateStore
-required:
-  - default_sales_channel_id
-  - default_region_id
-  - default_location_id
-  - metadata
 properties:
   name:
     type: string

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml

@@ -1,9 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateTaxRate
-required:
-  - code
-  - metadata
 properties:
   rate:
     type: number

www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml

@@ -1,10 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: AdminUpdateUser
-required:
-  - first_name
-  - last_name
-  - avatar_url
 properties:
   first_name:
     type: string

www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml

@@ -5,8 +5,8 @@ required:
   - order_change
   - status
   - currency_code
-  - id
   - version
+  - id
   - original_item_total
   - original_item_subtotal
   - original_item_tax_total
@@ -671,14 +671,14 @@ properties:
     type: string
     title: currency_code
     description: The order preview's currency code.
-  id:
-    type: string
-    title: id
-    description: The order preview's ID.
   version:
     type: number
     title: version
     description: The order preview's version.
+  id:
+    type: string
+    title: id
+    description: The order preview's ID.
   region_id:
     type: string
     title: region_id
@@ -724,6 +724,8 @@ properties:
       - balance
       - paid_total
       - refunded_total
+      - pending_difference
+      - raw_pending_difference
     properties:
       total:
         oneOf:
@@ -935,6 +937,23 @@ properties:
           - type: object
             description: The summary's refunded total.
             x-schemaName: IBigNumber
+      pending_difference:
+        oneOf:
+          - type: string
+            title: pending_difference
+            description: The summary's pending difference.
+          - type: number
+            title: pending_difference
+            description: The summary's pending difference.
+          - type: string
+            title: pending_difference
+            description: The summary's pending difference.
+          - type: object
+            description: The summary's pending difference.
+            x-schemaName: IBigNumber
+      raw_pending_difference:
+        type: object
+        description: The summary's raw pending difference.
   metadata:
     type: object
     description: The order preview's metadata.

www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml

@@ -4,7 +4,6 @@ x-schemaName: StoreAddCartLineItem
 required:
   - variant_id
   - quantity
-  - metadata
 properties:
   variant_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml

@@ -3,7 +3,6 @@ description: SUMMARY
 x-schemaName: StoreUpdateCartLineItem
 required:
   - quantity
-  - metadata
 properties:
   quantity:
     type: number

www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml

@@ -1,11 +1,6 @@
 type: object
 description: SUMMARY
 x-schemaName: StoreUpdateCustomer
-required:
-  - company_name
-  - first_name
-  - last_name
-  - phone
 properties:
   company_name:
     type: string