chore(docs): Updated API Reference (automated) (#11719)
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:
co-authored by
Oli Juhl
Shahed Nasser
parent
8a36bd4034
commit
6294a71296
@@ -922,48 +922,6 @@
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: A sales channel's ID.
|
||||
* - name: fulfillment_status
|
||||
* in: query
|
||||
* description: Filter by the fulfillment status of the draft order.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by the fulfillment status of the draft order.
|
||||
* items:
|
||||
* type: string
|
||||
* title: fulfillment_status
|
||||
* description: The fulfillment status's details.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* - name: payment_status
|
||||
* in: query
|
||||
* description: Filter by the payment status of the draft order.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by the payment status of the draft order.
|
||||
* items:
|
||||
* type: string
|
||||
* title: payment_status
|
||||
* description: The payment status's details.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* - name: region_id
|
||||
* in: query
|
||||
* description: Filter by region IDs to retrieve their associated draft orders.
|
||||
|
||||
@@ -104,46 +104,6 @@
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: A sales channel's ID.
|
||||
* - name: fulfillment_status
|
||||
* in: query
|
||||
* description: Filter by the order's fulfillment status.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by the order's fulfillment status.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A fulfillment status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* - name: payment_status
|
||||
* in: query
|
||||
* description: Filter by the order's payment status.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by the order's payment status.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A payment status
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* - name: region_id
|
||||
* in: query
|
||||
* description: Filter by region IDs to retrieve their associated orders.
|
||||
|
||||
@@ -104,46 +104,6 @@
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: A sales channel's ID.
|
||||
* - name: fulfillment_status
|
||||
* in: query
|
||||
* description: Filter by fulfillment statuses.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by fulfillment statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A fulfillment status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* - name: payment_status
|
||||
* in: query
|
||||
* description: Filter by payment statuses.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by payment statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A payment status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* - name: region_id
|
||||
* in: query
|
||||
* description: Filter by region IDs to retrieve their associated returns.
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
* - id
|
||||
* - calculated_amount
|
||||
* - original_amount
|
||||
* - original_amount_with_tax
|
||||
* - original_amount_without_tax
|
||||
* - currency_code
|
||||
* properties:
|
||||
* id:
|
||||
@@ -56,6 +58,14 @@
|
||||
* original_price:
|
||||
* type: object
|
||||
* description: The original price's details.
|
||||
* original_amount_with_tax:
|
||||
* type: number
|
||||
* title: original_amount_with_tax
|
||||
* description: The amount of the original price with taxes applied.
|
||||
* original_amount_without_tax:
|
||||
* type: number
|
||||
* title: original_amount_without_tax
|
||||
* description: The amount of the original price without taxes.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
* - id
|
||||
* - order_id
|
||||
* - order
|
||||
* - amount
|
||||
* - reference
|
||||
* - reference_id
|
||||
* - metadata
|
||||
@@ -44,6 +45,10 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the credit line was updated.
|
||||
* amount:
|
||||
* type: number
|
||||
* title: amount
|
||||
* description: The credit line's amount.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -51,6 +51,10 @@
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the item was updated.
|
||||
* damaged_quantity:
|
||||
* type: number
|
||||
* title: damaged_quantity
|
||||
* description: The item's damaged quantity.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
* - id
|
||||
* - calculated_amount
|
||||
* - original_amount
|
||||
* - original_amount_with_tax
|
||||
* - original_amount_without_tax
|
||||
* - currency_code
|
||||
* properties:
|
||||
* id:
|
||||
@@ -113,6 +115,14 @@
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The maximum quantity required in the cart for the price to apply.
|
||||
* original_amount_with_tax:
|
||||
* type: number
|
||||
* title: original_amount_with_tax
|
||||
* description: The original amount with taxes applied.
|
||||
* original_amount_without_tax:
|
||||
* type: number
|
||||
* title: original_amount_without_tax
|
||||
* description: The original amount without taxes.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user