chore(docs): Generated OAS (#6752)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
95738804cd
commit
53653f5266
198 files changed
+8995
-328
No files matched your search
@@ -6,33 +6,9 @@ info:
|
|||||||
name: MIT
|
name: MIT
|
||||||
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
||||||
tags:
|
tags:
|
||||||
- name: Apps Oauth
|
- name: Api Keys
|
||||||
description: >
|
- name: Campaigns
|
||||||
Some plugins may require to authenticate with third-party services and
|
- name: Collections
|
||||||
store authentication details, such as the authentication token. To do
|
|
||||||
that, they can create an Oauth provider within the plugin that handles the
|
|
||||||
authentication.
|
|
||||||
|
|
||||||
The Apps Oauth API Routes allows admins to manage and generate token for an app using its oauth provider.
|
|
||||||
- name: Auth
|
|
||||||
description: >
|
|
||||||
Authentication API Routes allow admin users to manage their session, such
|
|
||||||
as login or log out.
|
|
||||||
|
|
||||||
When an admin user is logged in, the cookie header is set indicating the admin's login session.
|
|
||||||
externalDocs:
|
|
||||||
description: How to implement user profiles
|
|
||||||
url: https://docs.medusajs.com/modules/users/admin/manage-profile
|
|
||||||
- name: Batch Jobs
|
|
||||||
description: >
|
|
||||||
A batch job is a task that is performed by the Medusa backend
|
|
||||||
asynchronusly. For example, the Import Product feature is implemented
|
|
||||||
using batch jobs.
|
|
||||||
|
|
||||||
Batch Job API Routes allow admins to manage the batch jobs and their state.
|
|
||||||
externalDocs:
|
|
||||||
description: How to import products
|
|
||||||
url: https://docs.medusajs.com/modules/products/admin/import-products
|
|
||||||
- name: Currencies
|
- name: Currencies
|
||||||
description: >
|
description: >
|
||||||
A store can use unlimited currencies, and each region must be associated
|
A store can use unlimited currencies, and each region must be associated
|
||||||
@@ -58,31 +34,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage customers
|
description: How to manage customers
|
||||||
url: https://docs.medusajs.com/modules/customers/admin/manage-customers
|
url: https://docs.medusajs.com/modules/customers/admin/manage-customers
|
||||||
- name: Discounts
|
- name: Fulfillment
|
||||||
description: >
|
|
||||||
Admins can create discounts with conditions and rules, providing them with
|
|
||||||
advanced settings for variety of cases.
|
|
||||||
|
|
||||||
The Discount API Routes can be used to manage discounts, their conditions, resources, and more.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage discounts
|
|
||||||
url: https://docs.medusajs.com/modules/discounts/admin/manage-discounts
|
|
||||||
- name: Draft Orders
|
|
||||||
description: >
|
|
||||||
A draft order is an order created manually by the admin. It allows admins
|
|
||||||
to create orders without direct involvement from the customer.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage draft orders
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/manage-draft-orders
|
|
||||||
- name: Gift Cards
|
|
||||||
description: >
|
|
||||||
Admins can create gift cards and send them directly to customers,
|
|
||||||
specifying options like their balance, region, and more.
|
|
||||||
|
|
||||||
These gift cards are different than the saleable gift cards in a store, which are created and managed through Product API Routes.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage gift cards
|
|
||||||
url: https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards
|
|
||||||
- name: Inventory Items
|
- name: Inventory Items
|
||||||
description: >
|
description: >
|
||||||
Inventory items, provided by the [Inventory
|
Inventory items, provided by the [Inventory
|
||||||
@@ -98,39 +50,6 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage invites
|
description: How to manage invites
|
||||||
url: https://docs.medusajs.com/modules/users/admin/manage-invites
|
url: https://docs.medusajs.com/modules/users/admin/manage-invites
|
||||||
- name: Notes
|
|
||||||
description: >
|
|
||||||
Notes are created by admins and can be associated with any resource. For
|
|
||||||
example, an admin can add a note to an order for additional details or
|
|
||||||
remarks.
|
|
||||||
- name: Notifications
|
|
||||||
description: >
|
|
||||||
Notifications are sent to customers to inform them of new updates. For
|
|
||||||
example, a notification can be sent to the customer when their order is
|
|
||||||
place or its state is updated.
|
|
||||||
|
|
||||||
The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend.
|
|
||||||
- name: Order Edits
|
|
||||||
description: >
|
|
||||||
An admin can edit an order to remove, add, or update an item's quantity.
|
|
||||||
When an admin edits an order, they're stored as an `OrderEdit`.
|
|
||||||
externalDocs:
|
|
||||||
description: How to edit an order
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/edit-order
|
|
||||||
- name: Orders
|
|
||||||
description: >
|
|
||||||
Orders are purchases made by customers, typically through a storefront
|
|
||||||
using the Store API. Draft orders created by the admin are also
|
|
||||||
transformed to an Order once the payment is captured.
|
|
||||||
|
|
||||||
Managing orders include managing fulfillment, payment, claims, reservations, and more.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage orders
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/manage-orders
|
|
||||||
- name: Payment Collections
|
|
||||||
description: >
|
|
||||||
A payment collection is useful for managing additional payments, such as
|
|
||||||
for Order Edits, or installment payments.
|
|
||||||
- name: Payments
|
- name: Payments
|
||||||
description: >
|
description: >
|
||||||
A payment can be related to an order, swap, return, or more. It can be
|
A payment can be related to an order, swap, return, or more. It can be
|
||||||
@@ -142,39 +61,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage price lists
|
description: How to manage price lists
|
||||||
url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
|
url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
|
||||||
- name: Product Categories
|
- name: Pricing
|
||||||
description: >
|
|
||||||
Products can be categoriezed into categories. A product can be added into
|
|
||||||
more than one category.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage product categories
|
|
||||||
url: https://docs.medusajs.com/modules/products/admin/manage-categories
|
|
||||||
- name: Product Collections
|
|
||||||
description: >
|
|
||||||
A product collection is used to organize products for different purposes
|
|
||||||
such as marketing or discount purposes. For example, you can create a
|
|
||||||
Summer Collection.
|
|
||||||
- name: Product Tags
|
|
||||||
description: >
|
|
||||||
Product tags are string values created when you create or update a product
|
|
||||||
with a new tag.
|
|
||||||
|
|
||||||
Products can have more than one tag, and products can share tags. This allows admins to associate products to similar tags that can be used to filter products.
|
|
||||||
- name: Product Types
|
|
||||||
description: >
|
|
||||||
Product types are string values created when you create or update a
|
|
||||||
product with a new type.
|
|
||||||
|
|
||||||
Products can have one type, and products can share types. This allows admins to associate products with a type that can be used to filter products.
|
|
||||||
- name: Product Variants
|
|
||||||
description: >
|
|
||||||
Product variants are the actual salable item in your store. Each variant
|
|
||||||
is a combination of the different option values available on the product.
|
|
||||||
|
|
||||||
Product variants can be managed through the Products API Routes.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage product variants
|
|
||||||
url: https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants
|
|
||||||
- name: Products
|
- name: Products
|
||||||
description: >
|
description: >
|
||||||
Products are saleable items in a store. This also includes [saleable gift
|
Products are saleable items in a store. This also includes [saleable gift
|
||||||
@@ -183,19 +70,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage products
|
description: How to manage products
|
||||||
url: https://docs.medusajs.com/modules/products/admin/manage-products
|
url: https://docs.medusajs.com/modules/products/admin/manage-products
|
||||||
- name: Publishable API Keys
|
- name: Promotions
|
||||||
description: >
|
|
||||||
Publishable API Keys can be used to scope Store API calls with an API key,
|
|
||||||
determining what resources are retrieved when querying the API.
|
|
||||||
|
|
||||||
For example, a publishable API key can be associated with one or more sales channels. When it is passed in the header of a request to the List Product store API Route,
|
|
||||||
|
|
||||||
the sales channels are inferred from the key and only products associated with those sales channels are retrieved.
|
|
||||||
|
|
||||||
Admins can manage publishable API keys and their associated resources. Currently, only Sales Channels are supported as a resource.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage publishable API keys
|
|
||||||
url: https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys
|
|
||||||
- name: Regions
|
- name: Regions
|
||||||
description: >
|
description: >
|
||||||
Regions are different countries or geographical regions that the commerce
|
Regions are different countries or geographical regions that the commerce
|
||||||
@@ -205,35 +80,6 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage regions
|
description: How to manage regions
|
||||||
url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions
|
url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions
|
||||||
- name: Reservations
|
|
||||||
description: >
|
|
||||||
Reservations, provided by the [Inventory
|
|
||||||
Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module),
|
|
||||||
are quantities of an item that are reserved, typically when an order is
|
|
||||||
placed but not yet fulfilled.
|
|
||||||
|
|
||||||
Reservations can be associated with any resources, but commonly with line items of an order.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage item allocations in orders
|
|
||||||
url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders
|
|
||||||
- name: Return Reasons
|
|
||||||
description: >
|
|
||||||
Return reasons are key-value pairs that are used to specify why an order
|
|
||||||
return is being created.
|
|
||||||
|
|
||||||
Admins can manage available return reasons, and they can be used by both admins and customers when creating a return.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage return reasons
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/manage-returns#manage-return-reasons
|
|
||||||
- name: Returns
|
|
||||||
description: >
|
|
||||||
A return can be created by a customer or an admin to return items in an
|
|
||||||
order.
|
|
||||||
|
|
||||||
Admins can manage these returns and change their state.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage returns
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/manage-returns
|
|
||||||
- name: Sales Channels
|
- name: Sales Channels
|
||||||
description: >
|
description: >
|
||||||
A sales channel indicates a channel where products can be sold in. For
|
A sales channel indicates a channel where products can be sold in. For
|
||||||
@@ -243,50 +89,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage sales channels
|
description: How to manage sales channels
|
||||||
url: https://docs.medusajs.com/modules/sales-channels/admin/manage
|
url: https://docs.medusajs.com/modules/sales-channels/admin/manage
|
||||||
- name: Shipping Options
|
- name: Stores
|
||||||
description: >
|
|
||||||
A shipping option is used to define the available shipping methods during
|
|
||||||
checkout or when creating a return.
|
|
||||||
|
|
||||||
Admins can create an unlimited number of shipping options, each associated with a shipping profile and fulfillment provider, among other resources.
|
|
||||||
externalDocs:
|
|
||||||
description: Shipping Option architecture
|
|
||||||
url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
|
|
||||||
- name: Shipping Profiles
|
|
||||||
description: >
|
|
||||||
A shipping profile is used to group products that can be shipped in the
|
|
||||||
same manner.
|
|
||||||
|
|
||||||
They are created by the admin and they're not associated with a fulfillment provider.
|
|
||||||
externalDocs:
|
|
||||||
description: Shipping Profile architecture
|
|
||||||
url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile
|
|
||||||
- name: Stock Locations
|
|
||||||
description: >
|
|
||||||
A stock location, provided by the [Stock Location
|
|
||||||
module](https://docs.medusajs.com/modules/multiwarehouse/stock-location-module),
|
|
||||||
indicates a physical address that stock-kept items, such as physical
|
|
||||||
products, can be stored in.
|
|
||||||
|
|
||||||
An admin can create and manage available stock locations.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage stock locations.
|
|
||||||
url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-stock-locations
|
|
||||||
- name: Store
|
|
||||||
description: >
|
|
||||||
A store indicates the general configurations and details about the
|
|
||||||
commerce store. By default, there's only one store in the Medusa backend.
|
|
||||||
|
|
||||||
Admins can manage the store and its details or configurations.
|
|
||||||
- name: Swaps
|
|
||||||
description: >
|
|
||||||
A swap is created by a customer or an admin to exchange an item with a new
|
|
||||||
one.
|
|
||||||
|
|
||||||
Creating a swap implicitely includes creating a return for the item being exchanged.
|
|
||||||
externalDocs:
|
|
||||||
description: How to manage swaps
|
|
||||||
url: https://docs.medusajs.com/modules/orders/admin/manage-swaps
|
|
||||||
- name: Tax Rates
|
- name: Tax Rates
|
||||||
description: >
|
description: >
|
||||||
Each region has at least a default tax rate. Admins can create and manage
|
Each region has at least a default tax rate. Admins can create and manage
|
||||||
@@ -295,14 +98,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage tax rates
|
description: How to manage tax rates
|
||||||
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
|
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
|
||||||
- name: Uploads
|
- name: Tax Regions
|
||||||
description: >
|
|
||||||
The upload API Routes are used to upload any type of resources. For
|
|
||||||
example, they can be used to upload CSV files that are used to import
|
|
||||||
products into the store.
|
|
||||||
externalDocs:
|
|
||||||
description: How to upload CSV file when importing a product.
|
|
||||||
url: https://docs.medusajs.com/modules/products/admin/import-products#1-upload-csv-file
|
|
||||||
- name: Users
|
- name: Users
|
||||||
description: >
|
description: >
|
||||||
A store can have more than one user, each having the same privileges.
|
A store can have more than one user, each having the same privileges.
|
||||||
@@ -310,6 +106,7 @@ tags:
|
|||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to manage users
|
description: How to manage users
|
||||||
url: https://docs.medusajs.com/modules/users/admin/manage-users
|
url: https://docs.medusajs.com/modules/users/admin/manage-users
|
||||||
|
- name: Workflows Executions
|
||||||
servers:
|
servers:
|
||||||
- url: http://localhost:9000
|
- url: http://localhost:9000
|
||||||
- url: https://api.medusa-commerce.com
|
- url: https://api.medusa-commerce.com
|
||||||
|
|||||||
@@ -6,108 +6,43 @@ info:
|
|||||||
name: MIT
|
name: MIT
|
||||||
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
||||||
tags:
|
tags:
|
||||||
- name: Auth
|
|
||||||
description: |
|
|
||||||
Authentication API Routes allow you to manage a customer's session, such as login or log out.
|
|
||||||
You can send authenticated requests for a customer either using the Cookie header or using the JWT Token.
|
|
||||||
externalDocs:
|
|
||||||
description: How to implement customer profiles in your storefront
|
|
||||||
url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
|
|
||||||
- name: Carts
|
- name: Carts
|
||||||
description: |
|
description: >
|
||||||
A cart is a virtual shopping bag that customers can use to add items they want to purchase.
|
A cart is a virtual shopping bag that customers can use to add items they
|
||||||
|
want to purchase.
|
||||||
|
|
||||||
A cart is then used to checkout and place an order.
|
A cart is then used to checkout and place an order.
|
||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to implement cart functionality in your storefront
|
description: How to implement cart functionality in your storefront
|
||||||
url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart
|
url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart
|
||||||
|
- name: Currencies
|
||||||
- name: Customers
|
- name: Customers
|
||||||
description: |
|
description: >
|
||||||
A customer can register and manage their information such as addresses, orders, payment methods, and more.
|
A customer can register and manage their information such as addresses,
|
||||||
|
orders, payment methods, and more.
|
||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to implement customer profiles in your storefront
|
description: How to implement customer profiles in your storefront
|
||||||
url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
|
url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
|
||||||
- name: Gift Cards
|
|
||||||
description: |
|
|
||||||
Customers can use gift cards during checkout to deduct the gift card's balance from the checkout total.
|
|
||||||
The Gift Card API Routes allow retrieving a gift card's details by its code. A gift card can be applied to a cart using the Carts API Routes.
|
|
||||||
externalDocs:
|
|
||||||
description: How to use gift cards in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards
|
|
||||||
- name: Orders
|
|
||||||
description: |
|
|
||||||
Orders are purchases made by customers, typically through a storefront.
|
|
||||||
Orders are placed and created using the Carts API Routes. The Orders API Routes allow retrieving and claiming orders.
|
|
||||||
externalDocs:
|
|
||||||
description: How to retrieve order details in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details
|
|
||||||
- name: Order Edits
|
|
||||||
description: |
|
|
||||||
Order edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin.
|
|
||||||
A customer can review order edit requests created by an admin and confirm or decline them.
|
|
||||||
externalDocs:
|
|
||||||
description: How to handle order edits in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits
|
|
||||||
- name: Payment Collections
|
- name: Payment Collections
|
||||||
description: |
|
description: >
|
||||||
A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments.
|
A payment collection is useful for managing additional payments, such as
|
||||||
- name: Products
|
for Order Edits, or installment payments.
|
||||||
description: |
|
|
||||||
Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards) in a store.
|
|
||||||
Using these API Routes, you can filter products by categories, collections, sales channels, and more.
|
|
||||||
externalDocs:
|
|
||||||
description: How to show products in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/products/storefront/show-products
|
|
||||||
- name: Product Variants
|
|
||||||
description: |
|
|
||||||
Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product.
|
|
||||||
- name: Product Categories
|
|
||||||
description: |
|
|
||||||
Products can be categoriezed into categories. A product can be associated more than one category.
|
|
||||||
Using these API Routes, you can list or retrieve a category's details and products.
|
|
||||||
externalDocs:
|
|
||||||
description: How to use product categories in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/products/storefront/use-categories
|
|
||||||
- name: Product Collections
|
|
||||||
description: |
|
|
||||||
A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection.
|
|
||||||
Using these API Routes, you can list or retrieve a collection's details and products.
|
|
||||||
- name: Product Tags
|
|
||||||
description: |
|
|
||||||
Product tags are string values that can be used to filter products by.
|
|
||||||
Products can have more than one tag, and products can share tags.
|
|
||||||
- name: Product Types
|
|
||||||
description: |
|
|
||||||
Product types are string values that can be used to filter products by.
|
|
||||||
Products can have more than one tag, and products can share types.
|
|
||||||
- name: Regions
|
- name: Regions
|
||||||
description: |
|
description: >
|
||||||
Regions are different countries or geographical regions that the commerce store serves customers in.
|
Regions are different countries or geographical regions that the commerce
|
||||||
|
store serves customers in.
|
||||||
|
|
||||||
Customers can choose what region they're in, which can be used to change the prices shown based on the region and its currency.
|
Customers can choose what region they're in, which can be used to change the prices shown based on the region and its currency.
|
||||||
externalDocs:
|
externalDocs:
|
||||||
description: How to use regions in a storefront
|
description: How to use regions in a storefront
|
||||||
url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
|
url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
|
||||||
- name: Returns
|
|
||||||
description: |
|
|
||||||
A return can be created by a customer to return items in an order.
|
|
||||||
externalDocs:
|
|
||||||
description: How to create a return in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/orders/storefront/create-return
|
|
||||||
- name: Return Reasons
|
|
||||||
description: |
|
|
||||||
Return reasons are key-value pairs that are used to specify why an order return is being created.
|
|
||||||
- name: Shipping Options
|
- name: Shipping Options
|
||||||
description: |
|
description: >
|
||||||
A shipping option is used to define the available shipping methods during checkout or when creating a return.
|
A shipping option is used to define the available shipping methods during
|
||||||
|
checkout or when creating a return.
|
||||||
externalDocs:
|
externalDocs:
|
||||||
description: Shipping Option architecture
|
description: Shipping Option architecture
|
||||||
url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
|
url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
|
||||||
- name: Swaps
|
|
||||||
description: |
|
|
||||||
A swap is created by a customer or an admin to exchange an item with a new one.
|
|
||||||
Creating a swap implicitely includes creating a return for the item being exchanged.
|
|
||||||
externalDocs:
|
|
||||||
description: How to create a swap in a storefront
|
|
||||||
url: https://docs.medusajs.com/modules/orders/storefront/create-swap
|
|
||||||
servers:
|
servers:
|
||||||
- url: http://localhost:9000
|
- url: http://localhost:9000
|
||||||
- url: https://api.medusa-commerce.com
|
- url: https://api.medusa-commerce.com
|
||||||
@@ -121,9 +56,9 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
example:
|
example:
|
||||||
code: "unknown_error"
|
code: unknown_error
|
||||||
message: "An unknown error occurred."
|
message: An unknown error occurred.
|
||||||
type: "unknown_error"
|
type: unknown_error
|
||||||
invalid_state_error:
|
invalid_state_error:
|
||||||
description: Invalid State Error
|
description: Invalid State Error
|
||||||
content:
|
content:
|
||||||
@@ -131,9 +66,10 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
example:
|
example:
|
||||||
code: "unknown_error"
|
code: unknown_error
|
||||||
message: "The request conflicted with another request. You may retry the request with the provided Idempotency-Key."
|
message: The request conflicted with another request. You may retry the request
|
||||||
type: "QueryRunnerAlreadyReleasedError"
|
with the provided Idempotency-Key.
|
||||||
|
type: QueryRunnerAlreadyReleasedError
|
||||||
invalid_request_error:
|
invalid_request_error:
|
||||||
description: Invalid Request Error
|
description: Invalid Request Error
|
||||||
content:
|
content:
|
||||||
@@ -141,9 +77,9 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
example:
|
example:
|
||||||
code: "invalid_request_error"
|
code: invalid_request_error
|
||||||
message: "Discount with code TEST already exists."
|
message: Discount with code TEST already exists.
|
||||||
type: "duplicate_error"
|
type: duplicate_error
|
||||||
not_found_error:
|
not_found_error:
|
||||||
description: Not Found Error
|
description: Not Found Error
|
||||||
content:
|
content:
|
||||||
@@ -151,8 +87,8 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
example:
|
example:
|
||||||
message: "Entity with id 1 was not found"
|
message: Entity with id 1 was not found
|
||||||
type: "not_found"
|
type: not_found
|
||||||
400_error:
|
400_error:
|
||||||
description: Client Error or Multiple Errors
|
description: Client Error or Multiple Errors
|
||||||
content:
|
content:
|
||||||
@@ -184,7 +120,7 @@ components:
|
|||||||
default_error:
|
default_error:
|
||||||
$ref: "#/components/examples/default_error"
|
$ref: "#/components/examples/default_error"
|
||||||
unauthorized:
|
unauthorized:
|
||||||
description: 'User is not authorized. Must log in first'
|
description: User is not authorized. Must log in first
|
||||||
content:
|
content:
|
||||||
text/plain:
|
text/plain:
|
||||||
schema:
|
schema:
|
||||||
@@ -192,7 +128,7 @@ components:
|
|||||||
default: Unauthorized
|
default: Unauthorized
|
||||||
example: Unauthorized
|
example: Unauthorized
|
||||||
incorrect_credentials:
|
incorrect_credentials:
|
||||||
description: 'User does not exist or incorrect credentials'
|
description: User does not exist or incorrect credentials
|
||||||
content:
|
content:
|
||||||
text/plain:
|
text/plain:
|
||||||
schema:
|
schema:
|
||||||
@@ -203,44 +139,45 @@ components:
|
|||||||
not_allowed_error:
|
not_allowed_error:
|
||||||
summary: Not Allowed Error
|
summary: Not Allowed Error
|
||||||
value:
|
value:
|
||||||
message: "Discount must be set to dynamic"
|
message: Discount must be set to dynamic
|
||||||
type: "not_allowed"
|
type: not_allowed
|
||||||
invalid_data_error:
|
invalid_data_error:
|
||||||
summary: Invalid Data Error
|
summary: Invalid Data Error
|
||||||
value:
|
value:
|
||||||
message: "first_name must be a string"
|
message: first_name must be a string
|
||||||
type: "invalid_data"
|
type: invalid_data
|
||||||
multiple_errors:
|
multiple_errors:
|
||||||
summary: Multiple Errors
|
summary: Multiple Errors
|
||||||
value:
|
value:
|
||||||
message: "Provided request body contains errors. Please check the data and retry the request"
|
message: Provided request body contains errors. Please check the data and retry
|
||||||
|
the request
|
||||||
errors:
|
errors:
|
||||||
- message: "first_name must be a string"
|
- message: first_name must be a string
|
||||||
type: "invalid_data"
|
type: invalid_data
|
||||||
- message: "Discount must be set to dynamic"
|
- message: Discount must be set to dynamic
|
||||||
type: "not_allowed"
|
type: not_allowed
|
||||||
database_error:
|
database_error:
|
||||||
summary: Database Error
|
summary: Database Error
|
||||||
value:
|
value:
|
||||||
code: "api_error"
|
code: api_error
|
||||||
message: "An error occured while hashing password"
|
message: An error occured while hashing password
|
||||||
type: "database_error"
|
type: database_error
|
||||||
unexpected_state_error:
|
unexpected_state_error:
|
||||||
summary: Unexpected State Error
|
summary: Unexpected State Error
|
||||||
value:
|
value:
|
||||||
message: "cart.total must be defined"
|
message: cart.total must be defined
|
||||||
type: "unexpected_state"
|
type: unexpected_state
|
||||||
invalid_argument_error:
|
invalid_argument_error:
|
||||||
summary: Invalid Argument Error
|
summary: Invalid Argument Error
|
||||||
value:
|
value:
|
||||||
message: "cart.total must be defined"
|
message: cart.total must be defined
|
||||||
type: "unexpected_state"
|
type: unexpected_state
|
||||||
default_error:
|
default_error:
|
||||||
summary: Default Error
|
summary: Default Error
|
||||||
value:
|
value:
|
||||||
code: "unknown_error"
|
code: unknown_error
|
||||||
message: "An unknown error occurred."
|
message: An unknown error occurred.
|
||||||
type: "unknown_error"
|
type: unknown_error
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
jwt_token:
|
jwt_token:
|
||||||
type: http
|
type: http
|
||||||
@@ -251,37 +188,56 @@ components:
|
|||||||
x-displayName: Cookie Session ID
|
x-displayName: Cookie Session ID
|
||||||
in: cookie
|
in: cookie
|
||||||
name: connect.sid
|
name: connect.sid
|
||||||
description: |
|
description: >
|
||||||
Use a cookie session to send authenticated requests.
|
Use a cookie session to send authenticated requests.
|
||||||
|
|
||||||
|
|
||||||
### How to Obtain the Cookie Session
|
### How to Obtain the Cookie Session
|
||||||
|
|
||||||
|
|
||||||
If you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in.
|
If you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in.
|
||||||
|
|
||||||
|
|
||||||
If you're sending requests using cURL, you must set the Session ID in the cookie manually.
|
If you're sending requests using cURL, you must set the Session ID in the cookie manually.
|
||||||
|
|
||||||
|
|
||||||
To do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`:
|
To do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`:
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
||||||
curl -v --location --request POST 'https://medusa-url.com/store/auth' \
|
curl -v --location --request POST 'https://medusa-url.com/store/auth' \
|
||||||
|
|
||||||
--header 'Content-Type: application/json' \
|
--header 'Content-Type: application/json' \
|
||||||
|
|
||||||
--data-raw '{
|
--data-raw '{
|
||||||
"email": "user@example.com",
|
"email": "user@example.com",
|
||||||
"password": "supersecret"
|
"password": "supersecret"
|
||||||
}'
|
}'
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
The headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this:
|
The headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this:
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
||||||
Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM;
|
Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM;
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Copy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following:
|
Copy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following:
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
||||||
curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \
|
curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \
|
||||||
|
|
||||||
--header 'Cookie: connect.sid={sid}'
|
--header 'Cookie: connect.sid={sid}'
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Where `{sid}` is the value of `connect.sid` that you copied.
|
Where `{sid}` is the value of `connect.sid` that you copied.
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/api-keys/{id}
|
||||||
|
* operationId: DeleteApiKeysId
|
||||||
|
* summary: Delete a Api Key
|
||||||
|
* description: Delete a api key.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The api key's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/api-keys/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/campaigns/{id}
|
||||||
|
* operationId: DeleteCampaignsId
|
||||||
|
* summary: Delete a Campaign
|
||||||
|
* description: Delete a campaign.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The campaign's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/campaigns/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Campaigns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/collections/{id}
|
||||||
|
* operationId: DeleteCollectionsId
|
||||||
|
* summary: Delete a Collection
|
||||||
|
* description: Delete a collection.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The collection's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/collections/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Collections
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/customer-groups/{id}
|
||||||
|
* operationId: DeleteCustomerGroupsId
|
||||||
|
* summary: Delete a Customer Group
|
||||||
|
* description: Delete a customer group.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/customers/{id}
|
||||||
|
* operationId: DeleteCustomersId
|
||||||
|
* summary: Delete a Customer
|
||||||
|
* description: Delete a customer.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/customers/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+52
@@ -0,0 +1,52 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/customers/{id}/addresses/{address_id}
|
||||||
|
* operationId: DeleteCustomersIdAddressesAddress_id
|
||||||
|
* summary: Remove Addresses from Customer
|
||||||
|
* description: Remove a list of addresses from a customer. This doesn't delete the
|
||||||
|
* Address, only the association between the Address and the customer.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: address_id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's address id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}'
|
||||||
|
* \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/inventory-items/{id}
|
||||||
|
* operationId: DeleteInventoryItemsId
|
||||||
|
* summary: Delete a Inventory Item
|
||||||
|
* description: Delete a inventory item.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The inventory item's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+53
@@ -0,0 +1,53 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id}
|
||||||
|
* operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
|
||||||
|
* summary: Remove Location Levels from Inventory Item
|
||||||
|
* description: Remove a list of location levels from a inventory item. This
|
||||||
|
* doesn't delete the Location Level, only the association between the Location
|
||||||
|
* Level and the inventory item.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The inventory item's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: location_id
|
||||||
|
* in: path
|
||||||
|
* description: The inventory item's location id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl -X DELETE
|
||||||
|
* '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/invites/{id}
|
||||||
|
* operationId: DeleteInvitesId
|
||||||
|
* summary: Delete a Invite
|
||||||
|
* description: Delete a invite.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The invite's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/invites/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/price-lists/{id}
|
||||||
|
* operationId: DeletePriceListsId
|
||||||
|
* summary: Delete a Price List
|
||||||
|
* description: Delete a price list.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The price list's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/price-lists/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/pricing/rule-types/{id}
|
||||||
|
* operationId: DeletePricingRuleTypesId
|
||||||
|
* summary: Remove Rule Types from Pricing
|
||||||
|
* description: Remove a list of rule types from a pricing. This doesn't delete the
|
||||||
|
* Rule Type, only the association between the Rule Type and the pricing.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The pricing's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Pricing
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/products/{id}
|
||||||
|
* operationId: DeleteProductsId
|
||||||
|
* summary: Delete a Product
|
||||||
|
* description: Delete a product.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/products/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/products/{id}/options/{option_id}
|
||||||
|
* operationId: DeleteProductsIdOptionsOption_id
|
||||||
|
* summary: Remove Options from Product
|
||||||
|
* description: Remove a list of options from a product. This doesn't delete the
|
||||||
|
* Option, only the association between the Option and the product.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: option_id
|
||||||
|
* in: path
|
||||||
|
* description: The product's option id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/products/{id}/options/{option_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/products/{id}/variants/{variant_id}
|
||||||
|
* operationId: DeleteProductsIdVariantsVariant_id
|
||||||
|
* summary: Remove Variants from Product
|
||||||
|
* description: Remove a list of variants from a product. This doesn't delete the
|
||||||
|
* Variant, only the association between the Variant and the product.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: variant_id
|
||||||
|
* in: path
|
||||||
|
* description: The product's variant id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/promotions/{id}
|
||||||
|
* operationId: DeletePromotionsId
|
||||||
|
* summary: Delete a Promotion
|
||||||
|
* description: Delete a promotion.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The promotion's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/promotions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Promotions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/regions/{id}
|
||||||
|
* operationId: DeleteRegionsId
|
||||||
|
* summary: Delete a Region
|
||||||
|
* description: Delete a region.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The region's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/regions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Regions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/sales-channels/{id}
|
||||||
|
* operationId: DeleteSalesChannelsId
|
||||||
|
* summary: Delete a Sales Channel
|
||||||
|
* description: Delete a sales channel.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The sales channel's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/sales-channels/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Sales Channels
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/tax-rates/{id}
|
||||||
|
* operationId: DeleteTaxRatesId
|
||||||
|
* summary: Delete a Tax Rate
|
||||||
|
* description: Delete a tax rate.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The tax rate's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/tax-rates/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Tax Rates
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/tax-rates/{id}/rules/{rule_id}
|
||||||
|
* operationId: DeleteTaxRatesIdRulesRule_id
|
||||||
|
* summary: Remove Rules from Tax Rate
|
||||||
|
* description: Remove a list of rules from a tax rate. This doesn't delete the
|
||||||
|
* Rule, only the association between the Rule and the tax rate.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The tax rate's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: rule_id
|
||||||
|
* in: path
|
||||||
|
* description: The tax rate's rule id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/tax-rates/{id}/rules/{rule_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Tax Rates
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/tax-regions/{id}
|
||||||
|
* operationId: DeleteTaxRegionsId
|
||||||
|
* summary: Delete a Tax Region
|
||||||
|
* description: Delete a tax region.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The tax region's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/tax-regions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Tax Regions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [delete] /admin/users/{id}
|
||||||
|
* operationId: DeleteUsersId
|
||||||
|
* summary: Delete a User
|
||||||
|
* description: Delete a user.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The user's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X DELETE '{backend_url}/admin/users/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Users
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/api-keys
|
||||||
|
* operationId: GetApiKeys
|
||||||
|
* summary: List Api Keys
|
||||||
|
* description: Retrieve a list of api keys. The api keys can be filtered by fields
|
||||||
|
* such as `id`. The api keys can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/api-keys' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/api-keys/{id}
|
||||||
|
* operationId: GetApiKeysId
|
||||||
|
* summary: Get a Api Key
|
||||||
|
* description: Retrieve a api key by its ID. You can expand the api key's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The api key's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/api-keys/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/campaigns
|
||||||
|
* operationId: GetCampaigns
|
||||||
|
* summary: List Campaigns
|
||||||
|
* description: Retrieve a list of campaigns. The campaigns can be filtered by
|
||||||
|
* fields such as `id`. The campaigns can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/campaigns' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Campaigns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/campaigns/{id}
|
||||||
|
* operationId: GetCampaignsId
|
||||||
|
* summary: Get a Campaign
|
||||||
|
* description: Retrieve a campaign by its ID. You can expand the campaign's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The campaign's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/campaigns/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Campaigns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/collections
|
||||||
|
* operationId: GetCollections
|
||||||
|
* summary: List Collections
|
||||||
|
* description: Retrieve a list of collections. The collections can be filtered by
|
||||||
|
* fields such as `id`. The collections can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/collections' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Collections
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/collections/{id}
|
||||||
|
* operationId: GetCollectionsId
|
||||||
|
* summary: Get a Collection
|
||||||
|
* description: Retrieve a collection by its ID. You can expand the collection's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The collection's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/collections/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Collections
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/currencies
|
||||||
|
* operationId: GetCurrencies
|
||||||
|
* summary: List Currencies
|
||||||
|
* description: Retrieve a list of currencies. The currencies can be filtered by
|
||||||
|
* fields such as `id`. The currencies can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/currencies' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Currencies
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/currencies/{code}
|
||||||
|
* operationId: GetCurrenciesCode
|
||||||
|
* summary: Get a Currency
|
||||||
|
* description: Retrieve a currency by its ID. You can expand the currency's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: code
|
||||||
|
* in: path
|
||||||
|
* description: The currency's code.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/currencies/{code}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Currencies
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customer-groups
|
||||||
|
* operationId: GetCustomerGroups
|
||||||
|
* summary: List Customer Groups
|
||||||
|
* description: Retrieve a list of customer groups. The customer groups can be
|
||||||
|
* filtered by fields such as `id`. The customer groups can also be sorted or
|
||||||
|
* paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customer-groups' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customer-groups/{id}
|
||||||
|
* operationId: GetCustomerGroupsId
|
||||||
|
* summary: Get 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:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customer-groups/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customer-groups/{id}/customers
|
||||||
|
* operationId: GetCustomerGroupsIdCustomers
|
||||||
|
* summary: List Customers
|
||||||
|
* description: Retrieve a list of customers in a customer group. The customers can
|
||||||
|
* be filtered by fields like FILTER FIELDS. The customers can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customer-groups/{id}/customers' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customers
|
||||||
|
* operationId: GetCustomers
|
||||||
|
* summary: List Customers
|
||||||
|
* description: Retrieve a list of customers. The customers can be filtered by
|
||||||
|
* fields such as `id`. The customers can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customers' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customers/{id}
|
||||||
|
* operationId: GetCustomersId
|
||||||
|
* summary: Get a Customer
|
||||||
|
* description: Retrieve a customer by its ID. You can expand the customer's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customers/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customers/{id}/addresses
|
||||||
|
* operationId: GetCustomersIdAddresses
|
||||||
|
* summary: List Addresses
|
||||||
|
* description: Retrieve a list of addresses in a customer. The addresses can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The addresses can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customers/{id}/addresses' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/customers/{id}/addresses/{address_id}
|
||||||
|
* operationId: GetCustomersIdAddressesAddress_id
|
||||||
|
* summary: List Addresses
|
||||||
|
* description: Retrieve a list of addresses in a customer. The addresses can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The addresses can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: address_id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's address id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/inventory-items
|
||||||
|
* operationId: GetInventoryItems
|
||||||
|
* summary: List Inventory Items
|
||||||
|
* description: Retrieve a list of inventory items. The inventory items can be
|
||||||
|
* filtered by fields such as `id`. The inventory items can also be sorted or
|
||||||
|
* paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/inventory-items' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/inventory-items/{id}
|
||||||
|
* operationId: GetInventoryItemsId
|
||||||
|
* summary: Get a Inventory Item
|
||||||
|
* description: Retrieve a inventory item by its ID. You can expand the inventory
|
||||||
|
* item's relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The inventory item's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/inventory-items/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/invites
|
||||||
|
* operationId: GetInvites
|
||||||
|
* summary: List Invites
|
||||||
|
* description: Retrieve a list of invites. The invites can be filtered by fields
|
||||||
|
* such as `id`. The invites can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/invites' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/invites/{id}
|
||||||
|
* operationId: GetInvitesId
|
||||||
|
* summary: Get a Invite
|
||||||
|
* description: Retrieve a invite by its ID. You can expand the invite's relations
|
||||||
|
* or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The invite's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/invites/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/payments
|
||||||
|
* operationId: GetPayments
|
||||||
|
* summary: List Payments
|
||||||
|
* description: Retrieve a list of payments. The payments can be filtered by fields
|
||||||
|
* such as `id`. The payments can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/payments' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Payments
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/payments/{id}
|
||||||
|
* operationId: GetPaymentsId
|
||||||
|
* summary: Get a Payment
|
||||||
|
* description: Retrieve a payment by its ID. You can expand the payment's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The payment's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/payments/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Payments
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/price-lists
|
||||||
|
* operationId: GetPriceLists
|
||||||
|
* summary: List Price Lists
|
||||||
|
* description: Retrieve a list of price lists. The price lists can be filtered by
|
||||||
|
* fields such as `id`. The price lists can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/price-lists' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/price-lists/{id}
|
||||||
|
* operationId: GetPriceListsId
|
||||||
|
* summary: Get a Price List
|
||||||
|
* description: Retrieve a price list by its ID. You can expand the price list's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The price list's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/price-lists/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/pricing/rule-types
|
||||||
|
* operationId: GetPricingRuleTypes
|
||||||
|
* summary: List Pricing
|
||||||
|
* description: Retrieve a list of pricing. The pricing can be filtered by fields
|
||||||
|
* such as `id`. The pricing can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminGetPricingRuleTypesParams"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/pricing/rule-types' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Pricing
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/pricing/rule-types/{id}
|
||||||
|
* operationId: GetPricingRuleTypesId
|
||||||
|
* summary: List Rule Types
|
||||||
|
* description: Retrieve a list of rule types in a pricing. The rule types can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The rule types can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The pricing's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/pricing/rule-types/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Pricing
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products
|
||||||
|
* operationId: GetProducts
|
||||||
|
* summary: List Products
|
||||||
|
* description: Retrieve a list of products. The products can be filtered by fields
|
||||||
|
* such as `id`. The products can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminGetProductsParams"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products/{id}
|
||||||
|
* operationId: GetProductsId
|
||||||
|
* summary: Get a Product
|
||||||
|
* description: Retrieve a product by its ID. You can expand the product's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products/{id}/options
|
||||||
|
* operationId: GetProductsIdOptions
|
||||||
|
* summary: List Options
|
||||||
|
* description: Retrieve a list of options in a product. The options can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The options can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products/{id}/options' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products/{id}/options/{option_id}
|
||||||
|
* operationId: GetProductsIdOptionsOption_id
|
||||||
|
* summary: List Options
|
||||||
|
* description: Retrieve a list of options in a product. The options can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The options can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: option_id
|
||||||
|
* in: path
|
||||||
|
* description: The product's option id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products/{id}/options/{option_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products/{id}/variants
|
||||||
|
* operationId: GetProductsIdVariants
|
||||||
|
* summary: List Variants
|
||||||
|
* description: Retrieve a list of variants in a product. The variants can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The variants can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products/{id}/variants' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/products/{id}/variants/{variant_id}
|
||||||
|
* operationId: GetProductsIdVariantsVariant_id
|
||||||
|
* summary: List Variants
|
||||||
|
* description: Retrieve a list of variants in a product. The variants can be
|
||||||
|
* filtered by fields like FILTER FIELDS. The variants can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: variant_id
|
||||||
|
* in: path
|
||||||
|
* description: The product's variant id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/products/{id}/variants/{variant_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Products
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/promotions
|
||||||
|
* operationId: GetPromotions
|
||||||
|
* summary: List Promotions
|
||||||
|
* description: Retrieve a list of promotions. The promotions can be filtered by
|
||||||
|
* fields such as `id`. The promotions can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/promotions' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Promotions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/promotions/{id}
|
||||||
|
* operationId: GetPromotionsId
|
||||||
|
* summary: Get a Promotion
|
||||||
|
* description: Retrieve a promotion by its ID. You can expand the promotion's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The promotion's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminGetPromotionsParams"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/promotions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Promotions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/regions
|
||||||
|
* operationId: GetRegions
|
||||||
|
* summary: List Regions
|
||||||
|
* description: Retrieve a list of regions. The regions can be filtered by fields
|
||||||
|
* such as `id`. The regions can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/regions' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Regions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/regions/{id}
|
||||||
|
* operationId: GetRegionsId
|
||||||
|
* summary: Get a Region
|
||||||
|
* description: Retrieve a region by its ID. You can expand the region's relations
|
||||||
|
* or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The region's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/regions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Regions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/sales-channels
|
||||||
|
* operationId: GetSalesChannels
|
||||||
|
* summary: List Sales Channels
|
||||||
|
* description: Retrieve a list of sales channels. The sales channels can be
|
||||||
|
* filtered by fields such as `id`. The sales channels can also be sorted or
|
||||||
|
* paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/sales-channels' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Sales Channels
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/sales-channels/{id}
|
||||||
|
* operationId: GetSalesChannelsId
|
||||||
|
* summary: Get a Sales Channel
|
||||||
|
* description: Retrieve a sales channel by its ID. You can expand the sales
|
||||||
|
* channel's relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The sales channel's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/sales-channels/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Sales Channels
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/stores
|
||||||
|
* operationId: GetStores
|
||||||
|
* summary: List Stores
|
||||||
|
* description: Retrieve a list of stores. The stores can be filtered by fields
|
||||||
|
* such as `id`. The stores can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/stores' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Stores
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/stores/{id}
|
||||||
|
* operationId: GetStoresId
|
||||||
|
* summary: Get a Store
|
||||||
|
* description: Retrieve a store by its ID. You can expand the store's relations or
|
||||||
|
* select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The store's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/stores/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Stores
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/tax-rates
|
||||||
|
* operationId: GetTaxRates
|
||||||
|
* summary: List Tax Rates
|
||||||
|
* description: Retrieve a list of tax rates. The tax rates can be filtered by
|
||||||
|
* fields such as `id`. The tax rates can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/tax-rates' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Tax Rates
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/tax-rates/{id}
|
||||||
|
* operationId: GetTaxRatesId
|
||||||
|
* summary: Get a Tax Rate
|
||||||
|
* description: Retrieve a tax rate by its ID. You can expand the tax rate's
|
||||||
|
* relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The tax rate's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/tax-rates/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Tax Rates
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/users
|
||||||
|
* operationId: GetUsers
|
||||||
|
* summary: List Users
|
||||||
|
* description: Retrieve a list of users. The users can be filtered by fields such
|
||||||
|
* as `id`. The users can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/users' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Users
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/users/{id}
|
||||||
|
* operationId: GetUsersId
|
||||||
|
* summary: Get a User
|
||||||
|
* description: Retrieve a user by its ID. You can expand the user's relations or
|
||||||
|
* select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The user's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/users/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Users
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/users/me
|
||||||
|
* operationId: GetUsersMe
|
||||||
|
* summary: List Users
|
||||||
|
* description: Retrieve a list of users. The users can be filtered by fields such
|
||||||
|
* as `id`. The users can also be sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/users/me' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Users
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/workflows-executions
|
||||||
|
* operationId: GetWorkflowsExecutions
|
||||||
|
* summary: List Workflows Executions
|
||||||
|
* description: Retrieve a list of workflows executions. The workflows executions
|
||||||
|
* can be filtered by fields such as `id`. The workflows executions can also be
|
||||||
|
* sorted or paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/workflows-executions' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Workflows Executions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/workflows-executions/{id}
|
||||||
|
* operationId: GetWorkflowsExecutionsId
|
||||||
|
* summary: Get a Workflows Execution
|
||||||
|
* description: Retrieve a workflows execution by its ID. You can expand the
|
||||||
|
* workflows execution's relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/workflows-executions/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Workflows Executions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+53
@@ -0,0 +1,53 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}
|
||||||
|
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id
|
||||||
|
* summary: "List "
|
||||||
|
* description: Retrieve a list of in a workflows execution. The can be filtered
|
||||||
|
* by fields like FILTER FIELDS. The can also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: workflow_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's workflow id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: transaction_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's transaction id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl
|
||||||
|
* '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}'
|
||||||
|
* \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Workflows Executions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+60
@@ -0,0 +1,60 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe
|
||||||
|
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
|
||||||
|
* summary: List Subscribes
|
||||||
|
* description: Retrieve a list of subscribes in a workflows execution. The
|
||||||
|
* subscribes can be filtered by fields like FILTER FIELDS. The subscribes can
|
||||||
|
* also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: workflow_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's workflow id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: transaction_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's transaction id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: step_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's step id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl
|
||||||
|
* '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe'
|
||||||
|
* \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Workflows Executions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+45
@@ -0,0 +1,45 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /admin/workflows-executions/{workflow_id}/subscribe
|
||||||
|
* operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
|
||||||
|
* summary: List Subscribes
|
||||||
|
* description: Retrieve a list of subscribes in a workflows execution. The
|
||||||
|
* subscribes can be filtered by fields like FILTER FIELDS. The subscribes can
|
||||||
|
* also be paginated.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: workflow_id
|
||||||
|
* in: path
|
||||||
|
* description: The workflows execution's workflow id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/admin/workflows-executions/{workflow_id}/subscribe' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Workflows Executions
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/api-keys
|
||||||
|
* operationId: PostApiKeys
|
||||||
|
* summary: Create Api Key
|
||||||
|
* description: Create a api key.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/api-keys' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/api-keys/{id}
|
||||||
|
* operationId: PostApiKeysId
|
||||||
|
* summary: Update a Api Key
|
||||||
|
* description: Update a api key's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The api key's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/api-keys/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/api-keys/{id}/revoke
|
||||||
|
* operationId: PostApiKeysIdRevoke
|
||||||
|
* summary: Add Revokes to Api Key
|
||||||
|
* description: Add a list of revokes to a api key.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The api key's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Api Keys
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/campaigns
|
||||||
|
* operationId: PostCampaigns
|
||||||
|
* summary: Create Campaign
|
||||||
|
* description: Create a campaign.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/campaigns' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Campaigns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/campaigns/{id}
|
||||||
|
* operationId: PostCampaignsId
|
||||||
|
* summary: Update a Campaign
|
||||||
|
* description: Update a campaign's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The campaign's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostCampaignsReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/campaigns/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "name": "Moriah"
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Campaigns
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/collections
|
||||||
|
* operationId: PostCollections
|
||||||
|
* summary: Create Collection
|
||||||
|
* description: Create a collection.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/collections' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Collections
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/collections/{id}
|
||||||
|
* operationId: PostCollectionsId
|
||||||
|
* summary: Update a Collection
|
||||||
|
* description: Update a collection's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The collection's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/collections/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Collections
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customer-groups
|
||||||
|
* operationId: PostCustomerGroups
|
||||||
|
* summary: Create Customer Group
|
||||||
|
* description: Create a customer group.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customer-groups' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customer-groups/{id}
|
||||||
|
* operationId: PostCustomerGroupsId
|
||||||
|
* summary: Update a Customer Group
|
||||||
|
* description: Update a customer group's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customer-groups/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+56
@@ -0,0 +1,56 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customer-groups/{id}/customers/batch
|
||||||
|
* operationId: PostCustomerGroupsIdCustomersBatch
|
||||||
|
* summary: Add Customers to Customer Group
|
||||||
|
* description: Add a list of customers to a customer group.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "customer_ids": [
|
||||||
|
* {
|
||||||
|
* "id": "id_dx2Wieq4uGG"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+56
@@ -0,0 +1,56 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customer-groups/{id}/customers/remove
|
||||||
|
* operationId: PostCustomerGroupsIdCustomersRemove
|
||||||
|
* summary: Add Removes to Customer Group
|
||||||
|
* description: Add a list of removes to a customer group.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer group's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "customer_ids": [
|
||||||
|
* {
|
||||||
|
* "id": "id_oAhMZi39hsjIOqPA6"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Customer Groups
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customers
|
||||||
|
* operationId: PostCustomers
|
||||||
|
* summary: Create Customer
|
||||||
|
* description: Create a customer.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customers' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customers/{id}
|
||||||
|
* operationId: PostCustomersId
|
||||||
|
* summary: Update a Customer
|
||||||
|
* description: Update a customer's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customers/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customers/{id}/addresses
|
||||||
|
* operationId: PostCustomersIdAddresses
|
||||||
|
* summary: Add Addresses to Customer
|
||||||
|
* description: Add a list of addresses to a customer.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customers/{id}/addresses' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+49
@@ -0,0 +1,49 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/customers/{id}/addresses/{address_id}
|
||||||
|
* operationId: PostCustomersIdAddressesAddress_id
|
||||||
|
* summary: Add Addresses to Customer
|
||||||
|
* description: Add a list of addresses to a customer.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: address_id
|
||||||
|
* in: path
|
||||||
|
* description: The customer's address id.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Customers
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+60
@@ -0,0 +1,60 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/add
|
||||||
|
* operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd
|
||||||
|
* summary: Add Adds to Fulfillment
|
||||||
|
* description: Add a list of adds to a fulfillment.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The fulfillment's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl -X POST
|
||||||
|
* '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
*
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
*
|
||||||
|
* --data-raw '{
|
||||||
|
* "rules": [
|
||||||
|
* {
|
||||||
|
* "attribute": "{value}"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Fulfillment
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+60
@@ -0,0 +1,60 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/remove
|
||||||
|
* operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove
|
||||||
|
* summary: Add Removes to Fulfillment
|
||||||
|
* description: Add a list of removes to a fulfillment.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The fulfillment's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemove\
|
||||||
|
* Req"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: >-
|
||||||
|
* curl -X POST
|
||||||
|
* '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove'
|
||||||
|
* \
|
||||||
|
*
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
*
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
*
|
||||||
|
* --data-raw '{
|
||||||
|
* "rule_ids": [
|
||||||
|
* "{value}"
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Fulfillment
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/inventory-items
|
||||||
|
* operationId: PostInventoryItems
|
||||||
|
* summary: Create Inventory Item
|
||||||
|
* description: Create a inventory item.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostInventoryItemsReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/inventory-items' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+53
@@ -0,0 +1,53 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/inventory-items/{id}/location-levels
|
||||||
|
* operationId: PostInventoryItemsIdLocationLevels
|
||||||
|
* summary: Add Location Levels to Inventory Item
|
||||||
|
* description: Add a list of location levels to a inventory item.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The inventory item's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "location_id": "{value}",
|
||||||
|
* "stocked_quantity": 1506469662949376
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Inventory Items
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/invites
|
||||||
|
* operationId: PostInvites
|
||||||
|
* summary: Create Invite
|
||||||
|
* description: Create a invite.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/invites' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/invites/{id}/resend
|
||||||
|
* operationId: PostInvitesIdResend
|
||||||
|
* summary: Add Resends to Invite
|
||||||
|
* description: Add a list of resends to a invite.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The invite's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/invites/{id}/resend' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/invites/accept
|
||||||
|
* operationId: PostInvitesAccept
|
||||||
|
* summary: Create Invite
|
||||||
|
* description: Create a invite.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostInvitesInviteAcceptReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/invites/accept' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "first_name": "{value}",
|
||||||
|
* "last_name": "{value}"
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Invites
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/payments/{id}/capture
|
||||||
|
* operationId: PostPaymentsIdCapture
|
||||||
|
* summary: Add Captures to Payment
|
||||||
|
* description: Add a list of captures to a payment.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The payment's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPaymentsCapturesReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/payments/{id}/capture' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Payments
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/payments/{id}/refund
|
||||||
|
* operationId: PostPaymentsIdRefund
|
||||||
|
* summary: Add Refunds to Payment
|
||||||
|
* description: Add a list of refunds to a payment.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The payment's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPaymentsRefundsReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/payments/{id}/refund' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}'
|
||||||
|
* tags:
|
||||||
|
* - Payments
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/price-lists
|
||||||
|
* operationId: PostPriceLists
|
||||||
|
* summary: Create Price List
|
||||||
|
* description: Create a price list.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters: []
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPriceListsReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/price-lists' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "title": "{value}",
|
||||||
|
* "description": "{value}",
|
||||||
|
* "prices": [
|
||||||
|
* {
|
||||||
|
* "currency_code": "{value}",
|
||||||
|
* "amount": 1270314195484672,
|
||||||
|
* "variant_id": "{value}"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/price-lists/{id}
|
||||||
|
* operationId: PostPriceListsId
|
||||||
|
* summary: Update a Price List
|
||||||
|
* description: Update a price list's details.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The price list's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPriceListsPriceListReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/price-lists/{id}' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "prices": [
|
||||||
|
* {
|
||||||
|
* "currency_code": "{value}",
|
||||||
|
* "amount": 1670236243755008,
|
||||||
|
* "variant_id": "{value}"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/price-lists/{id}/prices/batch/add
|
||||||
|
* operationId: PostPriceListsIdPricesBatchAdd
|
||||||
|
* summary: Add Adds to Price List
|
||||||
|
* description: Add a list of adds to a price list.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The price list's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "prices": [
|
||||||
|
* {
|
||||||
|
* "currency_code": "{value}",
|
||||||
|
* "amount": 6595965345595392,
|
||||||
|
* "variant_id": "{value}"
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+54
@@ -0,0 +1,54 @@
|
|||||||
|
/**
|
||||||
|
* @oas [post] /admin/price-lists/{id}/prices/batch/remove
|
||||||
|
* operationId: PostPriceListsIdPricesBatchRemove
|
||||||
|
* summary: Add Removes to Price List
|
||||||
|
* description: Add a list of removes to a price list.
|
||||||
|
* x-authenticated: true
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The price list's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* security:
|
||||||
|
* - api_token: []
|
||||||
|
* - cookie_auth: []
|
||||||
|
* - jwt_token: []
|
||||||
|
* requestBody:
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \
|
||||||
|
* -H 'x-medusa-access-token: {api_token}' \
|
||||||
|
* -H 'Content-Type: application/json' \
|
||||||
|
* --data-raw '{
|
||||||
|
* "ids": [
|
||||||
|
* "{value}"
|
||||||
|
* ]
|
||||||
|
* }'
|
||||||
|
* tags:
|
||||||
|
* - Price Lists
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
Loaded 100 of 198 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user