chore: update API reference for 2.10.2 (#13499)

This commit is contained in:
Shahed Nasser
2025-09-15 12:30:09 +03:00
committed by GitHub
parent 2657f9c196
commit b35b1b41a4
31 changed files with 838 additions and 0 deletions

View File

@@ -511,6 +511,135 @@
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* - name: id
* in: query
* required: false
* description: Filter by a promotion's ID.
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by a promotion's ID.
* - type: array
* description: Filter by promotion IDs.
* items:
* type: string
* title: id
* description: The promotion's ID.
* - type: object
* description: Filter by a promotion's ID.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

View File

@@ -26,6 +26,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -39,6 +40,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -258,6 +260,14 @@
* type: number
* title: credit_line_total
* description: The draft order's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the draft order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
*
*/

View File

@@ -26,6 +26,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -39,6 +40,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -643,6 +645,14 @@
* type: number
* title: credit_line_total
* description: The draft order preview's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the draft order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the draft order's shipping.
*
*/

View File

@@ -26,6 +26,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -39,6 +40,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -257,6 +259,14 @@
* type: number
* title: credit_line_total
* description: The order's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
*
*/

View File

@@ -14,6 +14,7 @@
* - return_id
* - exchange_id
* - claim_id
* - ordering
* - order_change_id
* - reference
* - reference_id
@@ -100,6 +101,10 @@
* format: date-time
* title: updated_at
* description: The date the action was updated.
* ordering:
* type: number
* title: ordering
* description: The action's order in the sequence of actions.
*
*/

View File

@@ -26,6 +26,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -39,6 +40,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -643,6 +645,14 @@
* type: number
* title: credit_line_total
* description: The order preview's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
*
*/

View File

@@ -108,6 +108,14 @@
* type: number
* title: timeout
* description: The maximum time in seconds to wait for this step to complete. If the step exceeds this time, the step's state is changed to `timeout`, but the step continues executing.
* autoRetry:
* type: boolean
* title: autoRetry
* description: Whether the step should be automatically retried if it fails.
* maxAwaitingRetries:
* type: number
* title: maxAwaitingRetries
* description: The maximum number of times to retry the step while it's in the `waiting_response` state.
* compensate:
* type: object
* description: The state of the step's compensation function.

View File

@@ -25,6 +25,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -38,6 +39,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -245,6 +247,14 @@
* type: number
* title: credit_line_total
* description: The order's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
*
*/

View File

@@ -17,6 +17,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -32,6 +33,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -309,6 +311,14 @@
* type: number
* title: credit_line_total
* description: The order's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
*
*/

View File

@@ -24,6 +24,7 @@
* - item_total
* - item_subtotal
* - item_tax_total
* - item_discount_total
* - original_total
* - original_subtotal
* - original_tax_total
@@ -37,6 +38,7 @@
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - shipping_discount_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
@@ -243,6 +245,14 @@
* type: number
* title: credit_line_total
* description: The order's credit line total.
* item_discount_total:
* type: number
* title: item_discount_total
* description: The total discount amount applied on the order's items.
* shipping_discount_total:
* type: number
* title: shipping_discount_total
* description: The total discount amount applied on the order's shipping.
*
*/