asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated API Reference (#4706)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin/paths/admin_apps.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
get:
operationId: GetApps
summary: List Applications
description: Retrieve a list of applications.
description: Retrieve a list of applications registered in the Medusa backend.
x-authenticated: true
x-codegen:
method: list
@@ -14,7 +14,7 @@ get:
- api_token: []
- cookie_auth: []
tags:
- Apps
- Apps Oauth
responses:
'200':
description: OK
docs/api/admin/paths/admin_apps_authorizations.yaml
+4 -2
View File
@@ -1,7 +1,9 @@
post:
operationId: PostApps
summary: Generate Token for App
description: Generates a token for an application.
description: >-
Use an app's Oauth provider to generate and store a new token for
authentication.
x-authenticated: true
requestBody:
content:
@@ -19,7 +21,7 @@ post:
- api_token: []
- cookie_auth: []
tags:
- Apps
- Apps Oauth
responses:
'200':
description: OK
docs/api/admin/paths/admin_auth.yaml
+12 -15
View File
@@ -2,7 +2,7 @@ get:
operationId: GetAuth
summary: Get Current User
x-authenticated: true
description: Gets the currently logged in User.
description: Get the currently logged in user's details.
x-codegen:
method: getSession
x-codeSamples:
@@ -42,23 +42,16 @@ post:
operationId: PostAuth
summary: User Login
x-authenticated: false
description: Logs a User in and authorizes them to manage Store settings.
parameters: []
description: >-
Log a User in and includes the Cookie session in the response header. The
cookie session can be used in subsequent requests to authorize the user to
perform admin functionalities. When using Medusa's JS or Medusa React
clients, the cookie is automatically attached to subsequent requests.
requestBody:
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
description: The User's email.
password:
type: string
description: The User's password.
$ref: ../components/schemas/AdminPostAuthReq.yaml
x-codegen:
method: createSession
x-codeSamples:
@@ -95,7 +88,11 @@ delete:
operationId: DeleteAuth
summary: User Logout
x-authenticated: true
description: Deletes the current session for the logged in user.
description: >-
Delete the current session for the logged in user. This will only work if
you're using Cookie session for authentication. If the API token is still
passed in the header, the user is still authorized to perform admin
functionalities in other endpoints.
x-codegen:
method: deleteSession
x-codeSamples:
docs/api/admin/paths/admin_batch-jobs.yaml
+24 -30
View File
@@ -1,18 +1,20 @@
get:
operationId: GetBatchJobs
summary: List Batch Jobs
description: Retrieve a list of Batch Jobs.
description: >-
Retrieve a list of Batch Jobs. The batch jobs can be filtered by fields such
as `type` or `confirmed_at`. The batch jobs can also be sorted or paginated.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of batch jobs to return.
description: Limit the number of batch jobs returned.
schema:
type: integer
default: 10
- in: query
name: offset
description: The number of batch jobs to skip before results.
description: The number of batch jobs to skip when retrieving the batch jobs.
schema:
type: integer
default: 0
@@ -42,9 +44,7 @@ get:
name: confirmed_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was confirmed, i.e. less
than, greater than etc.
description: Filter by a confirmation date range.
schema:
type: object
properties:
@@ -68,9 +68,7 @@ get:
name: pre_processed_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was pre processed, i.e.
less than, greater than etc.
description: Filter by a pre-processing date range.
schema:
type: object
properties:
@@ -94,9 +92,7 @@ get:
name: completed_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was completed, i.e. less
than, greater than etc.
description: Filter by a completion date range.
schema:
type: object
properties:
@@ -120,9 +116,7 @@ get:
name: failed_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was failed, i.e. less
than, greater than etc.
description: Filter by a failure date range.
schema:
type: object
properties:
@@ -146,9 +140,7 @@ get:
name: canceled_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was canceled, i.e. less
than, greater than etc.
description: Filter by a cancelation date range.
schema:
type: object
properties:
@@ -170,30 +162,28 @@ get:
format: date
- in: query
name: order
description: Field used to order retrieved batch jobs
description: A batch-job field to sort-order the retrieved batch jobs by.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each order of the
result.
Comma-separated relations that should be expanded in the returned batch
jobs.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each order of the
result.
Comma-separated fields that should be included in the returned batch
jobs.
schema:
type: string
- in: query
name: created_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was created, i.e. less
than, greater than etc.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -217,9 +207,7 @@ get:
name: updated_at
style: form
explode: false
description: >-
Date comparison for when resulting collections was updated, i.e. less
than, greater than etc.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -278,7 +266,13 @@ get:
post:
operationId: PostBatchJobs
summary: Create a Batch Job
description: Creates a Batch Job.
description: >-
Create a Batch Job to be executed asynchronously in the Medusa backend. If
`dry_run` is set to `true`, the batch job will not be executed until the it
is confirmed, which can be done using the Confirm Batch Job endpoint.
externalDocs:
description: How to create a batch job
url: https://docs.medusajs.com/development/batch-jobs/create#create-batch-job
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_batch-jobs_{id}.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
get:
operationId: GetBatchJobsBatchJob
summary: Get a Batch Job
description: Retrieves a Batch Job.
description: Retrieve the details of a batch job.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_batch-jobs_{id}_cancel.yaml
+3 -1
View File
@@ -1,7 +1,9 @@
post:
operationId: PostBatchJobsBatchJobCancel
summary: Cancel a Batch Job
description: Marks a batch job as canceled
description: >-
Mark a batch job as canceled. When a batch job is canceled, the processing
of the batch job doesn’t automatically stop.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_batch-jobs_{id}_confirm.yaml
+4 -1
View File
@@ -1,7 +1,10 @@
post:
operationId: PostBatchJobsBatchJobConfirmProcessing
summary: Confirm a Batch Job
description: Confirms that a previously requested batch job should be executed.
description: >-
When a batch job is created, it is not executed automatically if `dry_run`
is set to `true`. This endpoint confirms that the batch job should be
executed.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_collections.yaml
+15 -12
View File
@@ -1,7 +1,10 @@
get:
operationId: GetCollections
summary: List Collections
description: Retrieve a list of Product Collection.
description: >-
Retrieve a list of Product Collection. The product collections can be
filtered by fields such as `handle` or `title`. The collections can also be
sorted or paginated.
x-authenticated: true
parameters:
- in: query
@@ -12,33 +15,33 @@ get:
default: 10
- in: query
name: offset
description: The number of collections to skip before the results.
description: The number of collections to skip when retrieving the collections.
schema:
type: integer
default: 0
- in: query
name: title
description: The title of collections to return.
description: Filter collections by their title.
schema:
type: string
- in: query
name: handle
description: The handle of collections to return.
description: Filter collections by their handle.
schema:
type: string
- in: query
name: q
description: a search term to search titles and handles.
description: a term to search collections by their title or handle.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the product collections.
description: Filter collections by a discount condition ID associated with them.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting collections were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -60,7 +63,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting collections were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -82,7 +85,7 @@ get:
format: date
- in: query
name: deleted_at
description: Date comparison for when resulting collections were deleted.
description: Filter by a deletion date range.
schema:
type: object
properties:
@@ -118,7 +121,7 @@ get:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
@@ -141,7 +144,7 @@ get:
post:
operationId: PostCollections
summary: Create a Collection
description: Creates a Product Collection.
description: Create a Product Collection.
x-authenticated: true
requestBody:
content:
@@ -163,7 +166,7 @@ post:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
docs/api/admin/paths/admin_collections_{id}.yaml
+8 -6
View File
@@ -1,7 +1,9 @@
get:
operationId: GetCollectionsCollection
summary: Get a Collection
description: Retrieves a Product Collection.
description: >-
Retrieve a Product Collection by its ID. The products associated with it are
expanded and returned as well.
x-authenticated: true
parameters:
- in: path
@@ -25,7 +27,7 @@ get:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
@@ -48,7 +50,7 @@ get:
post:
operationId: PostCollectionsCollection
summary: Update a Collection
description: Updates a Product Collection.
description: Update a Product Collection's details.
x-authenticated: true
parameters:
- in: path
@@ -77,7 +79,7 @@ post:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
@@ -100,7 +102,7 @@ post:
delete:
operationId: DeleteCollectionsCollection
summary: Delete a Collection
description: Deletes a Product Collection.
description: Delete a Product Collection. This does not delete associated products.
x-authenticated: true
parameters:
- in: path
@@ -124,7 +126,7 @@ delete:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
docs/api/admin/paths/admin_collections_{id}_products_batch.yaml
+20 -8
View File
@@ -1,13 +1,13 @@
post:
operationId: PostProductsToCollection
summary: Update Products
description: Updates products associated with a Product Collection
summary: Add Products to Collection
description: Add products to a product collection.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Collection.
description: The ID of the product collection.
schema:
type: string
requestBody:
@@ -18,6 +18,11 @@ post:
x-codegen:
method: addProducts
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_collections_{id}_products_batch/post.js
- lang: Shell
label: cURL
source:
@@ -26,7 +31,7 @@ post:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
@@ -48,14 +53,16 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteProductsFromCollection
summary: Remove Product
description: Removes products associated with a Product Collection
summary: Remove Products from Collection
description: >-
Remove a list of products from a collection. This would not delete the
product, only the association between the product and the collection.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Collection.
description: The ID of the Product Collection.
schema:
type: string
requestBody:
@@ -66,6 +73,11 @@ delete:
x-codegen:
method: removeProducts
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_collections_{id}_products_batch/delete.js
- lang: Shell
label: cURL
source:
@@ -74,7 +86,7 @@ delete:
- api_token: []
- cookie_auth: []
tags:
- Collections
- Product Collections
responses:
'200':
description: OK
docs/api/admin/paths/admin_currencies.yaml
+9 -6
View File
@@ -1,33 +1,36 @@
get:
operationId: GetCurrencies
summary: List Currency
description: Retrieves a list of Currency
description: >-
Retrieve a list of currencies. The currencies can be filtered by fields such
as `code`. The currencies can also be sorted or paginated.
x-authenticated: true
parameters:
- in: query
name: code
description: Code of the currency to search for.
description: filter by currency code.
schema:
type: string
- in: query
name: includes_tax
description: Search for tax inclusive currencies.
description: filter currencies by whether they include taxes or not.
schema:
type: boolean
x-featureFlag: tax_inclusive_pricing
- in: query
name: order
description: order to retrieve products in.
description: A field to sort order the retrieved currencies by.
schema:
type: string
- in: query
name: offset
description: How many products to skip in the result.
description: The number of currencies to skip when retrieving the currencies.
schema:
type: number
default: '0'
- in: query
name: limit
description: Limit the number of products returned.
description: The number of currencies to return.
schema:
type: number
default: '20'
docs/api/admin/paths/admin_currencies_{code}.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
post:
operationId: PostCurrenciesCurrency
summary: Update a Currency
description: Update a Currency
description: Update a Currency's details.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_customer-groups.yaml
+18 -13
View File
@@ -1,28 +1,33 @@
get:
operationId: GetCustomerGroups
summary: List Customer Groups
description: Retrieve a list of customer groups.
description: >-
Retrieve a list of customer groups. The customer groups can be filtered by
fields such as `name` or `id. The customer groups can also be sorted or
paginated.
x-authenticated: true
parameters:
- in: query
name: q
description: Query used for searching customer group names.
description: term to search customer groups by name.
schema:
type: string
- in: query
name: offset
description: How many groups to skip in the result.
description: >-
The number of customer groups to skip when retrieving the customer
groups.
schema:
type: integer
default: 0
- in: query
name: order
description: the field used to order the customer groups.
description: A field to sort order the retrieved customer groups by.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the customer groups.
description: Filter by discount condition ID.
schema:
type: string
- in: query
@@ -35,7 +40,7 @@ get:
- type: string
description: customer group ID
- type: array
description: multiple customer group IDs
description: an array of customer group IDs
items:
type: string
- type: object
@@ -59,13 +64,13 @@ get:
description: Filter by the customer group name
schema:
type: array
description: multiple customer group names
description: an array of customer group names
items:
type: string
description: customer group name
- in: query
name: created_at
description: Date comparison for when resulting customer groups were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -87,7 +92,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting customer groups were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -109,15 +114,15 @@ get:
format: date
- in: query
name: limit
description: Limit the number of customer groups returned.
description: The number of customer groups to return.
schema:
type: integer
default: 10
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each customer
groups of the result.
Comma-separated relations that should be expanded in the returned
customer groups.
schema:
type: string
x-codegen:
@@ -159,7 +164,7 @@ get:
post:
operationId: PostCustomerGroups
summary: Create a Customer Group
description: Creates a CustomerGroup.
description: Creates a Customer Group.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_customer-groups_{id}.yaml
+13 -5
View File
@@ -1,7 +1,9 @@
get:
operationId: GetCustomerGroupsGroup
summary: Get a Customer Group
description: Retrieves a Customer Group.
description: >-
Retrieve a Customer Group by its ID. You can expand the customer group's
relations or select the fields that should be returned.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +14,16 @@ get:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the customer group.
description: >-
Comma-separated relations that should be expanded in the returned
customer group.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be included in the customer group.
description: >-
Comma-separated fields that should be included in the returned customer
group.
schema:
type: string
x-codegen:
@@ -59,7 +65,7 @@ get:
post:
operationId: PostCustomerGroupsGroup
summary: Update a Customer Group
description: Update a CustomerGroup.
description: Update a Customer Group's details.
x-authenticated: true
parameters:
- in: path
@@ -111,7 +117,9 @@ post:
delete:
operationId: DeleteCustomerGroupsCustomerGroup
summary: Delete a Customer Group
description: Deletes a CustomerGroup.
description: >-
Delete a customer group. This doesn't delete the customers associated with
the customer group.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_customer-groups_{id}_customers.yaml
+9 -5
View File
@@ -1,7 +1,9 @@
get:
operationId: GetCustomerGroupsGroupCustomers
summary: List Customers
description: Retrieves a list of customers in a customer group
description: >-
Retrieve a list of customers in a customer group. The customers can be
filtered by the `q` field. The customers can also be paginated.
x-authenticated: true
parameters:
- in: path
@@ -12,24 +14,26 @@ get:
type: string
- in: query
name: limit
description: The number of items to return.
description: The number of customers to return.
schema:
type: integer
default: 50
- in: query
name: offset
description: The items to skip before result.
description: The number of customers to skip when retrieving the customers.
schema:
type: integer
default: 0
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in each customer.
description: >-
Comma-separated relations that should be expanded in the returned
customers.
schema:
type: string
- in: query
name: q
description: a search term to search email, first_name, and last_name.
description: a term to search customers by email, first_name, and last_name.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_customer-groups_{id}_customers_batch.yaml
+6 -4
View File
@@ -1,7 +1,7 @@
post:
operationId: PostCustomerGroupsGroupCustomersBatch
summary: Add Customers
description: Adds a list of customers, represented by id's, to a customer group.
summary: Add Customers to Group
description: Add a list of customers to a customer group.
x-authenticated: true
parameters:
- in: path
@@ -55,8 +55,10 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteCustomerGroupsGroupCustomerBatch
summary: Remove Customers
description: Removes a list of customers, represented by id's, from a customer group.
summary: Remove Customers from Group
description: >-
Remove a list of customers from a customer group. This doesn't delete the
customer, only the association between the customer and the customer group.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_customers.yaml
+19 -6
View File
@@ -1,31 +1,44 @@
get:
operationId: GetCustomers
summary: List Customers
description: Retrieves a list of Customers.
description: >-
Retrieve a list of Customers. The customers can be filtered by fields such
as `q` or `groups`. The customers can also be paginated.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of items to return.
description: The number of customers to return.
schema:
type: integer
default: 50
- in: query
name: offset
description: The items to skip before result.
description: The number of customers to skip when retrieving the customers.
schema:
type: integer
default: 0
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in each customer.
description: >-
Comma-separated relations that should be expanded in the returned
customer.
schema:
type: string
- in: query
name: q
description: a search term to search email, first_name, and last_name.
description: term to search customers' email, first_name, and last_name fields.
schema:
type: string
- in: query
name: groups
style: form
explode: false
description: Filter by customer group IDs.
schema:
type: array
items:
type: string
x-codegen:
method: list
queryParams: AdminGetCustomersParams
@@ -65,7 +78,7 @@ get:
post:
operationId: PostCustomers
summary: Create a Customer
description: Creates a Customer.
description: Allow admins to create a customer.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_customers_{id}.yaml
+12 -6
View File
@@ -1,7 +1,7 @@
get:
operationId: GetCustomersCustomer
summary: Get a Customer
description: Retrieves a Customer.
description: Retrieve the details of a customer.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,14 @@ get:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the customer.
description: >-
Comma-separated relations that should be expanded in the returned
customer.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be included in the customer.
description: Comma-separated fields that should be included in the returned customer.
schema:
type: string
x-codegen:
@@ -58,7 +60,7 @@ get:
post:
operationId: PostCustomersCustomer
summary: Update a Customer
description: Updates a Customer.
description: Update a Customer's details.
x-authenticated: true
parameters:
- in: path
@@ -69,12 +71,16 @@ post:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in each customer.
description: >-
Comma-separated relations that should be expanded in the returned
customer.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be retrieved in each customer.
description: >-
Comma-separated fields that should be retrieved in the returned
customer.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_discounts.yaml
+23 -20
View File
@@ -2,16 +2,18 @@ get:
operationId: GetDiscounts
summary: List Discounts
x-authenticated: true
description: Retrieves a list of Discounts
description: >-
Retrieve a list of Discounts. The discounts can be filtered by fields such
as `rule` or `is_dynamic`. The discounts can also be paginated.
parameters:
- in: query
name: q
description: Search query applied on the code field.
description: term to search discounts' code field.
schema:
type: string
- in: query
name: rule
description: Discount Rules filters to apply on the search
description: Filter discounts by rule fields.
schema:
type: object
properties:
@@ -21,43 +23,40 @@ get:
- fixed
- percentage
- free_shipping
description: >-
The type of the Discount, can be `fixed` for discounts that reduce
the price by a fixed amount, `percentage` for percentage
reductions or `free_shipping` for shipping vouchers.
description: Filter discounts by type.
allocation:
type: string
enum:
- total
- item
description: >-
The value that the discount represents; this will depend on the
type of the discount
description: Filter discounts by allocation type.
- in: query
name: is_dynamic
description: Return only dynamic discounts.
description: Filter discounts by whether they're dynamic or not.
schema:
type: boolean
- in: query
name: is_disabled
description: Return only disabled discounts.
description: Filter discounts by whether they're disabled or not.
schema:
type: boolean
- in: query
name: limit
description: The number of items in the response
description: The number of discounts to return
schema:
type: number
default: '20'
- in: query
name: offset
description: The offset of items in response
description: The number of discounts to skip when retrieving the discounts.
schema:
type: number
default: '0'
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned
discount.
schema:
type: string
x-codegen:
@@ -98,20 +97,24 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostDiscounts
summary: Creates a Discount
summary: Create a Discount
x-authenticated: true
description: >-
Creates a Discount with a given set of rules that define how the Discount
behaves.
Create a Discount with a given set of rules that defines how the Discount is
applied.
parameters:
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the results.
description: >-
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be retrieved in the results.
description: >-
Comma-separated fields that should be retrieved in the returned
discount.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_discounts_code_{code}.yaml
+5 -3
View File
@@ -1,7 +1,7 @@
get:
operationId: GetDiscountsDiscountCode
summary: Get Discount by Code
description: Retrieves a Discount by its discount code
description: Retrieve a Discount's details by its discount code
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,14 @@ get:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_discounts_{discount_id}_conditions.yaml
+8 -8
View File
@@ -2,29 +2,29 @@ post:
operationId: PostDiscountsDiscountConditions
summary: Create a Condition
description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`,
Create a Discount Condition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
provided, based on the type of discount condition. For example, if the
discount condition's type is `products`, the `products` field should be
provided in the request body.
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Product.
description: The ID of the discount.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each product of the
result.
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each product of the
result.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml
+25 -17
View File
@@ -1,7 +1,7 @@
get:
operationId: GetDiscountsDiscountConditionsCondition
summary: Get a Condition
description: Gets a DiscountCondition
description: Retrieve a Discount Condition's details.
x-authenticated: true
parameters:
- in: path
@@ -13,17 +13,21 @@ get:
- in: path
name: condition_id
required: true
description: The ID of the DiscountCondition.
description: The ID of the Discount Condition.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
discount condition.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned discount
condition.
schema:
type: string
x-codegen:
@@ -68,35 +72,35 @@ post:
operationId: PostDiscountsDiscountConditionsCondition
summary: Update a Condition
description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`,
Update a Discount Condition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
provided, based on the type of discount condition. For example, if the
discount condition's type is `products`, the `products` field should be
provided in the request body.
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Product.
description: The ID of the Discount.
schema:
type: string
- in: path
name: condition_id
required: true
description: The ID of the DiscountCondition.
description: The ID of the Discount Condition.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each item of the
result.
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each item of the
result.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
requestBody:
@@ -146,7 +150,9 @@ post:
delete:
operationId: DeleteDiscountsDiscountConditionsCondition
summary: Delete a Condition
description: Deletes a DiscountCondition
description: >-
Deletes a Discount Condition. This does not delete resources associated to
the discount condition.
x-authenticated: true
parameters:
- in: path
@@ -158,17 +164,19 @@ delete:
- in: path
name: condition_id
required: true
description: The ID of the DiscountCondition
description: The ID of the Discount Condition
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml
+20 -17
View File
@@ -1,33 +1,35 @@
post:
operationId: PostDiscountsDiscountConditionsConditionBatch
summary: Add Batch Resources
description: Add a batch of resources to a discount condition.
description: >-
Add a batch of resources to a discount condition. The type of resource
depends on the type of discount condition. For example, if the discount
condition's type is `products`, the resources being added should be
products.
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Product.
description: The ID of the discount the condition belongs to.
schema:
type: string
- in: path
name: condition_id
required: true
description: The ID of the condition on which to add the item.
description: The ID of the discount condition on which to add the item.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which relations should be expanded in each discount of
the result.
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each discount of
the result.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
requestBody:
@@ -76,34 +78,35 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteDiscountsDiscountConditionsConditionBatch
summary: Delete Batch Resources
description: Delete a batch of resources from a discount condition.
summary: Remove Batch Resources
description: >-
Remove a batch of resources from a discount condition. This will only remove
the association between the resource and the discount condition, but not the
resource itself.
x-authenticated: true
parameters:
- in: path
name: discount_id
required: true
description: The ID of the Product.
description: The ID of the discount.
schema:
type: string
- in: path
name: condition_id
required: true
description: The ID of the condition on which to add the item.
description: The ID of the condition to remove the resources from.
schema:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which relations should be expanded in each discount of
the result.
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each discount of
the result.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_discounts_{id}.yaml
+13 -9
View File
@@ -12,12 +12,14 @@ get:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: Comma-separated fields that should be included in the returned discount.
schema:
type: string
x-codegen:
@@ -60,8 +62,8 @@ post:
operationId: PostDiscountsDiscount
summary: Update a Discount
description: >-
Updates a Discount with a given set of rules that define how the Discount
behaves.
Update a Discount with a given set of rules that define how the Discount is
applied.
x-authenticated: true
parameters:
- in: path
@@ -73,15 +75,15 @@ post:
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each item of the
result.
Comma-separated relations that should be expanded in the returned
discount.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each item of the
result.
Comma-separated fields that should be retrieved in the returned
discount.
schema:
type: string
requestBody:
@@ -128,7 +130,9 @@ post:
delete:
operationId: DeleteDiscountsDiscount
summary: Delete a Discount
description: Deletes a Discount.
description: >-
Delete a Discount. Deleting the discount will make it unavailable for
customers to use.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_discounts_{id}_dynamic-codes.yaml
+4 -3
View File
@@ -2,14 +2,15 @@ post:
operationId: PostDiscountsDiscountDynamicCodes
summary: Create a Dynamic Code
description: >-
Creates a dynamic unique code that can map to a parent Discount. This is
useful if you want to automatically generate codes with the same behaviour.
Create a dynamic unique code that can map to a parent Discount. This is
useful if you want to automatically generate codes with the same rules and
conditions.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Discount to create the dynamic code from."
description: The ID of the Discount to create the dynamic code for."
schema:
type: string
requestBody:
docs/api/admin/paths/admin_discounts_{id}_dynamic-codes_{code}.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
delete:
operationId: DeleteDiscountsDiscountDynamicCodesCode
summary: Delete a Dynamic Code
description: Deletes a dynamic code from a Discount.
description: Delete a dynamic code from a Discount.
x-authenticated: true
parameters:
- in: path
@@ -13,7 +13,7 @@ delete:
- in: path
name: code
required: true
description: The ID of the Discount
description: The dynamic code to delete
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_discounts_{id}_regions_{region_id}.yaml
+6 -3
View File
@@ -1,7 +1,7 @@
post:
operationId: PostDiscountsDiscountRegionsRegion
summary: Add Region
description: Adds a Region to the list of Regions that a Discount can be used in.
summary: Add Region to Discount
description: Add a Region to the list of Regions a Discount can be used in.
x-authenticated: true
parameters:
- in: path
@@ -56,7 +56,10 @@ delete:
operationId: DeleteDiscountsDiscountRegionsRegion
summary: Remove Region
x-authenticated: true
description: Removes a Region from the list of Regions that a Discount can be used in.
description: >-
Remove a Region from the list of Regions that a Discount can be used in.
This does not delete a region, only the association between it and the
discount.
parameters:
- in: path
name: id
docs/api/admin/paths/admin_draft-orders.yaml
+10 -6
View File
@@ -1,26 +1,28 @@
get:
operationId: GetDraftOrders
summary: List Draft Orders
description: Retrieves an list of Draft Orders
description: >-
Retrieve an list of Draft Orders. The draft orders can be filtered by fields
such as `q`. The draft orders can also paginated.
x-authenticated: true
parameters:
- in: query
name: offset
description: The number of items to skip before the results.
description: The number of draft orders to skip when retrieving the draft orders.
schema:
type: number
default: '0'
- in: query
name: limit
description: Limit the number of items returned.
description: Limit the number of draft orders returned.
schema:
type: number
default: '50'
- in: query
name: q
description: >-
a search term to search emails in carts associated with draft orders and
display IDs of draft orders
a term to search draft orders' display IDs and emails in the draft
order's cart
schema:
type: string
x-codegen:
@@ -62,7 +64,9 @@ get:
post:
operationId: PostDraftOrders
summary: Create a Draft Order
description: Creates a Draft Order
description: >-
Create a Draft Order. A draft order is not transformed into an order until
payment is captured.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_draft-orders_{id}.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
get:
operationId: GetDraftOrdersDraftOrder
summary: Get a Draft Order
description: Retrieves a Draft Order.
description: Retrieve a Draft Order's details.
x-authenticated: true
parameters:
- in: path
@@ -48,7 +48,7 @@ get:
post:
operationId: PostDraftOrdersDraftOrder
summary: Update a Draft Order
description: Updates a Draft Order.
description: Update a Draft Order's details.
x-authenticated: true
parameters:
- in: path
@@ -100,7 +100,7 @@ post:
delete:
operationId: DeleteDraftOrdersDraftOrder
summary: Delete a Draft Order
description: Deletes a Draft Order
description: Delete a Draft Order
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_draft-orders_{id}_line-items.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
post:
operationId: PostDraftOrdersDraftOrderLineItems
summary: Create a Line Item
description: Creates a Line Item for the Draft Order
description: Create a Line Item in the Draft Order.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
post:
operationId: PostDraftOrdersDraftOrderLineItemsItem
summary: Update a Line Item
description: Updates a Line Item for a Draft Order
description: Update a Line Item in a Draft Order
x-authenticated: true
parameters:
- in: path
@@ -62,7 +62,7 @@ post:
delete:
operationId: DeleteDraftOrdersDraftOrderLineItemsItem
summary: Delete a Line Item
description: Removes a Line Item from a Draft Order.
description: Deletes a Line Item from a Draft Order.
x-authenticated: true
parameters:
- in: path
@@ -74,7 +74,7 @@ delete:
- in: path
name: line_id
required: true
description: The ID of the Draft Order.
description: The ID of the line item.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_draft-orders_{id}_pay.yaml
+8 -3
View File
@@ -1,13 +1,18 @@
post:
summary: Registers a Payment
summary: Mark Paid
operationId: PostDraftOrdersDraftOrderRegisterPayment
description: Registers a payment for a Draft Order.
description: >-
Capture the draft order's payment. This will also set the draft order's
status to `completed` and create an Order from the draft order. The payment
is captured through Medusa's system payment, which is manual payment that
isn't integrated with any third-party payment provider. It is assumed that
the payment capturing is handled manually by the admin.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The Draft Order id.
description: The Draft Order ID.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_gift-cards.yaml
+7 -5
View File
@@ -1,24 +1,26 @@
get:
operationId: GetGiftCards
summary: List Gift Cards
description: Retrieves a list of Gift Cards.
description: >-
Retrieve a list of Gift Cards. The gift cards can be filtered by fields such
as `q`. The gift cards can also paginated.
x-authenticated: true
parameters:
- in: query
name: offset
description: The number of items to skip before the results.
description: The number of gift cards to skip when retrieving the gift cards.
schema:
type: number
default: '0'
- in: query
name: limit
description: Limit the number of items returned.
description: Limit the number of gift cards returned.
schema:
type: number
default: '50'
- in: query
name: q
description: a search term to search by code or display ID
description: a term to search gift cards' code or display ID
schema:
type: string
x-codegen:
@@ -61,7 +63,7 @@ post:
operationId: PostGiftCards
summary: Create a Gift Card
description: >-
Creates a Gift Card that can redeemed by its unique code. The Gift Card is
Create a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region.
x-authenticated: true
requestBody:
docs/api/admin/paths/admin_gift-cards_{id}.yaml
+3 -5
View File
@@ -1,7 +1,7 @@
get:
operationId: GetGiftCardsGiftCard
summary: Get a Gift Card
description: Retrieves a Gift Card.
description: Retrieve a Gift Card's details.
x-authenticated: true
parameters:
- in: path
@@ -48,9 +48,7 @@ get:
post:
operationId: PostGiftCardsGiftCard
summary: Update a Gift Card
description: >-
Update a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region.
description: Update a Gift Card's details.
x-authenticated: true
parameters:
- in: path
@@ -102,7 +100,7 @@ post:
delete:
operationId: DeleteGiftCardsGiftCard
summary: Delete a Gift Card
description: Deletes a Gift Card
description: Delete a Gift Card. Once deleted, it can't be used by customers.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_inventory-items.yaml
+41 -22
View File
@@ -2,13 +2,16 @@ get:
operationId: GetInventoryItems
summary: List Inventory Items
description: >-
Lists inventory items with the ability to apply filters or search queries on
them.
Retrieve a list of inventory items. The inventory items can be filtered by
fields such as `q` or `location_id`. The inventory items can also be
paginated.
x-authenticated: true
parameters:
- in: query
name: offset
description: How many inventory items to skip in the result.
description: >-
The number of inventory items to skip when retrieving the inventory
items.
schema:
type: integer
default: 0
@@ -20,81 +23,93 @@ get:
default: 20
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
- in: query
name: q
description: Query used for searching product inventory items and their properties.
description: term to search inventory item's sku, title, and description.
schema:
type: string
- in: query
name: location_id
style: form
explode: false
description: Locations ids to search for.
description: Filter by location IDs.
schema:
type: array
items:
type: string
- in: query
name: id
description: id to search for.
style: form
explode: false
description: Filter by the inventory ID
schema:
type: string
oneOf:
- type: string
description: inventory ID
- type: array
description: an array of inventory IDs
items:
type: string
- in: query
name: sku
description: sku to search for.
description: Filter by SKU
schema:
type: string
- in: query
name: origin_country
description: origin_country to search for.
description: Filter by origin country
schema:
type: string
- in: query
name: mid_code
description: mid_code to search for.
description: Filter by MID code
schema:
type: string
- in: query
name: material
description: material to search for.
description: Filter by material
schema:
type: string
- in: query
name: hs_code
description: hs_code to search for.
description: Filter by HS Code
schema:
type: string
- in: query
name: weight
description: weight to search for.
description: Filter by weight
schema:
type: string
- in: query
name: length
description: length to search for.
description: Filter by length
schema:
type: string
- in: query
name: height
description: height to search for.
description: Filter by height
schema:
type: string
- in: query
name: width
description: width to search for.
description: Filter by width
schema:
type: string
- in: query
name: requires_shipping
description: requires_shipping to search for.
description: Filter by whether the item requires shipping
schema:
type: string
x-codegen:
@@ -137,17 +152,21 @@ get:
post:
operationId: PostInventoryItems
summary: Create an Inventory Item
description: Creates an Inventory Item.
description: Create an Inventory Item.
x-authenticated: true
parameters:
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_inventory-items_{id}.yaml
+17 -7
View File
@@ -1,7 +1,7 @@
get:
operationId: GetInventoryItemsInventoryItem
summary: Get an Inventory Item
description: Retrieves an Inventory Item.
description: Retrieve an Inventory Item's details.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,16 @@ get:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
x-codegen:
@@ -59,7 +63,7 @@ get:
post:
operationId: PostInventoryItemsInventoryItem
summary: Update an Inventory Item
description: Updates an Inventory Item.
description: Update an Inventory Item's details.
x-authenticated: true
parameters:
- in: path
@@ -70,12 +74,16 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory level.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
level.
schema:
type: string
requestBody:
@@ -122,7 +130,9 @@ post:
delete:
operationId: DeleteInventoryItemsInventoryItem
summary: Delete an Inventory Item
description: Delete an Inventory Item
description: >-
Delete an Inventory Item. This does not delete the associated product
variant.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+20 -9
View File
@@ -1,32 +1,39 @@
get:
operationId: GetInventoryItemsInventoryItemLocationLevels
summary: List Inventory Levels
description: Lists inventory levels of an inventory item.
summary: List Inventory Level
description: >-
Retrieve a list of inventory levels of an inventory item. The inventory
levels can be filtered by fields such as `location_id`. The inventory levels
can also be paginated.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Inventory Item.
description: The ID of the Inventory Item the locations are associated with.
schema:
type: string
- in: query
name: location_id
style: form
explode: false
description: Locations ids to search for.
description: Filter by location IDs.
schema:
type: array
items:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory levels.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
levels.
schema:
type: string
x-codegen:
@@ -70,7 +77,7 @@ get:
post:
operationId: PostInventoryItemsInventoryItemLocationLevels
summary: Create an Inventory Level
description: Creates an Inventory Level for a given Inventory Item.
description: Create an Inventory Level for a given Inventory Item.
x-authenticated: true
parameters:
- in: path
@@ -81,12 +88,16 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+9 -5
View File
@@ -1,29 +1,33 @@
post:
operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel
summary: Update an Inventory Level
description: Updates an Inventory Level for a given Inventory Item.
description: Update an Inventory Level's details for a given Inventory Item.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Inventory Item.
description: The ID of the Inventory Item that the location is associated with.
schema:
type: string
- in: path
name: location_id
required: true
description: The ID of the Location.
description: The ID of the Location to update.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory level.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
level.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_invites.yaml
+6 -2
View File
@@ -1,7 +1,7 @@
get:
operationId: GetInvites
summary: Lists Invites
description: Lists all Invites
description: Retrieve a list of invites.
x-authenticated: true
x-codegen:
method: list
@@ -41,7 +41,11 @@ get:
post:
operationId: PostInvites
summary: Create an Invite
description: Creates an Invite and triggers an 'invite' created event
description: >-
Create an Invite. This will generate a token associated with the invite and
trigger an `invite.created` event. If you have a Notification Provider
installed that handles this event, a notification should be sent to the
email associated with the invite to allow them to accept the invite.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_invites_accept.yaml
+5 -1
View File
@@ -1,7 +1,11 @@
post:
operationId: PostInvitesInviteAccept
summary: Accept an Invite
description: Accepts an Invite and creates a corresponding user
description: >-
Accept an Invite. This will also delete the invite and create a new user
that can log in and perform admin functionalities. The user will have the
email associated with the invite, and the password provided in the request
body.
requestBody:
content:
application/json:
docs/api/admin/paths/admin_invites_{invite_id}.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
delete:
operationId: DeleteInvitesInvite
summary: Delete an Invite
description: Deletes an Invite
description: Delete an Invite. Only invites that weren't accepted can be deleted.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_invites_{invite_id}_resend.yaml
+6 -1
View File
@@ -1,7 +1,12 @@
post:
operationId: PostInvitesInviteResend
summary: Resend an Invite
description: Resends an Invite by triggering the 'invite' created event again
description: >-
Resend an Invite. This renews the expiry date by 7 days and generates a new
token for the invite. It also triggers the `invite.created` event, so if you
have a Notification Provider installed that handles this event, a
notification should be sent to the email associated with the invite to allow
them to accept the invite.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_notes.yaml
+8 -6
View File
@@ -2,23 +2,25 @@ get:
operationId: GetNotes
summary: List Notes
x-authenticated: true
description: Retrieves a list of notes
description: >-
Retrieve a list of notes. The notes can be filtered by fields such as
`resource_id`. The notes can also be paginated.
parameters:
- in: query
name: limit
description: The number of notes to get
description: Limit the number of notes returned.
schema:
type: number
default: '50'
- in: query
name: offset
description: The offset at which to get notes
description: The number of notes to skip when retrieving the notes.
schema:
type: number
default: '0'
- in: query
name: resource_id
description: The ID which the notes belongs to
description: Filter by resource ID
schema:
type: string
x-codegen:
@@ -59,8 +61,8 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostNotes
summary: Creates a Note
description: Creates a Note which can be associated with any resource as required.
summary: Create a Note
description: Create a Note which can be associated with any resource.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_notes_{id}.yaml
+5 -5
View File
@@ -1,13 +1,13 @@
get:
operationId: GetNotesNote
summary: Get a Note
description: Retrieves a single note using its id
description: Retrieve a note's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the note to retrieve.
description: The ID of the note.
schema:
type: string
x-codegen:
@@ -49,12 +49,12 @@ post:
operationId: PostNotesNote
summary: Update a Note
x-authenticated: true
description: Updates a Note associated with some resource
description: Update a Note's details.'
parameters:
- in: path
name: id
required: true
description: The ID of the Note to update
description: The ID of the Note
schema:
type: string
requestBody:
@@ -100,7 +100,7 @@ post:
delete:
operationId: DeleteNotesNote
summary: Delete a Note
description: Deletes a Note.
description: Delete a Note.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_notifications.yaml
+21 -11
View File
@@ -1,53 +1,63 @@
get:
operationId: GetNotifications
summary: List Notifications
description: Retrieves a list of Notifications.
description: >-
Retrieve a list of notifications. The notifications can be filtered by
fields such as `event_name` or `resource_type`. The notifications can also
be paginated.
x-authenticated: true
parameters:
- in: query
name: offset
description: >-
The number of notifications to skip before starting to collect the
notifications set
The number of inventory items to skip when retrieving the inventory
items.
schema:
type: integer
default: 0
- in: query
name: limit
description: The number of notifications to return
description: Limit the number of notifications returned.
schema:
type: integer
default: 50
- in: query
name: fields
description: Comma separated fields to include in the result set
description: >-
Comma-separated fields that should be included in each returned
notification.
schema:
type: string
- in: query
name: expand
description: Comma separated fields to populate
description: >-
Comma-separated relations that should be expanded in each returned
notification.
schema:
type: string
- in: query
name: event_name
description: The name of the event that the notification was sent for.
description: >-
Filter by the name of the event that triggered sending this
notification.
schema:
type: string
- in: query
name: resource_type
description: The type of resource that the Notification refers to.
description: Filter by the resource type.
schema:
type: string
- in: query
name: resource_id
description: The ID of the resource that the Notification refers to.
description: Filter by the resource ID.
schema:
type: string
- in: query
name: to
description: >-
The address that the Notification was sent to. This will usually be an
email address, but represent other addresses such as a chat bot user id
Filter by the address that the Notification was sent to. This will
usually be an email address, but it can also represent other addresses
such as a chat bot user id.
schema:
type: string
- in: query
docs/api/admin/paths/admin_notifications_{id}_resend.yaml
+2 -2
View File
@@ -2,8 +2,8 @@ post:
operationId: PostNotificationsNotificationResend
summary: Resend Notification
description: >-
Resends a previously sent notifications, with the same data but optionally
to a different address
Resend a previously sent notifications, with the same data but optionally to
a different address.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_order-edits.yaml
+15 -9
View File
@@ -1,39 +1,45 @@
get:
operationId: GetOrderEdits
summary: List OrderEdits
description: List OrderEdits.
summary: List Order Edits
description: >-
Retrieve a list of order edits. The order edits can be filtered by fields
such as `q` or `order_id`. The order edits can also be paginated.
x-authenticated: true
parameters:
- in: query
name: q
description: Query used for searching order edit internal note.
description: term to search order edits' internal note.
schema:
type: string
- in: query
name: order_id
description: List order edits by order id.
description: Filter by order ID
schema:
type: string
- in: query
name: limit
description: The number of items in the response
description: Limit the number of order edits returned.
schema:
type: number
default: '20'
- in: query
name: offset
description: The offset of items in response
description: The number of order edits to skip when retrieving the order edits.
schema:
type: number
default: '0'
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned order
edit.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in each returned order
edit.
schema:
type: string
x-codegen:
@@ -75,7 +81,7 @@ get:
post:
operationId: PostOrderEdits
summary: Create an OrderEdit
description: Creates an OrderEdit.
description: Create an Order Edit.
requestBody:
content:
application/json:
docs/api/admin/paths/admin_order-edits_{id}.yaml
+13 -7
View File
@@ -1,7 +1,7 @@
get:
operationId: GetOrderEditsOrderEdit
summary: Get an OrderEdit
description: Retrieves a OrderEdit.
summary: Get an Order Edit
description: Retrieve an Order Edit's details.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,16 @@ get:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned order
edit.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned order
edit.
schema:
type: string
x-codegen:
@@ -58,8 +62,8 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostOrderEditsOrderEdit
summary: Update an OrderEdit
description: Updates a OrderEdit.
summary: Update an Order Edit
description: Updates an Order Edit's details.
x-authenticated: true
parameters:
- in: path
@@ -111,7 +115,9 @@ post:
delete:
operationId: DeleteOrderEditsOrderEdit
summary: Delete an Order Edit
description: Delete an Order Edit
description: >-
Delete an Order Edit. Only order edits that have the status `created` can be
deleted.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_order-edits_{id}_cancel.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrderEditsOrderEditCancel
summary: Cancel an OrderEdit
description: Cancels an OrderEdit.
summary: Cancel an Order Edit
description: Cancel an OrderEdit.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_order-edits_{id}_changes_{change_id}.yaml
+5 -3
View File
@@ -1,19 +1,21 @@
delete:
operationId: DeleteOrderEditsOrderEditItemChange
summary: Delete a Line Item Change
description: Deletes an Order Edit Item Change
description: >-
Delete a line item change that indicates the addition, deletion, or update
of a line item in the original order.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to delete.
description: The ID of the Order Edit.
schema:
type: string
- in: path
name: change_id
required: true
description: The ID of the Order Edit Item Change to delete.
description: The ID of the Line Item Change to delete.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_order-edits_{id}_confirm.yaml
+4 -2
View File
@@ -1,7 +1,9 @@
post:
operationId: PostOrderEditsOrderEditConfirm
summary: Confirms an OrderEdit
description: Confirms an OrderEdit.
summary: Confirm an OrderEdit
description: >-
Confirm an Order Edit. This will reflect the changes in the order edit on
the associated order.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_order-edits_{id}_items.yaml
+4 -1
View File
@@ -1,7 +1,10 @@
post:
operationId: PostOrderEditsEditLineItems
summary: Add a Line Item
description: Create an OrderEdit LineItem.
description: >-
Create a line item change in the order edit that indicates adding an item in
the original order. The item will not be added to the original order until
the order edit is confirmed.
parameters:
- in: path
name: id
docs/api/admin/paths/admin_order-edits_{id}_items_{item_id}.yaml
+14 -7
View File
@@ -1,19 +1,23 @@
post:
operationId: PostOrderEditsEditLineItemsLineItem
summary: Upsert Line Item Change
description: Create or update the order edit change holding the line item changes
description: >-
Create or update a line item change in the order edit that indicates
addition, deletion, or update of a line item into an original order. Line
item changes are only reflected on the original order after the order edit
is confirmed.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to update.
description: The ID of the Order Edit.
schema:
type: string
- in: path
name: item_id
required: true
description: The ID of the order edit item to update.
description: The ID of the line item in the original order.
schema:
type: string
requestBody:
@@ -60,20 +64,23 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeleteOrderEditsOrderEditLineItemsLineItem
summary: Delete a Line Item
description: Delete line items from an order edit and create change item
summary: Delete Line Item
description: >-
Create a line item change in the order edit that indicates deleting an item
in the original order. The item in the original order will not be deleted
until the order edit is confirmed.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to delete from.
description: The ID of the Order Edit.
schema:
type: string
- in: path
name: item_id
required: true
description: The ID of the order edit item to delete from order.
description: The ID of line item in the original order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_order-edits_{id}_request.yaml
+5 -2
View File
@@ -1,13 +1,16 @@
post:
operationId: PostOrderEditsOrderEditRequest
summary: Request Confirmation
description: Request customer confirmation of an Order Edit
description: >-
Request customer confirmation of an Order Edit. This would emit the event
`order-edit.requested` which Notification Providers listen to and send a
notification to the customer about the order edit.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit to request confirmation from.
description: The ID of the Order Edit.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders.yaml
+23 -25
View File
@@ -1,26 +1,28 @@
get:
operationId: GetOrders
summary: List Orders
description: Retrieves a list of Orders
description: >-
Retrieve a list of Orders. The orders can be filtered by fields such as
`status` or `display_id`. The order can also be paginated.
x-authenticated: true
parameters:
- in: query
name: q
description: >-
Query used for searching orders by shipping address first name, orders'
email, and orders' display ID
term to search orders' shipping address, first name, email, and display
ID
schema:
type: string
- in: query
name: id
description: ID of the order to search for.
description: Filter by ID.
schema:
type: string
- in: query
name: status
style: form
explode: false
description: Status to search for
description: Filter by status
schema:
type: array
items:
@@ -35,7 +37,7 @@ get:
name: fulfillment_status
style: form
explode: false
description: Fulfillment status to search for.
description: Filter by fulfillment status
schema:
type: array
items:
@@ -54,7 +56,7 @@ get:
name: payment_status
style: form
explode: false
description: Payment status to search for.
description: Filter by payment status
schema:
type: array
items:
@@ -69,29 +71,29 @@ get:
- requires_action
- in: query
name: display_id
description: Display ID to search for.
description: Filter by display ID
schema:
type: string
- in: query
name: cart_id
description: to search for.
description: Filter by cart ID
schema:
type: string
- in: query
name: customer_id
description: to search for.
description: Filter by customer ID
schema:
type: string
- in: query
name: email
description: to search for.
description: Filter by email
schema:
type: string
- in: query
name: region_id
style: form
explode: false
description: Regions to search orders by
description: Filter by region IDs.
schema:
oneOf:
- type: string
@@ -104,7 +106,7 @@ get:
name: currency_code
style: form
explode: false
description: Currency code to search for
description: Filter by currency codes.
schema:
type: string
externalDocs:
@@ -112,12 +114,12 @@ get:
description: See a list of codes.
- in: query
name: tax_rate
description: to search for.
description: Filter by tax rate.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting orders were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -139,7 +141,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting orders were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -161,7 +163,7 @@ get:
format: date
- in: query
name: canceled_at
description: Date comparison for when resulting orders were canceled.
description: Filter by a cancelation date range.
schema:
type: object
properties:
@@ -185,7 +187,7 @@ get:
name: sales_channel_id
style: form
explode: false
description: Filter by Sales Channels
description: Filter by Sales Channel IDs
schema:
type: array
items:
@@ -193,7 +195,7 @@ get:
description: The ID of a Sales Channel
- in: query
name: offset
description: How many orders to skip before the results.
description: The number of orders to skip when retrieving the orders.
schema:
type: integer
default: 0
@@ -205,16 +207,12 @@ get:
default: 50
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each order of the
result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each order of the
result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}.yaml
+6 -6
View File
@@ -1,7 +1,7 @@
get:
operationId: GetOrdersOrder
summary: Get an Order
description: Retrieves an Order
description: Retrieve an Order's details.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,12 @@ get:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
@@ -59,7 +59,7 @@ get:
post:
operationId: PostOrdersOrder
summary: Update an Order
description: Updates and order
description: Update and order's details.
x-authenticated: true
parameters:
- in: path
@@ -70,12 +70,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_archive.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
post:
operationId: PostOrdersOrderArchive
summary: Archive Order
description: Archives the order with the given id.
description: Archive an order and change its status.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +12,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_cancel.yaml
+4 -4
View File
@@ -2,8 +2,8 @@ post:
operationId: PostOrdersOrderCancel
summary: Cancel an Order
description: >-
Registers an Order as canceled. This triggers a flow that will cancel any
created Fulfillments and Payments, may fail if the Payment or Fulfillment
Cancel an order and change its status. This will also cancel any associated
Fulfillments and Payments, and it may fail if the Payment or Fulfillment
Provider is unable to cancel the Payment/Fulfillment.
x-authenticated: true
parameters:
@@ -15,12 +15,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_capture.yaml
+6 -4
View File
@@ -1,7 +1,9 @@
post:
operationId: PostOrdersOrderCapture
summary: Capture Order's Payment
description: Captures all the Payments associated with an Order.
summary: Capture an Order's Payments
description: >-
Capture all the Payments associated with an Order. The payment of canceled
orders can't be captured.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +14,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_claims.yaml
+9 -3
View File
@@ -1,7 +1,13 @@
post:
operationId: PostOrdersOrderClaims
summary: Create a Claim
description: Creates a Claim.
description: >-
Create a Claim for an order. If a return shipping method is specified, a
return will also be created and associated with the claim. If the claim's
type is `refund`, the refund is processed as well.
externalDocs:
description: How are claims created
url: https://docs.medusajs.com/modules/orders/claims#how-are-claims-created
x-authenticated: true
parameters:
- in: path
@@ -12,12 +18,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}.yaml
+4 -4
View File
@@ -1,13 +1,13 @@
post:
operationId: PostOrdersOrderClaimsClaim
summary: Update a Claim
description: Updates a Claim.
description: Update a Claim's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the Order associated with the claim.
schema:
type: string
- in: path
@@ -18,12 +18,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_cancel.yaml
+10 -4
View File
@@ -1,13 +1,19 @@
post:
operationId: PostOrdersClaimCancel
summary: Cancel a Claim
description: Cancels a Claim
description: >-
Cancel a Claim and change its status. A claim can't be canceled if it has a
refund, if its fulfillments haven't been canceled, of if its associated
return hasn't been canceled.
x-authenticated: true
externalDocs:
description: Canceling a claim
url: https://docs.medusajs.com/modules/orders/claims#cancel-a-claim
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the order the claim is associated with.
schema:
type: string
- in: path
@@ -18,12 +24,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml
+8 -5
View File
@@ -1,13 +1,16 @@
post:
operationId: PostOrdersOrderClaimsClaimFulfillments
summary: Create Claim Fulfillment
description: Creates a Fulfillment for a Claim.
summary: Create a Claim Fulfillment
description: Create a Fulfillment for a Claim.
x-authenticated: true
externalDocs:
description: Fulfill a claim
url: https://docs.medusajs.com/modules/orders/claims#fulfill-a-claim
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the Order the claim is associated with.
schema:
type: string
- in: path
@@ -18,12 +21,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+7 -7
View File
@@ -1,35 +1,35 @@
post:
operationId: PostOrdersClaimFulfillmentsCancel
summary: Cancel Claim Fulfillment
description: Registers a claim's fulfillment as canceled.
summary: Cancel Claim's Fulfillment
description: Cancel a claim's fulfillment and change its status.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order which the Claim relates to.
description: The ID of the order the claim is associated with.
schema:
type: string
- in: path
name: claim_id
required: true
description: The ID of the Claim which the Fulfillment relates to.
description: The ID of the claim.
schema:
type: string
- in: path
name: fulfillment_id
required: true
description: The ID of the Fulfillment.
description: The ID of the fulfillment.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml
+11 -5
View File
@@ -1,13 +1,19 @@
post:
operationId: PostOrdersOrderClaimsClaimShipments
summary: Create Claim Shipment
description: Registers a Claim Fulfillment as shipped.
summary: Ship a Claim's Fulfillment
description: >-
Mark a claim's fulfillment as shipped. This changes the claim's fulfillment
status to either `shipped` or `partially_shipped`, depending on whether all
the items were shipped.
x-authenticated: true
externalDocs:
description: Fulfill a claim
url: https://docs.medusajs.com/modules/orders/claims#fulfill-a-claim
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the Order the claim is associated with.
schema:
type: string
- in: path
@@ -18,12 +24,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_complete.yaml
+5 -3
View File
@@ -1,7 +1,9 @@
post:
operationId: PostOrdersOrderComplete
summary: Complete an Order
description: Completes an Order
description: >-
Complete an Order and change its status. A canceled order can't be
completed.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +14,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_fulfillment.yaml
+6 -5
View File
@@ -1,10 +1,11 @@
post:
operationId: PostOrdersOrderFulfillments
summary: Create a Fulfillment
description: >-
Creates a Fulfillment of an Order - will notify Fulfillment Providers to
prepare a shipment.
description: Create a Fulfillment of an Order using the fulfillment provider.
x-authenticated: true
externalDocs:
description: Fulfillments of orders
url: https://docs.medusajs.com/modules/orders/#fulfillments-in-orders
parameters:
- in: path
name: id
@@ -14,12 +15,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+6 -6
View File
@@ -1,29 +1,29 @@
post:
operationId: PostOrdersOrderFulfillmentsCancel
summary: Cancels a Fulfilmment
description: Registers a Fulfillment as canceled.
summary: Cancel a Fulfilmment
description: Cancel an order's fulfillment and change its status.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order which the Fulfillment relates to.
description: The ID of the Order.
schema:
type: string
- in: path
name: fulfillment_id
required: true
description: The ID of the Fulfillment
description: The ID of the Fulfillment.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_line-items_{line_item_id}_reserve.yaml
+3 -3
View File
@@ -1,9 +1,9 @@
post:
operationId: PostOrdersOrderLineItemReservations
summary: Create a Reservation for a line item
summary: Create a Reservation
description: >-
Creates a Reservation for a line item at a specified location, optionally
for a partial quantity.
Create a Reservation for a line item at a specified location, optionally for
a partial quantity.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_orders_{id}_refund.yaml
+5 -3
View File
@@ -1,7 +1,9 @@
post:
operationId: PostOrdersOrderRefunds
summary: Create a Refund
description: Issues a Refund.
description: >-
Refund an amount for an order. The amount must be less than or equal the
`refundable_amount` of the order.
x-authenticated: true
parameters:
- in: path
@@ -12,12 +14,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_reservations.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
get:
operationId: GetOrdersOrderReservations
summary: Get reservations of an Order
description: Retrieves reservations of an Order
summary: Get Order Reservations
description: Retrieve the list of reservations of an Order
x-authenticated: true
parameters:
- in: path
@@ -12,7 +12,7 @@ get:
type: string
- in: query
name: offset
description: How many reservations to skip before the results.
description: The number of reservations to skip when retrieving the reservations.
schema:
type: integer
default: 0
docs/api/admin/paths/admin_orders_{id}_return.yaml
+7 -4
View File
@@ -2,9 +2,12 @@ post:
operationId: PostOrdersOrderReturns
summary: Request a Return
description: >-
Requests a Return. If applicable a return label will be created and other
plugins notified.
Request and create a Return for items in an order. If the return shipping
method is specified, it will be automatically fulfilled.
x-authenticated: true
externalDocs:
description: Return creation process
url: https://docs.medusajs.com/modules/orders/returns#returns-process
parameters:
- in: path
name: id
@@ -14,12 +17,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_shipment.yaml
+10 -4
View File
@@ -1,8 +1,14 @@
post:
operationId: PostOrdersOrderShipment
summary: Create a Shipment
description: Registers a Fulfillment as shipped.
summary: Ship a Fulfillment
description: >-
Mark a fulfillment as shipped. This changes the order's fulfillment status
to either `shipped` or `partially_shipped`, depending on whether all the
items were shipped.
x-authenticated: true
externalDocs:
description: Fulfillments of orders
url: https://docs.medusajs.com/modules/orders/#fulfillments-in-orders
parameters:
- in: path
name: id
@@ -12,12 +18,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_shipping-methods.yaml
+2 -2
View File
@@ -13,12 +13,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_swaps.yaml
+7 -8
View File
@@ -2,9 +2,12 @@ post:
operationId: PostOrdersOrderSwaps
summary: Create a Swap
description: >-
Creates a Swap. Swaps are used to handle Return of previously purchased
goods and Fulfillment of replacements simultaneously.
Create a Swap. This includes creating a return that is associated with the
swap.
x-authenticated: true
externalDocs:
description: How are swaps created
url: https://docs.medusajs.com/modules/orders/swaps#how-are-swaps-created
parameters:
- in: path
name: id
@@ -14,16 +17,12 @@ post:
type: string
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded the order of the
result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included the order of the
result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_cancel.yaml
+8 -5
View File
@@ -1,13 +1,16 @@
post:
operationId: PostOrdersSwapCancel
summary: Cancels a Swap
description: Cancels a Swap
summary: Cancel a Swap
description: Cancel a Swap and change its status.
x-authenticated: true
externalDocs:
description: Canceling a swap
url: https://docs.medusajs.com/modules/orders/swaps#canceling-a-swap
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the Order the swap is associated with.
schema:
type: string
- in: path
@@ -18,12 +21,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml
+8 -5
View File
@@ -1,13 +1,16 @@
post:
operationId: PostOrdersOrderSwapsSwapFulfillments
summary: Create Swap Fulfillment
description: Creates a Fulfillment for a Swap.
summary: Create a Swap Fulfillment
description: Create a Fulfillment for a Swap.
x-authenticated: true
externalDocs:
description: Handling a swap's fulfillment
url: https://docs.medusajs.com/modules/orders/swaps#handling-swap-fulfillment
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the Order the swap is associated with.
schema:
type: string
- in: path
@@ -18,12 +21,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+6 -6
View File
@@ -1,35 +1,35 @@
post:
operationId: PostOrdersSwapFulfillmentsCancel
summary: Cancel Swap's Fulfilmment
description: Registers a Swap's Fulfillment as canceled.
description: Cancel a swap's fulfillment and change its status.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Order which the Swap relates to.
description: The ID of the order the swap is associated with.
schema:
type: string
- in: path
name: swap_id
required: true
description: The ID of the Swap which the Fulfillment relates to.
description: The ID of the swap.
schema:
type: string
- in: path
name: fulfillment_id
required: true
description: The ID of the Fulfillment.
description: The ID of the fulfillment.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_process-payment.yaml
+12 -8
View File
@@ -1,32 +1,36 @@
post:
operationId: PostOrdersOrderSwapsSwapProcessPayment
summary: Process Swap Payment
summary: Process a Swap Payment
description: >-
When there are differences between the returned and shipped Products in a
Swap, the difference must be processed. Either a Refund will be issued or a
Payment will be captured.
Process a swap's payment either by refunding or issuing a payment. This
depends on the `difference_due` of the swap. If `difference_due` is
negative, the amount is refunded. If `difference_due` is positive, the
amount is captured.
x-authenticated: true
externalDocs:
description: Handling a swap's payment
url: https://docs.medusajs.com/modules/orders/swaps#handling-swap-payment
parameters:
- in: path
name: id
required: true
description: The ID of the Order.
description: The ID of the order the swap is associated with.
schema:
type: string
- in: path
name: swap_id
required: true
description: The ID of the Swap.
description: The ID of the swap.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml
+10 -4
View File
@@ -1,8 +1,14 @@
post:
operationId: PostOrdersOrderSwapsSwapShipments
summary: Create Swap Shipment
description: Registers a Swap Fulfillment as shipped.
summary: Ship a Swap's Fulfillment
description: >-
RMark a swap's fulfillment as shipped. This changes the swap's fulfillment
status to either `shipped` or `partially_shipped`, depending on whether all
the items were shipped.
x-authenticated: true
externalDocs:
description: Handling swap fulfillments
url: https://docs.medusajs.com/modules/orders/swaps#handling-swap-fulfillment
parameters:
- in: path
name: id
@@ -18,12 +24,12 @@ post:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the result.
description: Comma-separated relations that should be expanded in the returned order.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the result.
description: Comma-separated fields that should be included in the returned order.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_payment-collections_{id}.yaml
+17 -11
View File
@@ -1,23 +1,27 @@
get:
operationId: GetPaymentCollectionsPaymentCollection
summary: Get a PaymentCollection
description: Retrieves a PaymentCollection.
summary: Get a Payment Collection
description: Retrieve a Payment Collection's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the PaymentCollection.
description: The ID of the Payment Collection.
schema:
type: string
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
payment collection.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned payment
collection.
schema:
type: string
x-codegen:
@@ -58,14 +62,14 @@ get:
$ref: ../components/responses/500_error.yaml
post:
operationId: PostPaymentCollectionsPaymentCollection
summary: Update PaymentCollection
description: Updates a PaymentCollection.
summary: Update Payment Collection
description: Update a Payment Collection's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the PaymentCollection.
description: The ID of the Payment Collection.
schema:
type: string
requestBody:
@@ -110,14 +114,16 @@ post:
$ref: ../components/responses/500_error.yaml
delete:
operationId: DeletePaymentCollectionsPaymentCollection
summary: Del a PaymentCollection
description: Deletes a Payment Collection
summary: Delete a Payment Collection
description: >-
Delete a Payment Collection. Only payment collections with the statuses
`canceled` or `not_paid` can be deleted.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Payment Collection to delete.
description: The ID of the Payment Collection.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_payment-collections_{id}_authorize.yaml
+4 -2
View File
@@ -1,13 +1,15 @@
post:
operationId: PostPaymentCollectionsPaymentCollectionAuthorize
summary: Mark Authorized
description: Sets the status of PaymentCollection as Authorized.
description: >-
Set the status of a Payment Collection as `authorized`. This will also
change the `authorized_amount` of the payment collection.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the PaymentCollection.
description: The ID of the Payment Collection.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_payments_{id}.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
get:
operationId: GetPaymentsPayment
summary: Get Payment details
description: Retrieves the Payment details
description: Retrieve a Payment's details.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_payments_{id}_capture.yaml
+1 -1
View File
@@ -1,7 +1,7 @@
post:
operationId: PostPaymentsPaymentCapture
summary: Capture a Payment
description: Captures a Payment.
description: Capture a Payment.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_payments_{id}_refund.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
post:
operationId: PostPaymentsPaymentRefunds
summary: Create a Refund
description: Issues a Refund.
summary: Refund Payment
description: Refund a payment. The payment must be captured first.
x-authenticated: true
parameters:
- in: path
docs/api/admin/paths/admin_price-lists.yaml
+26 -17
View File
@@ -1,50 +1,59 @@
get:
operationId: GetPriceLists
summary: List Price Lists
description: Retrieves a list of Price Lists.
description: >-
Retrieve a list of price lists. The price lists can be filtered by fields
such as `q` or `status`. The price lists can also be sorted or paginated.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of items to get
description: Limit the number of price lists returned.
schema:
type: number
default: '10'
- in: query
name: offset
description: The offset at which to get items
description: The number of price lists to skip when retrieving the price lists.
schema:
type: number
default: '0'
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each item of the
result.
Comma-separated relations that should be expanded in the returned price
lists.
schema:
type: string
- in: query
name: fields
description: >-
Comma-separated fields that should be included in the returned price
lists.
schema:
type: string
- in: query
name: order
description: field to order results by.
description: A price-list field to sort-order the retrieved price lists by.
schema:
type: string
- in: query
name: id
description: ID to search for.
description: Filter by ID
schema:
type: string
- in: query
name: q
description: >-
query to search in price list description, price list name, and customer
group name fields.
term to search price lists' description, name, and customer group's
name.
schema:
type: string
- in: query
name: status
style: form
explode: false
description: Status to search for.
description: Filter by status.
schema:
type: array
items:
@@ -54,14 +63,14 @@ get:
- draft
- in: query
name: name
description: price list name to search for.
description: Filter by name
schema:
type: string
- in: query
name: customer_groups
style: form
explode: false
description: Customer Group IDs to search for.
description: Filter by customer-group IDs.
schema:
type: array
items:
@@ -70,7 +79,7 @@ get:
name: type
style: form
explode: false
description: Type to search for.
description: Filter by type.
schema:
type: array
items:
@@ -80,7 +89,7 @@ get:
- override
- in: query
name: created_at
description: Date comparison for when resulting price lists were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -102,7 +111,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting price lists were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -124,7 +133,7 @@ get:
format: date
- in: query
name: deleted_at
description: Date comparison for when resulting price lists were deleted.
description: Filter by a deletion date range.
schema:
type: object
properties:
@@ -183,7 +192,7 @@ get:
post:
operationId: PostPriceListsPriceList
summary: Create a Price List
description: Creates a Price List
description: Create a Price List.
x-authenticated: true
requestBody:
content:
docs/api/admin/paths/admin_price-lists_{id}.yaml
+4 -4
View File
@@ -1,7 +1,7 @@
get:
operationId: GetPriceListsPriceList
summary: Get a Price List
description: Retrieves a Price List.
description: Retrieve a Price List's details.
x-authenticated: true
parameters:
- in: path
@@ -48,7 +48,7 @@ get:
post:
operationId: PostPriceListsPriceListPriceList
summary: Update a Price List
description: Updates a Price List
description: Update a Price List's details.
x-authenticated: true
parameters:
- in: path
@@ -100,13 +100,13 @@ post:
delete:
operationId: DeletePriceListsPriceList
summary: Delete a Price List
description: Deletes a Price List
description: Delete a Price List and its associated prices.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Price List to delete.
description: The ID of the Price List.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_price-lists_{id}_prices_batch.yaml
+5 -7
View File
@@ -1,13 +1,13 @@
post:
operationId: PostPriceListsPriceListPricesBatch
summary: Update Prices
description: Batch update prices for a Price List
summary: Add or Update Prices
description: Add or update a list of prices in a Price List
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Price List to update prices for.
description: The ID of the Price List.
schema:
type: string
requestBody:
@@ -53,15 +53,13 @@ post:
delete:
operationId: DeletePriceListsPriceListPricesBatch
summary: Delete Prices
description: Batch delete prices that belong to a Price List
description: Delete a list of prices in a Price List
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: >-
The ID of the Price List that the Money Amounts (Prices) that will be
deleted belongs to.
description: The ID of the Price List
schema:
type: string
requestBody:
docs/api/admin/paths/admin_price-lists_{id}_products.yaml
+26 -22
View File
@@ -1,7 +1,9 @@
get:
operationId: GetPriceListsPriceListProducts
summary: List Products
description: Retrieves a list of Product that are part of a Price List
description: >-
Retrieve a price list's products. The products can be filtered by fields
such as `q` or `status`. The products can also be sorted or paginated.
x-authenticated: true
parameters:
- in: path
@@ -13,18 +15,18 @@ get:
- in: query
name: q
description: >-
Query used for searching product title and description, variant title
and sku, and collection title.
term used to search products' title, description, product variant's
title and sku, and product collection's title.
schema:
type: string
- in: query
name: id
description: ID of the product to search for.
description: Filter by product ID
schema:
type: string
- in: query
name: status
description: Product status to search for
description: Filter by product status
style: form
explode: false
schema:
@@ -38,7 +40,9 @@ get:
- rejected
- in: query
name: collection_id
description: Collection IDs to search for
description: >-
Filter by product collection ID. Only products in the specified
collections are retrieved.
style: form
explode: false
schema:
@@ -47,7 +51,9 @@ get:
type: string
- in: query
name: tags
description: Tag IDs to search for
description: >-
Filter by tag IDs. Only products having the specified tags are
retrieved.
style: form
explode: false
schema:
@@ -56,37 +62,37 @@ get:
type: string
- in: query
name: title
description: product title to search for.
description: Filter by title
schema:
type: string
- in: query
name: description
description: product description to search for.
description: Filter by description
schema:
type: string
- in: query
name: handle
description: product handle to search for.
description: Filter by handle
schema:
type: string
- in: query
name: is_giftcard
description: Search for giftcards using is_giftcard=true.
description: A boolean value to filter by whether the product is a gift card or not.
schema:
type: string
- in: query
name: type
description: to search for.
description: Filter product type.
schema:
type: string
- in: query
name: order
description: field to sort results by.
description: A product field to sort-order the retrieved products by.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting products were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -108,7 +114,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting products were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -130,7 +136,7 @@ get:
format: date
- in: query
name: deleted_at
description: Date comparison for when resulting products were deleted.
description: Filter by a deletion date range.
schema:
type: object
properties:
@@ -152,7 +158,7 @@ get:
format: date
- in: query
name: offset
description: How many products to skip in the result.
description: The number of products to skip when retrieving the products.
schema:
type: integer
default: 0
@@ -165,15 +171,13 @@ get:
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each product of the
result.
Comma-separated relations that should be expanded in the returned
products.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each product of the
result.
description: Comma-separated fields that should be included in the returned products.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_price-lists_{id}_products_{product_id}_prices.yaml
+4 -6
View File
@@ -1,21 +1,19 @@
delete:
operationId: DeletePriceListsPriceListProductsProductPrices
summary: Delete Product's Prices
description: Delete all the prices related to a specific product in a price list
summary: Delete a Product's Prices
description: Delete all the prices related to a specific product in a price list.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: >-
The ID of the Price List that the Money Amounts that will be deleted
belongs to.
description: The ID of the Price List.
schema:
type: string
- in: path
name: product_id
required: true
description: The ID of the product from which the money amount will be deleted.
description: The ID of the product from which the prices will be deleted.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml
+3 -5
View File
@@ -1,21 +1,19 @@
delete:
operationId: DeletePriceListsPriceListVariantsVariantPrices
summary: Delete Variant's Prices
summary: Delete a Variant's Prices
description: Delete all the prices related to a specific variant in a price list
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: >-
The ID of the Price List that the Money Amounts that will be deleted
belongs to.
description: The ID of the Price List.
schema:
type: string
- in: path
name: variant_id
required: true
description: The ID of the variant from which the money amount will be deleted.
description: The ID of the variant.
schema:
type: string
x-codegen:
docs/api/admin/paths/admin_product-categories.yaml
+28 -15
View File
@@ -1,42 +1,50 @@
get:
operationId: GetProductCategories
summary: List Product Categories
description: Retrieve a list of product categories.
description: >-
Retrieve a list of product categories. The product categories can be
filtered by fields such as `q` or `handle`. The product categories can also
be paginated.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: query
name: q
description: Query used for searching product category names or handles.
description: term to search product categories' names and handles.
schema:
type: string
- in: query
name: handle
description: Query used for searching product category by handle.
description: Filter by handle.
schema:
type: string
- in: query
name: is_internal
description: Search for only internal categories.
description: Filter by whether the category is internal or not.
schema:
type: boolean
- in: query
name: is_active
description: Search for only active categories
description: Filter by whether the category is active or not.
schema:
type: boolean
- in: query
name: include_descendants_tree
description: Include all nested descendants of category
description: >-
If set to `true`, all nested descendants of a category are included in
the response.
schema:
type: boolean
- in: query
name: parent_category_id
description: Returns categories scoped by parent
description: Filter by the ID of a parent category.
schema:
type: string
- in: query
name: offset
description: How many product categories to skip in the result.
description: >-
The number of product categories to skip when retrieving the product
categories.
schema:
type: integer
default: 0
@@ -49,15 +57,15 @@ get:
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in the product
category.
Comma-separated relations that should be expanded in the returned
product categories.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in the product
category.
Comma-separated fields that should be included in the returned product
categories.
schema:
type: string
x-codegen:
@@ -99,17 +107,22 @@ get:
post:
operationId: PostProductCategories
summary: Create a Product Category
description: Creates a Product Category.
description: Create a Product Category.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the results.
description: >-
Comma-separated relations that should be expanded in the returned
product category.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be retrieved in the results.
description: >-
Comma-separated fields that should be included in the returned product
category.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_product-categories_{id}.yaml
+11 -4
View File
@@ -1,8 +1,9 @@
get:
operationId: GetProductCategoriesCategory
summary: Get a Product Category
description: Retrieves a Product Category.
description: Retrieve a Product Category's details.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: path
name: id
@@ -12,12 +13,16 @@ get:
type: string
- in: query
name: expand
description: (Comma separated) Which fields should be expanded in the results.
description: >-
Comma-separated relations that should be expanded in the returned
product category.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Which fields should be included in the results.
description: >-
Comma-separated fields that should be included in the returned product
category.
schema:
type: string
x-codegen:
@@ -61,6 +66,7 @@ post:
summary: Update a Product Category
description: Updates a Product Category.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: path
name: id
@@ -126,8 +132,9 @@ post:
delete:
operationId: DeleteProductCategoriesCategory
summary: Delete a Product Category
description: Deletes a Product Category.
description: Delete a Product Category. This does not delete associated products.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: path
name: id
docs/api/admin/paths/admin_product-categories_{id}_products_batch.yaml
+15 -5
View File
@@ -1,8 +1,9 @@
post:
operationId: PostProductCategoriesCategoryProductsBatch
summary: Add Products to a Category
description: Assign a batch of products to a product category.
description: Add a list of products to a product category.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: path
name: id
@@ -12,12 +13,16 @@ post:
type: string
- in: query
name: expand
description: (Comma separated) Category fields to be expanded in the response.
description: >-
Comma-separated relations that should be expanded in the returned
product category.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Category fields to be retrieved in the response.
description: >-
Comma-separated fields that should be included in the returned product
category.
schema:
type: string
requestBody:
@@ -69,6 +74,7 @@ delete:
summary: Remove Products from Category
description: Remove a list of products from a product category.
x-authenticated: true
x-featureFlag: product_categories
parameters:
- in: path
name: id
@@ -78,12 +84,16 @@ delete:
type: string
- in: query
name: expand
description: (Comma separated) Category fields to be expanded in the response.
description: >-
Comma-separated relations that should be expanded in the returned
product category.
schema:
type: string
- in: query
name: fields
description: (Comma separated) Category fields to be retrieved in the response.
description: >-
Comma-separated fields that should be included in the returned product
category.
schema:
type: string
requestBody:
docs/api/admin/paths/admin_product-tags.yaml
+14 -10
View File
@@ -1,57 +1,61 @@
get:
operationId: GetProductTags
summary: List Product Tags
description: Retrieve a list of Product Tags.
description: >-
Retrieve a list of product tags. The product tags can be filtered by fields
such as `q` or `value`. The product tags can also be sorted or paginated.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of tags to return.
description: Limit the number of product tags returned.
schema:
type: integer
default: 10
- in: query
name: offset
description: The number of items to skip before the results.
description: The number of product tags to skip when retrieving the product tags.
schema:
type: integer
default: 0
- in: query
name: order
description: The field to sort items by.
description: A product tag field to sort-order the retrieved product tags by.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the tags.
description: >-
Filter by the ID of a discount condition. Only product tags that this
discount condition is applied to will be retrieved.
schema:
type: string
- in: query
name: value
style: form
explode: false
description: The tag values to search for
description: Filter by tag value.
schema:
type: array
items:
type: string
- in: query
name: q
description: A query string to search values for
description: term to search product tags' values.
schema:
type: string
- in: query
name: id
style: form
explode: false
description: The tag IDs to search for
description: Filter by tag IDs.
schema:
type: array
items:
type: string
- in: query
name: created_at
description: Date comparison for when resulting product tags were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -73,7 +77,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting product tags were updated.
description: Filter by an update date range.
schema:
type: object
properties:
docs/api/admin/paths/admin_product-types.yaml
+15 -10
View File
@@ -1,36 +1,41 @@
get:
operationId: GetProductTypes
summary: List Product Types
description: Retrieve a list of Product Types.
description: >-
Retrieve a list of product types. The product types can be filtered by
fields such as `q` or `value`. The product types can also be sorted or
paginated.
x-authenticated: true
parameters:
- in: query
name: limit
description: The number of types to return.
description: Limit the number of product types returned.
schema:
type: integer
default: 20
- in: query
name: offset
description: The number of items to skip before the results.
description: The number of product types to skip when retrieving the product types.
schema:
type: integer
default: 0
- in: query
name: order
description: The field to sort items by.
description: A product type field to sort-order the retrieved product types by.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the product types.
description: >-
Filter by the ID of a discount condition. Only product types that this
discount condition is applied to will be retrieved.
schema:
type: string
- in: query
name: value
style: form
explode: false
description: The type values to search for
description: Filter by value.
schema:
type: array
items:
@@ -39,19 +44,19 @@ get:
name: id
style: form
explode: false
description: The type IDs to search for
description: Filter by product type IDs.
schema:
type: array
items:
type: string
- in: query
name: q
description: A query string to search values for
description: term to search product types' values.
schema:
type: string
- in: query
name: created_at
description: Date comparison for when resulting product types were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -73,7 +78,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting product types were updated.
description: Filter by an update date range.
schema:
type: object
properties:
docs/api/admin/paths/admin_products.yaml
+50 -28
View File
@@ -1,19 +1,23 @@
get:
operationId: GetProducts
summary: List Products
description: Retrieves a list of Product
description: >-
Retrieve a list of products. The products can be filtered by fields such as
`q` or `status`. The products can also be sorted or paginated.
x-authenticated: true
parameters:
- in: query
name: q
description: >-
Query used for searching product title and description, variant title
and sku, and collection title.
term to search products' title, description, variants' title and sku,
and collections' title.
schema:
type: string
- in: query
name: discount_condition_id
description: The discount condition id on which to filter the product.
description: >-
Filter by the ID of a discount condition. Only products that this
discount condition is applied to will be retrieved.
schema:
type: string
- in: query
@@ -24,7 +28,7 @@ get:
schema:
oneOf:
- type: string
description: ID of the product to search for.
description: ID of the product.
- type: array
items:
type: string
@@ -33,7 +37,7 @@ get:
name: status
style: form
explode: false
description: Status to search for
description: Filter by status.
schema:
type: array
items:
@@ -47,7 +51,9 @@ get:
name: collection_id
style: form
explode: false
description: Collection ids to search for.
description: >-
Filter by product collection IDs. Only products that are associated with
the specified collections will be retrieved.
schema:
type: array
items:
@@ -56,7 +62,9 @@ get:
name: tags
style: form
explode: false
description: Tag IDs to search for
description: >-
Filter by product tag IDs. Only products that are associated with the
specified tags will be retrieved.
schema:
type: array
items:
@@ -65,7 +73,9 @@ get:
name: price_list_id
style: form
explode: false
description: Price List IDs to search for
description: >-
Filter by IDs of price lists. Only products that these price lists are
applied to will be retrieved.
schema:
type: array
items:
@@ -74,7 +84,9 @@ get:
name: sales_channel_id
style: form
explode: false
description: Sales Channel IDs to filter products by
description: >-
Filter by sales channel IDs. Only products that are available in the
specified sales channels will be retrieved.
schema:
type: array
items:
@@ -83,7 +95,9 @@ get:
name: type_id
style: form
explode: false
description: Type IDs to filter products by
description: >-
Filter by product type IDs. Only products that are associated with the
specified types will be retrieved.
schema:
type: array
items:
@@ -92,39 +106,47 @@ get:
name: category_id
style: form
explode: false
description: Category IDs to filter products by
description: >-
Filter by product category IDs. Only products that are associated with
the specified categories will be retrieved.
schema:
type: array
x-featureFlag: product_categories
items:
type: string
- in: query
name: include_category_children
description: Include category children when filtering by category_id
style: form
explode: false
description: >-
whether to include product category children when filtering by
`category_id`
schema:
type: boolean
x-featureFlag: product_categories
- in: query
name: title
description: title to search for.
description: Filter by title.
schema:
type: string
- in: query
name: description
description: description to search for.
description: Filter by description.
schema:
type: string
- in: query
name: handle
description: handle to search for.
description: Filter by handle.
schema:
type: string
- in: query
name: is_giftcard
description: Search for giftcards using is_giftcard=true.
description: Whether to retrieve gift cards or regular products.
schema:
type: boolean
- in: query
name: created_at
description: Date comparison for when resulting products were created.
description: Filter by a creation date range.
schema:
type: object
properties:
@@ -146,7 +168,7 @@ get:
format: date
- in: query
name: updated_at
description: Date comparison for when resulting products were updated.
description: Filter by an update date range.
schema:
type: object
properties:
@@ -168,7 +190,7 @@ get:
format: date
- in: query
name: deleted_at
description: Date comparison for when resulting products were deleted.
description: Filter by a deletion date range.
schema:
type: object
properties:
@@ -190,7 +212,7 @@ get:
format: date
- in: query
name: offset
description: How many products to skip in the result.
description: The number of products to skip when retrieving the products.
schema:
type: integer
default: 0
@@ -203,20 +225,18 @@ get:
- in: query
name: expand
description: >-
(Comma separated) Which fields should be expanded in each product of the
result.
Comma-separated relations that should be expanded in the returned
products.
schema:
type: string
- in: query
name: fields
description: >-
(Comma separated) Which fields should be included in each product of the
result.
description: Comma-separated fields that should be included in the returned products.
schema:
type: string
- in: query
name: order
description: the field used to order the products.
description: A product field to sort-order the retrieved products by.
schema:
type: string
x-codegen:
@@ -259,7 +279,9 @@ post:
operationId: PostProducts
summary: Create a Product
x-authenticated: true
description: Creates a Product
description: >-
Create a new Product. This endpoint can also be used to create a gift card
if the `is_giftcard` field is set to `true`.
requestBody:
content:
application/json:
docs/api/admin/paths/admin_products_tag-usage.yaml
+3 -1
View File
@@ -1,7 +1,9 @@
get:
operationId: GetProductsTagUsage
summary: List Tags Usage Number
description: Retrieves a list of Product Tags with how many times each is used.
description: >-
Retrieve a list of Product Tags with how many times each is used in
products.
x-authenticated: true
x-codegen:
method: listTags
docs/api/admin/paths/admin_products_types.yaml
+1 -1
View File
@@ -2,7 +2,7 @@ get:
deprecated: true
operationId: GetProductsTypes
summary: List Product Types
description: Retrieves a list of Product Types.
description: Retrieve a list of Product Types.
x-authenticated: true
x-codegen:
method: listTypes
docs/api/admin/paths/admin_products_{id}.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
get:
operationId: GetProductsProduct
summary: Get a Product
description: Retrieves a Product.
description: Retrieve a Product's details.
x-authenticated: true
parameters:
- in: path
@@ -48,7 +48,7 @@ get:
post:
operationId: PostProductsProduct
summary: Update a Product
description: Updates a Product
description: Update a Product's details.
x-authenticated: true
parameters:
- in: path
@@ -100,7 +100,7 @@ post:
delete:
operationId: DeleteProductsProduct
summary: Delete a Product
description: Deletes a Product and it's associated Product Variants.
description: Delete a Product and its associated product variants and options.
x-authenticated: true
parameters:
- in: path

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