chore(docs): Updated API Reference (automated) (#12826)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-06-25 12:18:41 +00:00
1 parent 441334abf4
commit 7ac734ca21
@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -250,6 +251,10 @@
 *     description: The draft order's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The draft order's credit line total.
 * 
 */

@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   return_requested_total:
 *     type: number
@@ -629,6 +630,10 @@
 *     description: The order preview's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The draft order preview's credit line total.
 * 
 */

@@ -0,0 +1,37 @@
+/**
+ * @schema AdminImportProducts
+ * type: object
+ * description: The details of the product's import file.
+ * x-schemaName: AdminImportProducts
+ * required:
+ *   - file_key
+ *   - originalname
+ *   - extension
+ *   - size
+ *   - mime_type
+ * properties:
+ *   file_key:
+ *     type: string
+ *     title: file_key
+ *     description: The name of the file as stored in the configured File Module Provider.
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's original name.
+ *   extension:
+ *     type: string
+ *     title: extension
+ *     description: The file's extension.
+ *     example: csv
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ * 
+*/
+
@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -249,6 +250,10 @@
 *     description: The order's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -42,6 +42,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   return_requested_total:
 *     type: number
@@ -629,6 +630,10 @@
 *     description: The order preview's credit lines.
 *     items:
 *       $ref: "#/components/schemas/OrderCreditLine"
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order preview's credit line total.
 * 
 */

@@ -63,6 +63,10 @@
 *       - draft
 *       - active
 *       - inactive
+ *   is_tax_inclusive:
+ *     type: boolean
+ *     title: is_tax_inclusive
+ *     description: Whether the promotion is tax inclusive. If enabled, the promotion is applied after tax is calculated.
 * 
 */

@@ -0,0 +1,32 @@
+/**
+ * @schema AdminUploadPreSignedUrl
+ * type: object
+ * description: The details of the file to upload.
+ * x-schemaName: AdminUploadPreSignedUrl
+ * required:
+ *   - originalname
+ *   - size
+ *   - mime_type
+ * properties:
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's original name.
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ *   access:
+ *     type: string
+ *     description: The access level of the file. If `private`, the file will not be publicly accessible. The default value depends on the configured File Module Provider.
+ *     enum:
+ *       - public
+ *       - private
+ * 
+*/
+
@@ -0,0 +1,42 @@
+/**
+ * @schema AdminUploadPreSignedUrlResponse
+ * type: object
+ * description: The result of the pre-signed URL upload request.
+ * x-schemaName: AdminUploadPreSignedUrlResponse
+ * required:
+ *   - url
+ *   - filename
+ *   - originalname
+ *   - mime_type
+ *   - extension
+ *   - size
+ * properties:
+ *   url:
+ *     type: string
+ *     title: url
+ *     description: The file's pre-signed upload URL.
+ *   filename:
+ *     type: string
+ *     title: filename
+ *     description: The file's filename.
+ *   originalname:
+ *     type: string
+ *     title: originalname
+ *     description: The file's orignal name.
+ *   mime_type:
+ *     type: string
+ *     title: mime_type
+ *     description: The file's mime type.
+ *     example: text/csv
+ *   extension:
+ *     type: string
+ *     title: extension
+ *     description: The file's extension.
+ *     example: csv
+ *   size:
+ *     type: number
+ *     title: size
+ *     description: The file's size in bytes.
+ * 
+*/
+
@@ -41,6 +41,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   payment_collections:
 *     type: array
@@ -237,6 +238,10 @@
 *     type: string
 *     title: status
 *     description: The order's status.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -26,6 +26,7 @@
 *   - discount_subtotal
 *   - discount_total
 *   - discount_tax_total
+ *   - credit_line_total
 *   - gift_card_total
 *   - gift_card_tax_total
 *   - shipping_total
@@ -301,6 +302,10 @@
 *     format: date-time
 *     title: deleted_at
 *     description: The date the order was deleted.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -40,6 +40,7 @@
 *   - original_shipping_total
 *   - original_shipping_subtotal
 *   - original_shipping_tax_total
+ *   - credit_line_total
 * properties:
 *   id:
 *     type: string
@@ -235,6 +236,10 @@
 *     type: string
 *     title: status
 *     description: The order's status.
+ *   credit_line_total:
+ *     type: number
+ *     title: credit_line_total
+ *     description: The order's credit line total.
 * 
 */

@@ -130,10 +130,10 @@
 *   - deleted_at
 *   - sku
 *   - barcode
+ *   - manage_inventory
+ *   - allow_backorder
 *   - ean
 *   - upc
- *   - allow_backorder
- *   - manage_inventory
 * 
 */