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
co-authored by Oli Juhl Shahed Nasser
parent 441334abf4
commit 7ac734ca21
168 changed files with 2982 additions and 25 deletions
@@ -0,0 +1,16 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.product.createImport({
file // uploaded File instance
})
.then(({ transaction_id }) => {
console.log(transaction_id)
})
@@ -0,0 +1,14 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.product.confirmImport("transaction_123")
.then(() => {
console.log("Import confirmed")
})
@@ -0,0 +1,15 @@
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.upload.presignedUrl({
name: "test.txt",
size: 1000,
type: "text/plain",
}))
@@ -0,0 +1,10 @@
curl -X POST '{backend_url}/admin/products/imports' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"file_key": "{value}",
"originalname": "{value}",
"extension": "{value}",
"size": 38,
"mime_type": "{value}"
}'
@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/products/imports/{transaction_id}/confirm' \
-H 'Authorization: Bearer {access_token}'
@@ -0,0 +1,8 @@
curl -X POST '{backend_url}/admin/uploads/presigned-urls' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
"originalname": "{value}",
"size": 43,
"mime_type": "{value}"
}'
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -254,3 +255,7 @@ properties:
description: The draft order's credit lines. description: The draft order's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order's credit line total.
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -653,3 +654,7 @@ properties:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order preview's credit line total.
@@ -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
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -247,3 +248,7 @@ properties:
description: The order's credit lines. description: The order's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -42,6 +42,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -655,3 +656,7 @@ properties:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order preview's credit line total.
@@ -63,3 +63,9 @@ properties:
- draft - draft
- active - active
- inactive - 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,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
@@ -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.
@@ -39,6 +39,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -235,3 +236,7 @@ properties:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -24,6 +24,7 @@ required:
- discount_subtotal - discount_subtotal
- discount_total - discount_total
- discount_tax_total - discount_tax_total
- credit_line_total
- gift_card_total - gift_card_total
- gift_card_tax_total - gift_card_tax_total
- shipping_total - shipping_total
@@ -303,3 +304,7 @@ properties:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The date the order was deleted. description: The date the order was deleted.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -38,6 +38,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
id: id:
type: string type: string
@@ -233,3 +234,7 @@ properties:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -134,7 +134,7 @@ required:
- deleted_at - deleted_at
- sku - sku
- barcode - barcode
- manage_inventory
- allow_backorder
- ean - ean
- upc - upc
- allow_backorder
- manage_inventory
File diff suppressed because it is too large Load Diff
@@ -981,6 +981,10 @@ paths:
$ref: paths/admin_products_import.yaml $ref: paths/admin_products_import.yaml
/admin/products/import/{transaction_id}/confirm: /admin/products/import/{transaction_id}/confirm:
$ref: paths/admin_products_import_{transaction_id}_confirm.yaml $ref: paths/admin_products_import_{transaction_id}_confirm.yaml
/admin/products/imports:
$ref: paths/admin_products_imports.yaml
/admin/products/imports/{transaction_id}/confirm:
$ref: paths/admin_products_imports_{transaction_id}_confirm.yaml
/admin/products/{id}: /admin/products/{id}:
$ref: paths/admin_products_{id}.yaml $ref: paths/admin_products_{id}.yaml
/admin/products/{id}/options: /admin/products/{id}/options:
@@ -1115,6 +1119,8 @@ paths:
$ref: paths/admin_transaction-groups.yaml $ref: paths/admin_transaction-groups.yaml
/admin/uploads: /admin/uploads:
$ref: paths/admin_uploads.yaml $ref: paths/admin_uploads.yaml
/admin/uploads/presigned-urls:
$ref: paths/admin_uploads_presigned-urls.yaml
/admin/uploads/{id}: /admin/uploads/{id}:
$ref: paths/admin_uploads_{id}.yaml $ref: paths/admin_uploads_{id}.yaml
/admin/users: /admin/users:
@@ -1222,6 +1222,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -57,6 +57,14 @@ get:
The field to sort the data by. By default, the sort order is The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name ascending. To change the order to descending, prefix the field name
with `-`. with `-`.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -984,6 +984,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -942,6 +942,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -107,6 +107,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -961,6 +961,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -4159,6 +4159,14 @@ get:
type: boolean type: boolean
title: has_account title: has_account
description: Filter by whether the customer is registered. description: Filter by whether the customer is registered.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -185,6 +185,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -1745,6 +1745,14 @@ get:
type: string type: string
title: customer_id title: customer_id
description: The customer id's details. description: The customer id's details.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -906,6 +906,14 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -102,6 +102,14 @@ get:
type: string type: string
title: stock_location_id title: stock_location_id
description: A stock location's ID. description: A stock location's ID.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -430,6 +430,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -86,6 +86,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -534,6 +534,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -117,6 +117,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -701,6 +701,14 @@ get:
type: string type: string
title: customer_id title: customer_id
description: The customer id's details. description: The customer id's details.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -536,6 +536,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -102,6 +102,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -409,6 +409,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -136,6 +136,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -643,6 +643,14 @@ get:
type: string type: string
title: name title: name
description: The name's details. description: The name's details.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -532,6 +532,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -532,6 +532,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -540,6 +540,56 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
- name: ean
in: query
required: false
schema:
oneOf:
- type: string
title: ean
description: The product variant's ean.
- type: array
description: The product variant's ean.
items:
type: string
title: ean
description: The ean's details.
- name: upc
in: query
required: false
schema:
oneOf:
- type: string
title: upc
description: The product variant's upc.
- type: array
description: The product variant's upc.
items:
type: string
title: upc
description: The upc's details.
- name: barcode
in: query
required: false
schema:
oneOf:
- type: string
title: barcode
description: The product variant's barcode.
- type: array
description: The product variant's barcode.
items:
type: string
title: barcode
description: The barcode's details.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -676,10 +676,6 @@ get:
description: Filter the retrieved products' variants. description: Filter the retrieved products' variants.
x-schemaName: AdminProductVariantParams x-schemaName: AdminProductVariantParams
properties: properties:
q:
type: string
title: q
description: Search term to apply on the variant's searchable properties.
id: id:
oneOf: oneOf:
- type: string - type: string
@@ -1183,6 +1179,39 @@ get:
items: items:
type: object type: object
title: $or title: $or
ean:
oneOf:
- type: string
title: ean
description: The variant's ean.
- type: array
description: The variant's ean.
items:
type: string
title: ean
description: The ean's details.
upc:
oneOf:
- type: string
title: upc
description: The variant's upc.
- type: array
description: The variant's upc.
items:
type: string
title: upc
description: The upc's details.
barcode:
oneOf:
- type: string
title: barcode
description: The variant's barcode.
- type: array
description: The variant's barcode.
items:
type: string
title: barcode
description: The barcode's details.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -83,3 +83,5 @@ post:
``` ```
description: Emitted when products are deleted. description: Emitted when products are deleted.
deprecated: false deprecated: false
deprecated: true
x-deprecated_message: use `POST /admin/products/imports` instead.
@@ -44,3 +44,5 @@ post:
$ref: ../components/responses/invalid_request_error.yaml $ref: ../components/responses/invalid_request_error.yaml
'500': '500':
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
deprecated: true
x-deprecated_message: use `POST /admin/products/imports/:transaction_id/confirm` instead.
@@ -0,0 +1,50 @@
post:
operationId: PostProductsImports
summary: Create Product Import
description: >-
Create a new product import process. The products aren't imported until the
import is confirmed with the `/admin/products/:transaction-id/imports` API
route.
x-authenticated: true
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminImportProducts.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK
source:
$ref: ../code_samples/JavaScript/admin_products_imports/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_products_imports/post.sh
tags:
- Products
responses:
'202':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminImportProductResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: importProductsAsChunksWorkflow
x-events: []
x-version: 2.8.5
@@ -0,0 +1,47 @@
post:
operationId: PostProductsImportsTransaction_idConfirm
summary: Confirm Product Import
description: >-
Confirm that a created product import should start importing the products
into Medusa.
x-authenticated: true
parameters:
- name: transaction_id
in: path
description: The product's transaction id.
required: true
schema:
type: string
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: JavaScript
label: JS SDK
source:
$ref: >-
../code_samples/JavaScript/admin_products_imports_{transaction_id}_confirm/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_products_imports_{transaction_id}_confirm/post.sh
tags:
- Products
responses:
'202':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
x-version: 2.8.5
@@ -128,6 +128,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -547,6 +547,56 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
- name: ean
in: query
required: false
schema:
oneOf:
- type: string
title: ean
description: The product's ean.
- type: array
description: The product's ean.
items:
type: string
title: ean
description: The ean's details.
- name: upc
in: query
required: false
schema:
oneOf:
- type: string
title: upc
description: The product's upc.
- type: array
description: The product's upc.
items:
type: string
title: upc
description: The upc's details.
- name: barcode
in: query
required: false
schema:
oneOf:
- type: string
title: barcode
description: The product's barcode.
- type: array
description: The product's barcode.
items:
type: string
title: barcode
description: The barcode's details.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -591,6 +591,14 @@ get:
type: string type: string
title: application_method_type title: application_method_type
description: An application method type. description: An application method type.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -82,6 +82,14 @@ get:
enum: enum:
- fixed - fixed
- percentage - percentage
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -107,6 +107,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -546,6 +546,14 @@ get:
type: string type: string
title: currency_code title: currency_code
description: The currency code's details. description: The currency code's details.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -606,6 +606,14 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -590,6 +590,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -699,6 +699,14 @@ get:
type: string type: string
title: customer_id title: customer_id
description: The customer id's details. description: The customer id's details.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -584,6 +584,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -602,6 +602,14 @@ get:
type: boolean type: boolean
title: admin_only title: admin_only
description: Filter by whether the shipping option is used by admin users only. description: Filter by whether the shipping option is used by admin users only.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -535,6 +535,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -562,6 +562,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -115,6 +115,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -112,6 +112,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -628,6 +628,14 @@ get:
description: >- description: >-
Filter by a shipping option type's ID to retrieve its associated tax Filter by a shipping option type's ID to retrieve its associated tax
rates. rates.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -1259,6 +1259,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -0,0 +1,48 @@
post:
operationId: PostUploadsPresignedUrls
summary: Get Presigned Upload URL
description: >-
Get a presigned URL for uploading a file to the configured File Module
Provider. The presigned URL can be used to upload files directly to the
third-party provider. This only works if your configured provider supports
presigned URLs, such as the S3 provider.
x-authenticated: true
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminUploadPreSignedUrl.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK
source:
$ref: ../code_samples/JavaScript/admin_uploads_presigned-urls/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_uploads_presigned-urls/post.sh
tags:
- Uploads
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminUploadPreSignedUrlResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
@@ -521,6 +521,14 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -94,6 +94,14 @@ get:
type: string type: string
title: q title: q
description: Search query to filter by a workflow execution's searchable fields. description: Search query to filter by a workflow execution's searchable fields.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -254,3 +255,7 @@ properties:
description: The draft order's credit lines. description: The draft order's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order's credit line total.
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -653,3 +654,7 @@ properties:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The draft order preview's credit line total.
@@ -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
@@ -40,6 +40,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -247,3 +248,7 @@ properties:
description: The order's credit lines. description: The order's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -42,6 +42,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -655,3 +656,7 @@ properties:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: ./OrderCreditLine.yaml $ref: ./OrderCreditLine.yaml
credit_line_total:
type: number
title: credit_line_total
description: The order preview's credit line total.
@@ -63,3 +63,9 @@ properties:
- draft - draft
- active - active
- inactive - 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,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
@@ -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.
@@ -39,6 +39,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -235,3 +236,7 @@ properties:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -24,6 +24,7 @@ required:
- discount_subtotal - discount_subtotal
- discount_total - discount_total
- discount_tax_total - discount_tax_total
- credit_line_total
- gift_card_total - gift_card_total
- gift_card_tax_total - gift_card_tax_total
- shipping_total - shipping_total
@@ -303,3 +304,7 @@ properties:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The date the order was deleted. description: The date the order was deleted.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -38,6 +38,7 @@ required:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
id: id:
type: string type: string
@@ -233,3 +234,7 @@ properties:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
@@ -134,7 +134,7 @@ required:
- deleted_at - deleted_at
- sku - sku
- barcode - barcode
- manage_inventory
- allow_backorder
- ean - ean
- upc - upc
- allow_backorder
- manage_inventory
@@ -2840,6 +2840,14 @@ paths:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -3094,6 +3102,14 @@ paths:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -3591,6 +3607,14 @@ paths:
type: string type: string
title: q title: q
description: Search term to filter the address's searchable properties. description: Search term to filter the address's searchable properties.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- cookie_auth: [] - cookie_auth: []
- jwt_token: [] - jwt_token: []
@@ -4787,6 +4811,14 @@ paths:
- completed - completed
- draft - draft
- archived - archived
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -5582,6 +5614,14 @@ paths:
type: string type: string
title: region_id title: region_id
description: Filter by a region ID. description: Filter by a region ID.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -6291,6 +6331,14 @@ paths:
type: string type: string
title: name title: name
description: A product category name. description: A product category name.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -7013,6 +7061,14 @@ paths:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -7677,6 +7733,14 @@ paths:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -8851,6 +8915,14 @@ paths:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -9064,6 +9136,14 @@ paths:
type: string type: string
title: order title: order
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -13539,6 +13619,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -13747,6 +13828,10 @@ components:
description: The draft order's credit lines. description: The draft order's credit lines.
items: items:
$ref: '#/components/schemas/OrderCreditLine' $ref: '#/components/schemas/OrderCreditLine'
credit_line_total:
type: number
title: credit_line_total
description: The draft order's credit line total.
AdminDraftOrderListResponse: AdminDraftOrderListResponse:
type: object type: object
description: The list of draft orders with pagination fields. description: The list of draft orders with pagination fields.
@@ -13822,6 +13907,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -14409,6 +14495,10 @@ components:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: '#/components/schemas/OrderCreditLine' $ref: '#/components/schemas/OrderCreditLine'
credit_line_total:
type: number
title: credit_line_total
description: The draft order preview's credit line total.
AdminDraftOrderPreviewResponse: AdminDraftOrderPreviewResponse:
type: object type: object
description: The details of the preview on the draft order. description: The details of the preview on the draft order.
@@ -15393,6 +15483,39 @@ components:
type: number type: number
title: toUpdate title: toUpdate
description: The number of products that will be updated by this import. description: The number of products that will be updated by this import.
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
AdminInventoryItem: AdminInventoryItem:
type: object type: object
description: The inventory item's details. description: The inventory item's details.
@@ -15759,6 +15882,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -15966,6 +16090,10 @@ components:
description: The order's credit lines. description: The order's credit lines.
items: items:
$ref: '#/components/schemas/OrderCreditLine' $ref: '#/components/schemas/OrderCreditLine'
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
AdminOrderAddress: AdminOrderAddress:
type: object type: object
description: An order address. description: An order address.
@@ -16697,6 +16825,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
return_requested_total: return_requested_total:
type: number type: number
@@ -17284,6 +17413,10 @@ components:
description: The order preview's credit lines. description: The order preview's credit lines.
items: items:
$ref: '#/components/schemas/OrderCreditLine' $ref: '#/components/schemas/OrderCreditLine'
credit_line_total:
type: number
title: credit_line_total
description: The order preview's credit line total.
AdminOrderPreviewResponse: AdminOrderPreviewResponse:
type: object type: object
description: The preview of an order. description: The preview of an order.
@@ -19988,6 +20121,10 @@ components:
- draft - draft
- active - active
- inactive - 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.
AdminPromotionResponse: AdminPromotionResponse:
type: object type: object
description: The promotion's details. description: The promotion's details.
@@ -23065,6 +23202,72 @@ components:
type: number type: number
title: required_quantity title: required_quantity
description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
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
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.
AdminUpsertStockLocationAddress: AdminUpsertStockLocationAddress:
type: object type: object
description: The details of the stock location address to create. description: The details of the stock location address to create.
@@ -24463,6 +24666,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
payment_collections: payment_collections:
type: array type: array
@@ -24659,6 +24863,10 @@ components:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
BaseOrderAddress: BaseOrderAddress:
type: object type: object
description: An order address. description: An order address.
@@ -27289,6 +27497,7 @@ components:
- discount_subtotal - discount_subtotal
- discount_total - discount_total
- discount_tax_total - discount_tax_total
- credit_line_total
- gift_card_total - gift_card_total
- gift_card_tax_total - gift_card_tax_total
- shipping_total - shipping_total
@@ -27564,6 +27773,10 @@ components:
format: date-time format: date-time
title: deleted_at title: deleted_at
description: The date the order was deleted. description: The date the order was deleted.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
OrderAddress: OrderAddress:
type: object type: object
description: The address's details. description: The address's details.
@@ -31000,6 +31213,7 @@ components:
- original_shipping_total - original_shipping_total
- original_shipping_subtotal - original_shipping_subtotal
- original_shipping_tax_total - original_shipping_tax_total
- credit_line_total
properties: properties:
id: id:
type: string type: string
@@ -31195,6 +31409,10 @@ components:
type: string type: string
title: status title: status
description: The order's status. description: The order's status.
credit_line_total:
type: number
title: credit_line_total
description: The order's credit line total.
StoreOrderAddress: StoreOrderAddress:
type: object type: object
description: An order address description: An order address
@@ -38005,10 +38223,10 @@ components:
- deleted_at - deleted_at
- sku - sku
- barcode - barcode
- manage_inventory
- allow_backorder
- ean - ean
- upc - upc
- allow_backorder
- manage_inventory
StoreRegion: StoreRegion:
type: object type: object
description: The region's details. description: The region's details.
@@ -671,6 +671,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -115,6 +115,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -132,6 +132,14 @@ get:
type: string type: string
title: q title: q
description: Search term to filter the address's searchable properties. description: Search term to filter the address's searchable properties.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security: security:
- cookie_auth: [] - cookie_auth: []
- jwt_token: [] - jwt_token: []
@@ -133,6 +133,14 @@ get:
- completed - completed
- draft - draft
- archived - archived
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -79,6 +79,14 @@ get:
type: string type: string
title: region_id title: region_id
description: Filter by a region ID. description: Filter by a region ID.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -752,6 +752,14 @@ get:
type: string type: string
title: name title: name
description: A product category name. description: A product category name.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -671,6 +671,14 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -668,6 +668,14 @@ get:
type: boolean type: boolean
title: $exists title: $exists
description: Filter by whether a value for this parameter exists (not `null`). description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -148,6 +148,14 @@ get:
items: items:
type: object type: object
title: $or title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: JavaScript - lang: JavaScript
label: JS SDK label: JS SDK
@@ -65,6 +65,14 @@ get:
The field to sort the data by. By default, the sort order is The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name ascending. To change the order to descending, prefix the field name
with `-`. with `-`.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples: x-codeSamples:
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -58,5 +58,6 @@
* x-workflow: deleteDraftOrdersWorkflow * x-workflow: deleteDraftOrdersWorkflow
* x-events: [] * x-events: []
* x-version: 2.8.4 * x-version: 2.8.4
*
*/ */
@@ -1050,6 +1050,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -45,6 +45,14 @@
* type: string * type: string
* title: order * title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -808,6 +808,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -808,6 +808,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -87,6 +87,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -823,6 +823,14 @@
* items: * items:
* type: object * type: object
* title: $or * title: $or
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -3331,6 +3331,14 @@
* type: boolean * type: boolean
* title: has_account * title: has_account
* description: Filter by whether the customer is registered. * description: Filter by whether the customer is registered.
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []

Some files were not shown because too many files have changed in this diff Show More