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>
This commit is contained in:
github-actions[bot]
2025-06-25 12:18:41 +00:00
committed by GitHub
parent 441334abf4
commit 7ac734ca21
168 changed files with 2982 additions and 25 deletions

View File

@@ -40,6 +40,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
payment_collections:
type: array
@@ -254,3 +255,7 @@ properties:
description: The draft order's credit lines.
items:
$ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order's credit line total.

View File

@@ -40,6 +40,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
return_requested_total:
type: number
@@ -653,3 +654,7 @@ properties:
description: The order preview's credit lines.
items:
$ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order preview's credit line total.

View File

@@ -0,0 +1,32 @@
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

View File

@@ -40,6 +40,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
payment_collections:
type: array
@@ -247,3 +248,7 @@ properties:
description: The order's credit lines.
items:
$ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.

View File

@@ -42,6 +42,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
return_requested_total:
type: number
@@ -655,3 +656,7 @@ properties:
description: The order preview's credit lines.
items:
$ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order preview's credit line total.

View File

@@ -63,3 +63,9 @@ properties:
- 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.

View File

@@ -0,0 +1,30 @@
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

View File

@@ -0,0 +1,37 @@
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.

View File

@@ -39,6 +39,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
payment_collections:
type: array
@@ -235,3 +236,7 @@ properties:
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.

View File

@@ -24,6 +24,7 @@ required:
- discount_subtotal
- discount_total
- discount_tax_total
- credit_line_total
- gift_card_total
- gift_card_tax_total
- shipping_total
@@ -303,3 +304,7 @@ properties:
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.

View File

@@ -38,6 +38,7 @@ required:
- original_shipping_total
- original_shipping_subtotal
- original_shipping_tax_total
- credit_line_total
properties:
id:
type: string
@@ -233,3 +234,7 @@ properties:
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.

View File

@@ -134,7 +134,7 @@ required:
- deleted_at
- sku
- barcode
- manage_inventory
- allow_backorder
- ean
- upc
- allow_backorder
- manage_inventory