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>
2024-09-06 12:25:48 +00:00
1 parent 20545b194e
commit cf3c25addf
@@ -5,7 +5,6 @@
 * x-schemaName: AdminCreateCollection
 * required:
 *   - title
- *   - metadata
 * properties:
 *   title:
 *     type: string
@@ -5,7 +5,6 @@
 * x-schemaName: AdminCreateCustomerGroup
 * required:
 *   - name
- *   - metadata
 * properties:
 *   name:
 *     type: string
@@ -11,12 +11,7 @@
 *   - labels
 *   - order
 *   - order_id
- *   - shipping_option_id
 *   - data
- *   - packed_at
- *   - shipped_at
- *   - delivered_at
- *   - canceled_at
 *   - metadata
 * properties:
 *   location_id:
@@ -30,18 +25,6 @@
 *   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
@@ -97,8 +80,6 @@
 *         - sku
 *         - quantity
 *         - barcode
- *         - line_item_id
- *         - inventory_item_id
 *       properties:
 *         title:
 *           type: string
@@ -6,8 +6,6 @@
 * required:
 *   - title
 *   - description
- *   - starts_at
- *   - ends_at
 * properties:
 *   title:
 *     type: string
@@ -50,8 +48,6 @@
 *         - currency_code
 *         - amount
 *         - variant_id
- *         - min_quantity
- *         - max_quantity
 *       properties:
 *         currency_code:
 *           type: string
@@ -2,6 +2,7 @@
 * @schema AdminCreateShippingProfile
 * type: object
 * description: SUMMARY
+ * x-schemaName: AdminCreateShippingProfile
 * required:
 *   - name
 *   - type
@@ -17,7 +18,6 @@
 *   metadata:
 *     type: object
 *     description: The shipping profile's metadata.
- * x-schemaName: AdminCreateShippingProfile
 * 
 */

@@ -0,0 +1,16 @@
+/**
+ * @schema AdminLinkPriceListProducts
+ * 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
+ * 
+*/
+
@@ -7,8 +7,8 @@
 *   - return_requested_total
 *   - order_change
 *   - currency_code
- *   - id
 *   - version
+ *   - id
 *   - region_id
 *   - customer_id
 *   - sales_channel_id
@@ -467,14 +467,14 @@
 *     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
@@ -3,8 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminPostClaimsItemsActionReqSchema
- * required:
- *   - reason_id
 * properties:
 *   quantity:
 *     type: number
@@ -4,10 +4,10 @@
 * 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
@@ -10,10 +10,10 @@
 *     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
@@ -4,10 +4,10 @@
 * 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
@@ -10,10 +10,10 @@
 *     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
@@ -6,8 +6,6 @@
 * required:
 *   - type
 *   - order_id
- *   - reason_id
- *   - metadata
 * properties:
 *   type:
 *     type: string
@@ -5,7 +5,6 @@
 * x-schemaName: AdminPostOrderEditsReqSchema
 * required:
 *   - order_id
- *   - metadata
 * properties:
 *   order_id:
 *     type: string
@@ -4,10 +4,10 @@
 * 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
@@ -10,10 +10,10 @@
 *     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
@@ -5,7 +5,6 @@
 * x-schemaName: AdminPostOrderExchangesReqSchema
 * required:
 *   - order_id
- *   - metadata
 * properties:
 *   order_id:
 *     type: string
@@ -3,8 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminPostReceiveReturnsReqSchema
- * required:
- *   - metadata
 * properties:
 *   internal_note:
 *     type: string
@@ -5,7 +5,6 @@
 * x-schemaName: AdminPostReturnsReqSchema
 * required:
 *   - order_id
- *   - metadata
 * properties:
 *   order_id:
 *     type: string
@@ -3,8 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminPostReturnsReturnReqSchema
- * required:
- *   - metadata
 * properties:
 *   location_id:
 *     type: string
@@ -4,10 +4,10 @@
 * 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
@@ -10,10 +10,10 @@
 *     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
@@ -63,6 +63,10 @@
 *     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
@@ -3,8 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateCollection
- * required:
- *   - metadata
 * properties:
 *   title:
 *     type: string
@@ -3,8 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateCustomerGroup
- * required:
- *   - metadata
 * properties:
 *   name:
 *     type: string
@@ -3,10 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdatePriceList
- * required:
- *   - description
- *   - starts_at
- *   - ends_at
 * properties:
 *   title:
 *     type: string
@@ -3,9 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateSalesChannel
- * required:
- *   - description
- *   - metadata
 * properties:
 *   name:
 *     type: string
@@ -3,9 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateStockLocation
- * required:
- *   - address_id
- *   - metadata
 * properties:
 *   name:
 *     type: string
@@ -16,13 +13,7 @@
 *     description: The stock location's address.
 *     required:
 *       - address_1
- *       - address_2
- *       - company
- *       - city
 *       - country_code
- *       - phone
- *       - postal_code
- *       - province
 *     properties:
 *       address_1:
 *         type: string
@@ -3,11 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateStore
- * required:
- *   - default_sales_channel_id
- *   - default_region_id
- *   - default_location_id
- *   - metadata
 * properties:
 *   name:
 *     type: string
@@ -3,9 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateTaxRate
- * required:
- *   - code
- *   - metadata
 * properties:
 *   rate:
 *     type: number
@@ -3,10 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: AdminUpdateUser
- * required:
- *   - first_name
- *   - last_name
- *   - avatar_url
 * properties:
 *   first_name:
 *     type: string
@@ -7,8 +7,8 @@
 *   - order_change
 *   - status
 *   - currency_code
- *   - id
 *   - version
+ *   - id
 *   - original_item_total
 *   - original_item_subtotal
 *   - original_item_tax_total
@@ -673,14 +673,14 @@
 *     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
@@ -726,6 +726,8 @@
 *       - balance
 *       - paid_total
 *       - refunded_total
+ *       - pending_difference
+ *       - raw_pending_difference
 *     properties:
 *       total:
 *         oneOf:
@@ -937,6 +939,23 @@
 *           - 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.
@@ -6,7 +6,6 @@
 * required:
 *   - variant_id
 *   - quantity
- *   - metadata
 * properties:
 *   variant_id:
 *     type: string
@@ -5,7 +5,6 @@
 * x-schemaName: StoreUpdateCartLineItem
 * required:
 *   - quantity
- *   - metadata
 * properties:
 *   quantity:
 *     type: number
@@ -3,11 +3,6 @@
 * type: object
 * description: SUMMARY
 * x-schemaName: StoreUpdateCustomer
- * required:
- *   - company_name
- *   - first_name
- *   - last_name
- *   - phone
 * properties:
 *   company_name:
 *     type: string