docs: generate OAS manually for 2.7.0 (#12158)

* original changes

* changes

* fixes for delete operations

* generate oas
This commit is contained in:
Shahed Nasser
2025-04-11 16:41:39 +03:00
committed by GitHub
parent f8023f419e
commit cd66cdd2bb
1028 changed files with 29859 additions and 286 deletions
@@ -6,9 +6,6 @@ info:
name: MIT
url: https://github.com/medusajs/medusa/blob/develop/LICENSE
tags:
- name: Auth
description: >
Auth API routes allow you to manage an admin user's authentication.
- name: Api Keys
description: >
API keys can be used for authentication or resource-scoping.
@@ -20,9 +17,12 @@ tags:
These API routes allow admin users to manage both publishable and secret API keys.
externalDocs:
description: Learn more about the API Key Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key
url: https://docs.medusajs.com/resources/commerce-modules/api-key
x-associatedSchema:
$ref: "#/components/schemas/AdminApiKey"
- name: Auth
description: |
Auth API routes allow you to manage an admin user's authentication.
- name: Campaigns
description: >
A campaign is a group of promotions that have the same conditions, such as
@@ -32,7 +32,7 @@ tags:
These API routes allow admin users to manage campaigns, their conditions, and promotions that belong to them.
externalDocs:
description: Learn more about campaigns.
url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign
url: https://docs.medusajs.com/resources/commerce-modules/promotion/campaign
x-associatedSchema:
$ref: "#/components/schemas/AdminCampaign"
- name: Claims
@@ -46,7 +46,7 @@ tags:
$ref: "#/components/schemas/AdminClaim"
externalDocs:
description: Learn more about order claims.
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/claim
url: https://docs.medusajs.com/resources/commerce-modules/order/claim
- name: Collections
description: >
A product collection organizes products into a collection for marketing
@@ -65,7 +65,7 @@ tags:
Currencies are defined by the Currency Module. Currency API Routes allow admins to list and update currencies.
externalDocs:
description: Learn more about the Currency Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/currency
url: https://docs.medusajs.com/resources/commerce-modules/currency
x-associatedSchema:
$ref: "#/components/schemas/AdminCurrency"
- name: Customer Groups
@@ -80,7 +80,7 @@ tags:
These API routes allow admin users to manage groups and the customers in them.
externalDocs:
description: Learn more about the Customer Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/customer
url: https://docs.medusajs.com/resources/commerce-modules/customer
x-associatedSchema:
$ref: "#/components/schemas/AdminCustomerGroup"
- name: Customers
@@ -92,7 +92,7 @@ tags:
These API routes allow admin users to manage customers in their store.
externalDocs:
description: Learn more about the Customer Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/customer
url: https://docs.medusajs.com/resources/commerce-modules/customer
x-associatedSchema:
$ref: "#/components/schemas/AdminCustomer"
- name: Draft Orders
@@ -105,7 +105,7 @@ tags:
These API routes allow admin users to create and manage draft orders.
externalDocs:
description: Learn more about the Order Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/order
url: https://docs.medusajs.com/resources/commerce-modules/order
x-associatedSchema:
$ref: "#/components/schemas/AdminDraftOrder"
- name: Exchanges
@@ -117,7 +117,7 @@ tags:
These API routes allow admin users t create and manage exchanges.
externalDocs:
description: Learn more about the order exchanges.
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/exchange
url: https://docs.medusajs.com/resources/commerce-modules/order/exchange
x-associatedSchema:
$ref: "#/components/schemas/AdminExchange"
- name: Fulfillment Providers
@@ -129,7 +129,7 @@ tags:
Fulfillment providers are installed as module providers.
externalDocs:
description: Learn more about the fulfillment providers and how to create them.
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/fulfillment-provider
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/fulfillment-provider
x-associatedSchema:
$ref: "#/components/schemas/AdminFulfillmentProvider"
- name: Fulfillment Sets
@@ -144,7 +144,7 @@ tags:
These API routes allow admin users to manage fulfillment sets.
externalDocs:
description: Learn more about fulfillment sets.
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/concepts
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminFulfillmentSet"
- name: Fulfillments
@@ -156,7 +156,7 @@ tags:
These API routes allow admin users to manage fulfillments.
externalDocs:
description: Learn more about fulfillments.
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/item-fulfillment
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/item-fulfillment
x-associatedSchema:
$ref: "#/components/schemas/AdminFulfillment"
- name: Inventory Items
@@ -166,7 +166,7 @@ tags:
These API routes allow admin users to manage inventory items.
externalDocs:
description: Learn more about inventory items.
url: https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts
url: https://docs.medusajs.com/resources/commerce-modules/inventory/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminInventoryItem"
- name: Invites
@@ -178,7 +178,7 @@ tags:
These API routes allow admin users to manage invites.
externalDocs:
description: Learn more about the User Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/user
url: https://docs.medusajs.com/resources/commerce-modules/user
x-associatedSchema:
$ref: "#/components/schemas/AdminInvite"
- name: Notifications
@@ -205,7 +205,7 @@ tags:
These API routes allow admin users to make edits to an order and manage those edits.
externalDocs:
description: Learn more about the Order Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/order
url: https://docs.medusajs.com/resources/commerce-modules/order
- name: Orders
description: |
An order is a purchase made by a customer through a storefront.
@@ -215,7 +215,7 @@ tags:
These API routes allow admin users to view and manage orders.
externalDocs:
description: Learn more about the orders
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts
url: https://docs.medusajs.com/resources/commerce-modules/order/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminOrder"
- name: Payment Collections
@@ -233,7 +233,7 @@ tags:
These API routes allow admin users to manage payment collections.
externalDocs:
description: Learn more about payment collections.
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-collection
url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-collection
x-associatedSchema:
$ref: "#/components/schemas/AdminPaymentCollection"
- name: Payments
@@ -248,9 +248,21 @@ tags:
These API routes allow admin users to manage payments.
externalDocs:
description: Learn more about payments.
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment
url: https://docs.medusajs.com/resources/commerce-modules/payment/payment
x-associatedSchema:
$ref: "#/components/schemas/AdminPayment"
- name: Plugins
description: >
A plugin is a package of reusable Medusa customizations that you can install in any Medusa application.
Plugins can be used to add new functionality, such as wishlists, or integrate third-party services, such as payment providers.
These API routes allow admin users to retrieve plugins installed in their Medusa application.
externalDocs:
description: Learn more about plugins.
url: https://docs.medusajs.com/learn/fundamentals/plugins
x-associatedSchema:
$ref: "#/components/schemas/AdminPlugin"
- name: Price Lists
description: >
A price list is a group of prices applied if the specified conditions and
@@ -263,7 +275,7 @@ tags:
These API routes allow admin users to manage price lists.
externalDocs:
description: Learn more about price lists.
url: https://docs.medusajs.com/v2/resources/commerce-modules/pricing/concepts#price-list
url: https://docs.medusajs.com/resources/commerce-modules/pricing/concepts#price-list
x-associatedSchema:
$ref: "#/components/schemas/AdminPriceList"
- name: Price Preferences
@@ -275,7 +287,7 @@ tags:
These API routes allow admin users to manage whether a region or currency is tax inclusive.
externalDocs:
description: Learn more about tax-inclusiveness and the role of a price preference.
url: https://docs.medusajs.com/v2/resources/commerce-modules/pricing/tax-inclusive-pricing
url: https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing
x-associatedSchema:
$ref: "#/components/schemas/AdminPricePreference"
- name: Product Categories
@@ -289,7 +301,7 @@ tags:
These API routes allow admin users to manage categories and the products in them.
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
url: https://docs.medusajs.com/resources/commerce-modules/product
x-associatedSchema:
$ref: "#/components/schemas/AdminProductCategory"
- name: Product Tags
@@ -304,7 +316,7 @@ tags:
These API routes allow admin users to manage product tags.
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
url: https://docs.medusajs.com/resources/commerce-modules/product
x-associatedSchema:
$ref: "#/components/schemas/AdminProductTag"
- name: Product Types
@@ -316,7 +328,7 @@ tags:
These API routes allow admin users to manage product types.
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
url: https://docs.medusajs.com/resources/commerce-modules/product
x-associatedSchema:
$ref: "#/components/schemas/AdminProductType"
- name: Product Variants
@@ -330,7 +342,7 @@ tags:
These API routes allow admin users to manage product variants.
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
url: https://docs.medusajs.com/resources/commerce-modules/product
x-associatedSchema:
$ref: "#/components/schemas/AdminProductVariant"
- name: Products
@@ -348,7 +360,7 @@ tags:
These API routes allow admin users to manage products.
externalDocs:
description: Learn more about the Product Module
url: https://docs.medusajs.com/v2/resources/commerce-modules/product
url: https://docs.medusajs.com/resources/commerce-modules/product
x-associatedSchema:
$ref: "#/components/schemas/AdminProduct"
- name: Promotions
@@ -369,7 +381,7 @@ tags:
These API routes allow admin users to manage promotions.
externalDocs:
description: Learn more about promotions.
url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts
url: https://docs.medusajs.com/resources/commerce-modules/promotion/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminPromotion"
- name: Refund Reasons
@@ -390,7 +402,7 @@ tags:
These API routes allow admin users to manage regions, their providers, and more.
externalDocs:
description: Learn more about the Region Module.
url: https://docs.medusajs.com/v2/resources/commerce-modules/region
url: https://docs.medusajs.com/resources/commerce-modules/region
x-associatedSchema:
$ref: "#/components/schemas/AdminRegion"
- name: Reservations
@@ -404,7 +416,7 @@ tags:
These API routes allow admin users to manage reservations.
externalDocs:
description: Learn more about reservations and other inventory concepts.
url: https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts
url: https://docs.medusajs.com/resources/commerce-modules/inventory/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminReservation"
- name: Return Reasons
@@ -427,7 +439,7 @@ tags:
These API routes allow admin users to manage returns.
externalDocs:
description: Learn more about order returns.
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/return
url: https://docs.medusajs.com/resources/commerce-modules/order/return
x-associatedSchema:
$ref: "#/components/schemas/AdminReturn"
- name: Sales Channels
@@ -439,7 +451,7 @@ tags:
These API routes allow admins to manage sales channels and the products available in them.
externalDocs:
description: Learn more about the Sales Channel Module.
url: https://docs.medusajs.com/v2/resources/commerce-modules/sales-channel
url: https://docs.medusajs.com/resources/commerce-modules/sales-channel
x-associatedSchema:
$ref: "#/components/schemas/AdminSalesChannel"
- name: Shipping Options
@@ -456,7 +468,7 @@ tags:
These API routes allow admins to manage shipping options.
externalDocs:
description: Learn more about shipping options.
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option
x-associatedSchema:
$ref: "#/components/schemas/AdminShippingOption"
- name: Shipping Profiles
@@ -469,7 +481,7 @@ tags:
These API routes allow admin users to manage shipping profiles.
externalDocs:
description: Learn more about shipping profiles and other fulfillment concepts.
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/concepts#shipping-profile
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/concepts#shipping-profile
x-associatedSchema:
$ref: "#/components/schemas/AdminShippingProfile"
- name: Stock Locations
@@ -486,7 +498,7 @@ tags:
These API routes allow admin users to manage stock locations and their linked data.
externalDocs:
description: Learn more about stock locations.
url: https://docs.medusajs.com/v2/resources/commerce-modules/stock-location/concepts
url: https://docs.medusajs.com/resources/commerce-modules/stock-location/concepts
x-associatedSchema:
$ref: "#/components/schemas/AdminStockLocation"
- name: Stores
@@ -501,7 +513,7 @@ tags:
These API routes allow admin users to manage their store.
externalDocs:
description: Learn more about the Store Module.
url: https://docs.medusajs.com/v2/resources/commerce-modules/store
url: https://docs.medusajs.com/resources/commerce-modules/store
x-associatedSchema:
$ref: "#/components/schemas/AdminStore"
- name: Tax Rates
@@ -516,7 +528,7 @@ tags:
These API routes allow admin users to manage tax rates and their rules.
externalDocs:
description: Learn more about tax rates and rules.
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules
url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules
x-associatedSchema:
$ref: "#/components/schemas/AdminTaxRate"
- name: Tax Regions
@@ -531,7 +543,7 @@ tags:
These API routes allow admin users to manage tax regions.
externalDocs:
description: Learn more about tax regions.
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-region
url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-region
x-associatedSchema:
$ref: "#/components/schemas/AdminTaxRegion"
- name: Uploads
@@ -543,7 +555,7 @@ tags:
You can upload public files, such as product images, or private files, such as CSV files used to import products.
externalDocs:
description: Check out available file module providers.
url: https://docs.medusajs.com/v2/resources/architectural-modules/file
url: https://docs.medusajs.com/resources/architectural-modules/file
- name: Users
description: >
A user is an admin user that can authenticate and perform functionalities
@@ -556,7 +568,7 @@ tags:
These API routes allow admin users to manage their team.
externalDocs:
description: Learn more about the User Module.
url: https://docs.medusajs.com/v2/resources/commerce-modules/user
url: https://docs.medusajs.com/resources/commerce-modules/user
x-associatedSchema:
$ref: "#/components/schemas/AdminUser"
- name: Workflows Executions
@@ -568,7 +580,7 @@ tags:
Depending on the workflow engine you use, executions may only be retained for a short while, or only until the Medusa application is restarted.
externalDocs:
description: Check out available Workflow Engine Modules
url: https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine
url: https://docs.medusajs.com/resources/architectural-modules/workflow-engine
servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
@@ -753,4 +765,4 @@ components:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false
x-is-auth: false
@@ -21,7 +21,7 @@ tags:
These API routes allow customers to create and manage their cart, and place an order.
externalDocs:
description: How to implement cart functionality in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/cart
url: https://docs.medusajs.com/resources/storefront-development/cart
x-associatedSchema:
$ref: "#/components/schemas/StoreCart"
- name: Collections
@@ -33,7 +33,7 @@ tags:
These API routes allow customers to browse collections and their products.
externalDocs:
description: How to list product collections in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
url: https://docs.medusajs.com/resources/storefront-development/products/collections/list
x-associatedSchema:
$ref: "#/components/schemas/StoreCollection"
- name: Currencies
@@ -48,7 +48,7 @@ tags:
These API routes allow customers to browse currencies.
externalDocs:
description: How to retrieve product variant prices in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
url: https://docs.medusajs.com/resources/storefront-development/products/price
x-associatedSchema:
$ref: "#/components/schemas/StoreCurrency"
- name: Customers
@@ -62,7 +62,7 @@ tags:
These API routes allow customers to create and manage their accounts.
externalDocs:
description: How to implement customer account functionalities in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/customers
url: https://docs.medusajs.com/resources/storefront-development/customers
x-associatedSchema:
$ref: "#/components/schemas/StoreCustomer"
- name: Orders
@@ -80,7 +80,7 @@ tags:
Use these API routes during checkout to set the cart's payment provider and authorize its payment session.
externalDocs:
description: How to implement payment during checkout.
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
url: https://docs.medusajs.com/resources/storefront-development/checkout/payment
x-associatedSchema:
$ref: "#/components/schemas/StorePaymentCollection"
- name: Payment Providers
@@ -94,7 +94,7 @@ tags:
These API routes allow customers to view available payment providers in their region.
externalDocs:
description: How to implement payment during checkout.
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
url: https://docs.medusajs.com/resources/storefront-development/checkout/payment
x-associatedSchema:
$ref: "#/components/schemas/StorePaymentProvider"
- name: Product Categories
@@ -104,7 +104,7 @@ tags:
These API routes allow customers to browse categories and their products.
externalDocs:
description: How to list product categories in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
url: https://docs.medusajs.com/resources/storefront-development/products/categories/list
x-associatedSchema:
$ref: "#/components/schemas/StoreProductCategory"
- name: Product Tags
@@ -124,7 +124,7 @@ tags:
These API routes allow customers to browse products.
externalDocs:
description: How to list products, get their prices, and more in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/products
url: https://docs.medusajs.com/resources/storefront-development/products
x-associatedSchema:
$ref: "#/components/schemas/StoreProduct"
- name: Regions
@@ -139,7 +139,7 @@ tags:
Use these API routes to retrieve available regions in the store.
externalDocs:
description: How to retrieve and store selected region in a storefront.
url: https://docs.medusajs.com/v2/resources/storefront-development/regions
url: https://docs.medusajs.com/resources/storefront-development/regions
x-associatedSchema:
$ref: "#/components/schemas/StoreRegion"
- name: Return
@@ -170,7 +170,7 @@ tags:
These API routes allow customers to retrieve available shipping options for their context.
externalDocs:
description: How to implement shipping during checkout.
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
url: https://docs.medusajs.com/resources/storefront-development/checkout/shipping
x-associatedSchema:
$ref: "#/components/schemas/StoreShippingOption"
servers:
@@ -17,6 +17,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.apiKey.delete("apk_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -17,6 +17,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.campaign.delete("procamp_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.removeItem(
* "claim_123",
* "ordchact_123",
* )
* .then(({ claim }) => {
* console.log(claim)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -26,6 +26,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.removeInboundItem(
* "claim_123",
* "ordchact_123",
* )
* .then(({ return: returnData }) => {
* console.log(returnData)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -26,6 +26,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.deleteInboundShipping(
* "claim_123",
* "ordchact_123",
* )
* .then(({ return: returnData }) => {
* console.log(returnData)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.removeOutboundItem(
* "claim_123",
* "ordchact_123",
* )
* .then(({ claim }) => {
* console.log(claim)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.deleteOutboundShipping(
* "claim_123",
* "ordchact_123",
* )
* .then(({ claim }) => {
* console.log(claim)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -16,6 +16,25 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.cancelRequest(
* "claim_123",
* )
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productCollection.delete("pcol_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -17,6 +17,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customerGroup.delete("cusgroup_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.delete("cus_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -34,6 +34,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.deleteAddress("cus_123", "cus_addr_123")
* .then(({ customer }) => {
* console.log(customer)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -0,0 +1,62 @@
/**
* @oas [delete] /admin/draft-orders/{id}/edit
* operationId: DeleteDraftOrdersIdEdit
* summary: Cancel Edit on Draft Order
* x-sidebar-summary: Cancel Edit
* description: Cancel an unconfirmed edit on a draft order.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The draft order's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.cancelEdit("order_123")
* .then(({ id, object, deleted }) => {
* console.log(id, object, deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Draft Orders
* 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"
* x-workflow: cancelDraftOrderEditWorkflow
*
*/
@@ -0,0 +1,71 @@
/**
* @oas [delete] /admin/draft-orders/{id}/edit/items/{action_id}
* operationId: DeleteDraftOrdersIdEditItemsAction_id
* summary: Remove Item from Draft Order
* x-sidebar-summary: Remove Item
* description: |
* Remove an order item from a draft order by the ID of the item's `ITEM_REMOVE` action.
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The draft order's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The ID of the order item's `ITEM_REMOVE` action.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.removeActionItem("order_123", "action_123")
* .then(({ draft_order_preview }) => {
* console.log(draft_order_preview)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/items/{action_id}' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Draft Orders
* 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"
* x-workflow: removeDraftOrderActionItemWorkflow
*
*/
@@ -0,0 +1,70 @@
/**
* @oas [delete] /admin/draft-orders/{id}/edit/promotions
* operationId: DeleteDraftOrdersIdEditPromotions
* summary: Remove Promotions from Draft Order
* x-sidebar-summary: Remove Promotions
* description: Remove specified promotions from a draft order.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The draft order's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.removePromotions("order_123", {
* promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/promotions' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminDraftOrderPreviewResponse"
* "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"
* x-workflow: removeDraftOrderPromotionsWorkflow
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminRemoveDraftOrderPromotions"
*
*/
@@ -0,0 +1,71 @@
/**
* @oas [delete] /admin/draft-orders/{id}/edit/shipping-methods/{action_id}
* operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id
* summary: Remove Shipping Method from Draft Order
* x-sidebar-summary: Remove Shipping Method
* description: |
* Remove the shipping method in a draft order using the `ID` of the method's `SHIPPING_ADD` action.
*
* Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The draft order's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.removeShippingMethod("order_123", "action_123")
* .then(({ draft_order_preview }) => {
* console.log(draft_order_preview)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/shipping-methods/{action_id}' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Draft Orders
* 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"
* x-workflow: removeDraftOrderActionShippingMethodWorkflow
*
*/
@@ -26,6 +26,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.removeInboundItem(
* "exchange_123",
* "ordchact_123",
* )
* .then(({ return: returnData }) => {
* console.log(returnData)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -26,6 +26,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.deleteInboundShipping(
* "exchange_123",
* "ordchact_123",
* )
* .then(({ return: returnData }) => {
* console.log(returnData)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.removeOutboundItem(
* "exchange_123",
* "ordchact_123",
* )
* .then(({ exchange }) => {
* console.log(exchange)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.deleteOutboundShipping(
* "exchange_123",
* "ordchact_123",
* )
* .then(({ exchange }) => {
* console.log(exchange)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\\ -H 'Authorization: Bearer {access_token}'"
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.cancel("exchange_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.fulfillmentSet.delete("fset_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -23,6 +23,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.fulfillmentSet.deleteServiceZone(
* "fset_123",
* "serzo_123",
* )
* .then(({ deleted, parent: fulfillmentSet }) => {
* console.log(deleted, fulfillmentSet)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.inventoryItem.delete("iitem_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.inventoryItem.deleteLevel(
* "iitem_123",
* "sloc_123",
* )
* .then(({ deleted, parent: inventoryItem }) => {
* console.log(deleted, inventoryItem)
* })
* - lang: Shell
* label: cURL
* source: "curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \\ -H 'Authorization: Bearer {access_token}'"
@@ -12,6 +12,23 @@
* schema:
* type: string
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.invite.delete("invite_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/admin/invites/{id}'
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.orderEdit.cancelRequest("ordch_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -26,6 +26,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.orderEdit.removeAddedItem(
* "ordch_123",
* "orli_123",
* )
* .then(({ order_preview }) => {
* console.log(order_preview)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.paymentCollection.delete("paycol_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.priceList.delete("plist_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.pricePreference.delete("prpref_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productCategory.delete("pcat_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productTag.delete("ptag_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productType.delete("ptyp_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.product.delete("prod_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.product.deleteOption("prod_123", "prodopt_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -35,6 +35,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.product.deleteVariant("prod_123", "variant_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.promotion.delete("promo_123")
* .then(({ promotion }) => {
* console.log(promotion)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.region.delete("region_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.reservation.delete("res_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.returnReason.delete("ret_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.removeDismissItem("return_123", "orchach_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.removeReceiveItem("return_123", "orchach_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.cancelReceive("return_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.removeReturnItem("return_123", "orchach_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.cancelRequest("return_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -38,6 +38,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.return.deleteReturnShipping("return_123", "orchach_123")
* .then(({ return }) => {
* console.log(return)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.salesChannel.delete("sc_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.shippingOption.delete("so_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.shippingProfile.delete("sp_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.stockLocation.delete("sloc_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.taxRate.delete("txrat_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.taxRegion.delete("txreg_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.upload.delete("test.txt")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -12,6 +12,23 @@
* schema:
* type: string
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.user.delete("user_123")
* .then(({ deleted }) => {
* console.log(deleted)
* })
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/admin/users/{id}'
@@ -5,6 +5,23 @@
* description: Deletes the cookie session ID previously set for authentication.
* x-authenticated: true
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* await sdk.auth.logout()
*
* // user is now logged out
* // you can't send any requests that require authentication
* - lang: Shell
* label: cURL
* source: |-
@@ -1055,6 +1055,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.apiKey.list()
* .then(({ api_keys, count, limit, offset }) => {
* console.log(api_keys)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.apiKey.retrieve("apk_123")
* .then(({ api_key }) => {
* console.log(api_key)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -50,6 +50,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.campaign.list()
* .then(({ campaigns, count, limit, offset }) => {
* console.log(campaigns)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.campaign.retrieve("procamp_123")
* .then(({ campaign }) => {
* console.log(campaign)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -813,6 +813,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.list()
* .then(({ claims, count, limit, offset }) => {
* console.log(claims)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.claim.retrieve("claim_123")
* .then(({ claim }) => {
* console.log(claim)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -813,6 +813,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productCollection.list()
* .then(({ collections, count, limit, offset }) => {
* console.log(collections)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.productCollection.retrieve("pcol_123")
* .then(({ collection }) => {
* console.log(collection)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -92,6 +92,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.currency.list()
* .then(({ currencies, count, limit, offset }) => {
* console.log(currencies)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.currency.retrieve("usd")
* .then(({ currency }) => {
* console.log(currency)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -828,6 +828,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customerGroup.list()
* .then(({ customer_groups, count, limit, offset }) => {
* console.log(customer_groups)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customerGroup.retrieve("cusgroup_123")
* .then(({ customer_group }) => {
* console.log(customer_group)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -3334,6 +3334,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.list()
* .then(({ customers, count, limit, offset }) => {
* console.log(customers)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.retrieve("cus_123")
* .then(({ customer }) => {
* console.log(customer)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -154,6 +154,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.listAddresses("cus_123")
* .then(({ addresses }) => {
* console.log(addresses)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -34,6 +34,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.customer.retrieveAddress("cus_123", "cus_addr_123")
* .then(({ customer }) => {
* console.log(customer)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -1426,6 +1426,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.list()
* .then(({ draft_orders, count, limit, offset }) => {
* console.log(draft_orders)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -30,6 +30,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.draftOrder.retrieve("order_123")
* .then(({ draft_order }) => {
* console.log(draft_order)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -785,6 +785,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.list()
* .then(({ exchanges, count, limit, offset }) => {
* console.log(exchanges)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.exchange.retrieve("exchange_123")
* .then(({ exchange }) => {
* console.log(exchange)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -94,6 +94,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.fulfillmentProvider.list()
* .then(({ fulfillment_providers, count, limit, offset }) => {
* console.log(fulfillment_providers)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.fulfillmentProvider.listFulfillmentOptions("fp_123")
* .then(({ fulfillment_options }) => {
* console.log(fulfillment_options)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -35,6 +35,26 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.fulfillmentSet.retrieveServiceZone(
* "fset_123",
* "serzo_123"
* )
* .then(({ service_zone }) => {
* console.log(service_zone)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -385,6 +385,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.inventoryItem.list()
* .then(({ inventory_items, count, limit, offset }) => {
* console.log(inventory_items)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.inventoryItem.retrieve("iitem_123")
* .then(({ inventory_item }) => {
* console.log(inventory_item)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -74,6 +74,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.inventoryItem.listLevels("iitem_123")
* .then(({ inventory_levels, count, limit, offset }) => {
* console.log(inventory_levels)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -459,6 +459,23 @@
* type: object
* title: $or
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.invite.list()
* .then(({ invites, count, limit, offset }) => {
* console.log(invites)
* })
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/admin/invites'
@@ -24,6 +24,23 @@
* externalDocs:
* url: "#select-fields-and-relations"
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.invite.retrieve("invite_123")
* .then(({ invite }) => {
* console.log(invite)
* })
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/admin/invites/{id}'
@@ -106,6 +106,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.notification.list()
* .then(({ notifications, count, limit, offset }) => {
* console.log(notifications)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.notification.retrieve("notif_123")
* .then(({ notification }) => {
* console.log(notification)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -608,6 +608,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.list()
* .then(({ orders, count, limit, offset }) => {
* console.log(orders)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -76,6 +76,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.retrieve("order_123")
* .then(({ order }) => {
* console.log(order)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -34,6 +34,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.listChanges("order_123")
* .then(({ order_changes }) => {
* console.log(order_changes)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -116,6 +116,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.listLineItems("order_123")
* .then(({ order_items }) => {
* console.log(order_items)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -16,6 +16,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.order.retrievePreview("order_123")
* .then(({ order }) => {
* console.log(order)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -461,6 +461,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.payment.list()
* .then(({ payments, count, limit, offset }) => {
* console.log(payments)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.payment.retrieve("pay_123")
* .then(({ payment }) => {
* console.log(payment)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -90,6 +90,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.payment.listPaymentProviders()
* .then(({ payment_providers, count, limit, offset }) => {
* console.log(payment_providers)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -0,0 +1,57 @@
/**
* @oas [get] /admin/plugins
* operationId: GetPlugins
* summary: List Plugins
* description: Retrieve the list of plugins installed in the Medusa application.
* x-authenticated: true
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.plugin.list()
* .then(({ plugins }) => {
* console.log(plugins)
* })
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/plugins' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Plugins
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPluginsListResponse"
* "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"
*
*/
@@ -354,6 +354,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.priceList.list()
* .then(({ price_lists, count, limit, offset }) => {
* console.log(price_lists)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -28,6 +28,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.priceList.retrieve("plist_123")
* .then(({ price_list }) => {
* console.log(price_list)
* })
* - lang: Shell
* label: cURL
* source: |-
@@ -120,6 +120,23 @@
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: JavaScript
* label: JS SDK
* source: |-
* import Medusa from "@medusajs/js-sdk"
*
* export const sdk = new Medusa({
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
* debug: import.meta.env.DEV,
* auth: {
* type: "session",
* },
* })
*
* sdk.admin.pricePreference.list()
* .then(({ price_preferences, count, limit, offset }) => {
* console.log(price_preferences)
* })
* - lang: Shell
* label: cURL
* source: |-

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