# Medusa ## Docs - [Introduction](https://medusa.apidog.io/introduction-369873m0.md): - [Authentication](https://medusa.apidog.io/authentication-369874m0.md): - [HTTP Compression](https://medusa.apidog.io/http-compression-369875m0.md): - [Publishable API Key](https://medusa.apidog.io/publishable-api-key-369876m0.md): - [Expanding Fields](https://medusa.apidog.io/expanding-fields-369877m0.md): - [Selecting Fields](https://medusa.apidog.io/selecting-fields-369878m0.md): - [Query Parameter Types](https://medusa.apidog.io/query-parameter-types-369879m0.md): - [Pagination](https://medusa.apidog.io/pagination-369880m0.md): ## API Docs - Currencies [List Currencies](https://medusa.apidog.io/list-currencies-18089900e0.md): Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated. - Currencies [Get a Currency](https://medusa.apidog.io/get-a-currency-18089901e0.md): Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned. - Payment Providers [List Payment Providers](https://medusa.apidog.io/list-payment-providers-18089902e0.md): Retrieve a list of payment providers. You must provide the `region_id` query parameter to retrieve the payment providers enabled in that region. - Return Reasons [List Return Reasons](https://medusa.apidog.io/list-return-reasons-18089903e0.md): Retrieve a list of return reasons. The return reasons can be sorted or paginated. - Return Reasons [Get a Return Reason](https://medusa.apidog.io/get-a-return-reason-18089904e0.md): Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. - Auth [Retrieve Registration JWT Token](https://medusa.apidog.io/retrieve-registration-jwt-token-18089905e0.md): This API route retrieves a registration JWT token of a customer that hasn't been registered yet. The token is used in the header of requests that create a customer. - Auth [Authenticate Customer](https://medusa.apidog.io/authenticate-customer-18089906e0.md): Authenticate a customer and receive the JWT token to be used in the header of subsequent requests. - Auth [Generate Reset Password Token for Customer](https://medusa.apidog.io/generate-reset-password-token-for-customer-18089907e0.md): Generate a reset password token for a customer. This API route doesn't reset the customer password or send them the reset instructions in a notification. - Auth [Refresh Authentication Token](https://medusa.apidog.io/refresh-authentication-token-18089908e0.md): Refresh the authentication token of a customer. This is useful after authenticating a customer with a third-party service to ensure the token holds the new user's details, or when you don't want customers to re-login every day. - Auth [Validate Authentication Callback](https://medusa.apidog.io/validate-authentication-callback-18089909e0.md): This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route. - Auth [Delete Authentication Session](https://medusa.apidog.io/delete-authentication-session-18089910e0.md): Deletes the cookie session ID previously set for authentication. - Auth [Set Authentication Session](https://medusa.apidog.io/set-authentication-session-18089911e0.md): Set the cookie session ID of a customer. The customer must be previously authenticated with the `/auth/customer/{provider}` API route first, as the JWT token is required in the header of the request. - Auth [Reset a Customer's Password](https://medusa.apidog.io/reset-a-customers-password-18089912e0.md): Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. - Collections [List Collections](https://medusa.apidog.io/list-collections-18089913e0.md): Retrieve a list of collections. The collections can be filtered by fields such as `handle`. The collections can also be sorted or paginated. - Collections [Get a Collection](https://medusa.apidog.io/get-a-collection-18089914e0.md): Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. - Regions [List Regions](https://medusa.apidog.io/list-regions-18089915e0.md): Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. - Regions [Get a Region](https://medusa.apidog.io/get-a-region-18089916e0.md): Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned. - Products [List Products](https://medusa.apidog.io/list-products-18089917e0.md): Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. - Products [Get a Product](https://medusa.apidog.io/get-a-product-18089918e0.md): Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. - Customers [Get Logged-in Customer](https://medusa.apidog.io/get-logged-in-customer-18089919e0.md): Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned. - Customers [Update Customer](https://medusa.apidog.io/update-customer-18089920e0.md): Update the logged-in customer's details. - Customers [Create Address for Logged-In Customer](https://medusa.apidog.io/create-address-for-logged-in-customer-18089921e0.md): Create an address for the logged-in customer. - Customers [List Customer's Addresses](https://medusa.apidog.io/list-customers-addresses-18089922e0.md): Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as `country_code`. The addresses can also be sorted or paginated. - Customers [Get Customer's Address](https://medusa.apidog.io/get-customers-address-18089923e0.md): Retrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned. - Customers [Update Customer's Address](https://medusa.apidog.io/update-customers-address-18089924e0.md): Update the logged-in customer's address. - Customers [Remove Customer's Address](https://medusa.apidog.io/remove-customers-address-18089925e0.md): Remove an address of the logged-in customer. - Customers [Register Customer](https://medusa.apidog.io/register-customer-18089926e0.md): Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request. - Product Tags [List Product Tags](https://medusa.apidog.io/list-product-tags-18089927e0.md): Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. - Product Tags [Get a Product Tag](https://medusa.apidog.io/get-a-product-tag-18089928e0.md): Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned. - Returns [Create Return](https://medusa.apidog.io/create-return-18089929e0.md): Create a return for an order's items. The admin receives the return and process it from their side. - Product Types [Get a Product Type](https://medusa.apidog.io/get-a-product-type-18089930e0.md): Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned. - Product Types [List Product Types](https://medusa.apidog.io/list-product-types-18089931e0.md): Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. - Product Categories [List Product Categories](https://medusa.apidog.io/list-product-categories-18089932e0.md): Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. - Product Categories [Get a Product Category](https://medusa.apidog.io/get-a-product-category-18089933e0.md): Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. - Carts [Create Cart](https://medusa.apidog.io/create-cart-18089934e0.md): Create a cart. - Carts [Set Cart's Customer](https://medusa.apidog.io/set-carts-customer-18089935e0.md): Set the customer of the cart. This is useful when you create the cart for a guest customer, then they log in with their account. - Carts [Add Shipping Method to Cart](https://medusa.apidog.io/add-shipping-method-to-cart-18089936e0.md): Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option. - Carts [Add Line Item to Cart](https://medusa.apidog.io/add-line-item-to-cart-18089937e0.md): Add a product variant as a line item in the cart. - Carts [Calculate Cart Taxes](https://medusa.apidog.io/calculate-cart-taxes-18089938e0.md): Calculate the cart's tax lines and amounts. - Carts [Get a Cart](https://medusa.apidog.io/get-a-cart-18089939e0.md): Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned. - Carts [Update a Cart](https://medusa.apidog.io/update-a-cart-18089940e0.md): Update a cart's details. This unsets the payment methods chosen before, and the customer would have to choose them again. Also, if the customer has chosen a shipping method whose option isn't valid for the cart's shipping address anymore, the shipping method will be unset. For example, if the shipping option is valid only in the US geo zone, and the shipping address's country code is `DE`, the shipping method will be unset. - Carts [Update a Line Item in a Cart](https://medusa.apidog.io/update-a-line-item-in-a-cart-18089941e0.md): Update a line item's details in the cart. - Carts [Remove Line Item from Cart](https://medusa.apidog.io/remove-line-item-from-cart-18089942e0.md): Remove a line item from a cart. - Carts [Complete Cart](https://medusa.apidog.io/complete-cart-18089943e0.md): Complete a cart and place an order. - Carts [Add Promotions to Cart](https://medusa.apidog.io/add-promotions-to-cart-18089944e0.md): Add a list of promotions to a cart. - Carts [Remove Promotions from Cart](https://medusa.apidog.io/remove-promotions-from-cart-18089945e0.md): Remove a list of promotions from a cart. - Orders [List Logged-in Customer's Orders](https://medusa.apidog.io/list-logged-in-customers-orders-18089946e0.md): Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. - Orders [Request Order Transfer](https://medusa.apidog.io/request-order-transfer-18089947e0.md): Request an order to be transfered to the logged-in customer's account. The transfer is confirmed using the [Accept Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferaccept) API route. - Orders [Get an Order](https://medusa.apidog.io/get-an-order-18089948e0.md): Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. - Orders [Cancel Order Transfer](https://medusa.apidog.io/cancel-order-transfer-18089949e0.md): Cancel an order transfer that the logged-in customer previously requested using the [Request Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferrequest) API route. - Orders [Decline Order Transfer](https://medusa.apidog.io/decline-order-transfer-18089950e0.md): Decline an order transfer previously requested, typically by the admin user using the [Request Order Transfer Admin API route](https://docs.medusajs.com/api/admin#orders_postordersidtransferrequest). - Orders [Accept Order Transfer](https://medusa.apidog.io/accept-order-transfer-18089951e0.md): Accept an order to be transfered to a customer's account, which was specified when the transfer request was created. The transfer is requested previously either by the customer using the [Request Order Transfer Store API route](https://docs.medusajs.com/api/store#orders_postordersidtransferrequest), or by the admin using the [Request Order Transfer Admin API route](https://docs.medusajs.com/api/admin#orders_postordersidtransferrequest). - Payment Collections [Initialize Payment Session of a Payment Collection](https://medusa.apidog.io/initialize-payment-session-of-a-payment-collection-18089952e0.md): Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses. - Payment Collections [Create Payment Collection](https://medusa.apidog.io/create-payment-collection-18089953e0.md): Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions. - Shipping Options [Calculate Shipping Option Price](https://medusa.apidog.io/calculate-shipping-option-price-18089954e0.md): Calculate the price of a shipping option in a cart. - Shipping Options [List Shipping Options for Cart](https://medusa.apidog.io/list-shipping-options-for-cart-18089955e0.md): Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter. - Plugins [List Plugins](https://medusa.apidog.io/list-plugins-18089411e0.md): Retrieve the list of plugins installed in the Medusa application. - Auth [Refresh Authentication Token](https://medusa.apidog.io/refresh-authentication-token-18089412e0.md): Refresh the authentication token of a user. This is useful after authenticating a user with a third-party service to ensure the token holds the new user's details, or when you don't want users to re-login every day. - Auth [Validate Authentication Callback](https://medusa.apidog.io/validate-authentication-callback-18089413e0.md): This API route is used by your dashboard or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route. - Auth [Generate Reset Password Token for Admin User](https://medusa.apidog.io/generate-reset-password-token-for-admin-user-18089414e0.md): Generate a reset password token for an admin user. This API route doesn't reset the admin's password or send them the reset instructions in a notification. - Auth [Retrieve Registration JWT Token](https://medusa.apidog.io/retrieve-registration-jwt-token-18089415e0.md): This API route retrieves a registration JWT token of a user that hasn't been registered yet. The token is used in the header of requests that create a user, such as the Accept Invite API route. - Auth [Authenticate User](https://medusa.apidog.io/authenticate-user-18089416e0.md): Authenticate a user and receive the JWT token to be used in the header of subsequent requests. - Auth [Set Authentication Session](https://medusa.apidog.io/set-authentication-session-18089417e0.md): Set the cookie session ID of an admin user. The admin must be previously authenticated with the `/auth/user/{provider}` API route first, as the JWT token is required in the header of the request. - Auth [Delete Authentication Session](https://medusa.apidog.io/delete-authentication-session-18089418e0.md): Deletes the cookie session ID previously set for authentication. - Auth [Reset an Admin User's Password](https://medusa.apidog.io/reset-an-admin-users-password-18089419e0.md): Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. - Draft Orders [Create a Draft Order Edit](https://medusa.apidog.io/create-a-draft-order-edit-18089420e0.md): Create an edit on a draft order. This will allow you to make changes to the draft order's items, shipping methods, or promotions. Once you've made the necessar changes, you can later either request the edit (which requires a confirmation from the customer), or force-confirm the edit. - Draft Orders [Cancel Edit on Draft Order](https://medusa.apidog.io/cancel-edit-on-draft-order-18089421e0.md): Cancel an unconfirmed edit on a draft order. - Draft Orders [Confirm an Edit on a Draft Order](https://medusa.apidog.io/confirm-an-edit-on-a-draft-order-18089422e0.md): Confirm an edit on a draft order. This will apply the changes made to the draft order. - Draft Orders [Request Edit on Draft Order](https://medusa.apidog.io/request-edit-on-draft-order-18089423e0.md): Change the status of a draft order's edit to be requested. Later, the edit can be confirmed or canceled. - Draft Orders [Convert a Draft Order to an Order](https://medusa.apidog.io/convert-a-draft-order-to-an-order-18089424e0.md): Convert a draft order to an order. This will finalize the draft order and create a new order with the same details. - Draft Orders [Add Item to Draft Order Edit](https://medusa.apidog.io/add-item-to-draft-order-edit-18089425e0.md): Add an item to a draft order edit. - Draft Orders [Update Existing Item in Draft Order Edit](https://medusa.apidog.io/update-existing-item-in-draft-order-edit-18089426e0.md): Update an existing item in a draft order edit. - Draft Orders [Remove Item from Draft Order Edit](https://medusa.apidog.io/remove-item-from-draft-order-edit-18089427e0.md): Remove an order item from a draft order edit by the ID of the item's `ITEM_ADD` or `ITEM_UPDATE` action. - Draft Orders [Update New Item in Draft Order Edit](https://medusa.apidog.io/update-new-item-in-draft-order-edit-18089428e0.md): Update a new item that was added to a draft order edit by the ID of the item's `ITEM_ADD` action. - Draft Orders [Add Promotions to Draft Order Edit](https://medusa.apidog.io/add-promotions-to-draft-order-edit-18089429e0.md): Add promotions to a draft order edit. - Draft Orders [Remove Promotions from Draft Order Edit](https://medusa.apidog.io/remove-promotions-from-draft-order-edit-18089430e0.md): Remove specified promotions from a draft order edit. - Draft Orders [Add Shipping Method to Draft Order Edit](https://medusa.apidog.io/add-shipping-method-to-draft-order-edit-18089431e0.md): Add a shipping method to a draft order edit. - Draft Orders [Remove Shipping Method from Draft Order Edit](https://medusa.apidog.io/remove-shipping-method-from-draft-order-edit-18089432e0.md): Remove an existing shipping method from a draft order edit. - Draft Orders [Update Existing Shipping Method in Draft Order Edit](https://medusa.apidog.io/update-existing-shipping-method-in-draft-order-edit-18089433e0.md): Update an existing shipping method in a draft order edit. - Draft Orders [Remove New Shipping Method from Draft Order](https://medusa.apidog.io/remove-new-shipping-method-from-draft-order-18089434e0.md): Remove a shipping method that was added to a draft order edit using the `ID` of the method's `SHIPPING_ADD` action. - Draft Orders [Update New Shipping Method in Draft Order Edit](https://medusa.apidog.io/update-new-shipping-method-in-draft-order-edit-18089435e0.md): Update a new shipping method that was added to a draft order edit using the `ID` of the method's `SHIPPING_ADD` action. - Draft Orders [Delete a Draft Order](https://medusa.apidog.io/delete-a-draft-order-18089436e0.md): Delete a draft order. - Draft Orders [Get a Draft Order](https://medusa.apidog.io/get-a-draft-order-18089437e0.md): Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned using the query parameters. - Draft Orders [Update a Draft Order](https://medusa.apidog.io/update-a-draft-order-18089438e0.md): Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later request or confirm. - Draft Orders [Create Draft Order](https://medusa.apidog.io/create-draft-order-18089439e0.md): Create a draft order. This creates an order with the `is_draft_order` property enabled. You can later convert the draft order to an order. - Draft Orders [List Draft Orders](https://medusa.apidog.io/list-draft-orders-18089440e0.md): Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated. - Fulfillment Providers [List Fulfillment Options](https://medusa.apidog.io/list-fulfillment-options-18089441e0.md): Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service. - Fulfillment Providers [List Fulfillment Providers](https://medusa.apidog.io/list-fulfillment-providers-18089442e0.md): Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated. - Fulfillment Sets [Delete Fulfillment Set](https://medusa.apidog.io/delete-fulfillment-set-18089443e0.md): Delete a fulfillment set. - Fulfillment Sets [Add a Service Zone to a Fulfillment Set](https://medusa.apidog.io/add-a-service-zone-to-a-fulfillment-set-18089444e0.md): Add a service zone to a fulfillment set. - Fulfillment Sets [Remove a Service Zone from Fulfillment Set](https://medusa.apidog.io/remove-a-service-zone-from-fulfillment-set-18089445e0.md): Remove a service zone that belongs to a fulfillment set. - Fulfillment Sets [Get a Service Zone in a Fulfillment Set](https://medusa.apidog.io/get-a-service-zone-in-a-fulfillment-set-18089446e0.md): Retrieve a service zone that belongs to a fulfillment set. be paginated. - Fulfillment Sets [Update the Service Zone of a Fulfillment Set](https://medusa.apidog.io/update-the-service-zone-of-a-fulfillment-set-18089447e0.md): Update the details of a service zone in a fulfillment set. - Inventory Items [Manage Inventory Levels](https://medusa.apidog.io/manage-inventory-levels-18089448e0.md): Manage inventory levels to create, update, or delete them. - Inventory Items [Manage Inventory Levels of Inventory Item](https://medusa.apidog.io/manage-inventory-levels-of-inventory-item-18089449e0.md): Manage the inventory levels of an inventory item to create or delete them. - Inventory Items [Create Inventory Level for Inventory Item](https://medusa.apidog.io/create-inventory-level-for-inventory-item-18089450e0.md): Create an inventory level for an inventory item. - Inventory Items [List Inventory Levels](https://medusa.apidog.io/list-inventory-levels-18089451e0.md): Retrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like `location_id`. The inventory levels can also be paginated. - Inventory Items [Update an Inventory Level of an Inventory Item](https://medusa.apidog.io/update-an-inventory-level-of-an-inventory-item-18089452e0.md): Updates the details of an inventory item's inventory level using its associated location ID. - Inventory Items [Remove Inventory Level of Inventory Item](https://medusa.apidog.io/remove-inventory-level-of-inventory-item-18089453e0.md): Remove the inventory level of an inventory item. - Inventory Items [Create Inventory Item](https://medusa.apidog.io/create-inventory-item-18089454e0.md): Create an inventory item. - Inventory Items [List Inventory Items](https://medusa.apidog.io/list-inventory-items-18089455e0.md): 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. - Inventory Items [Get a Inventory Item](https://medusa.apidog.io/get-a-inventory-item-18089456e0.md): Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned. - Inventory Items [Delete Inventory Item](https://medusa.apidog.io/delete-inventory-item-18089457e0.md): Delete an inventory item. - Inventory Items [Update an Inventory Item](https://medusa.apidog.io/update-an-inventory-item-18089458e0.md): Update an inventory item's details. - Order Edits [Create Order Edit](https://medusa.apidog.io/create-order-edit-18089459e0.md): Create an order edit. - Order Edits [Confirm Order Edit](https://medusa.apidog.io/confirm-order-edit-18089460e0.md): Confirm an order edit request and apply the changes on the order. - Order Edits [Request Order Edit](https://medusa.apidog.io/request-order-edit-18089461e0.md): Change the status of an active order edit to requested. - Order Edits [Add Items to Order Edit](https://medusa.apidog.io/add-items-to-order-edit-18089462e0.md): Add new items to an order edit. These items will have the action `ITEM_ADD`. - Order Edits [Update Order Item Quantity of Order Edit](https://medusa.apidog.io/update-order-item-quantity-of-order-edit-18089463e0.md): Update an existing order item's quantity of an order edit. - Order Edits [Remove Item from Order Edit](https://medusa.apidog.io/remove-item-from-order-edit-18089464e0.md): Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action. - Order Edits [Update an Item in an Order Edit](https://medusa.apidog.io/update-an-item-in-an-order-edit-18089465e0.md): Update an added item in the order edit by the ID of the item's `ITEM_ADD` action. - Order Edits [Add Shipping Method to Order Edit](https://medusa.apidog.io/add-shipping-method-to-order-edit-18089466e0.md): Add a shipping method to an exchange. The shipping method will have a `SHIPPING_ADD` action. - Order Edits [Remove Shipping Method from Order Edit](https://medusa.apidog.io/remove-shipping-method-from-order-edit-18089467e0.md): Remove a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. - Order Edits [Update Shipping Method of an Order Edit](https://medusa.apidog.io/update-shipping-method-of-an-order-edit-18089468e0.md): Update a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. - Order Edits [Cancel Order Edit](https://medusa.apidog.io/cancel-order-edit-18089469e0.md): Cancel a requested order edit. - Orders [List Changes on an Order](https://medusa.apidog.io/list-changes-on-an-order-18089470e0.md): Retrieve a list of changes made on an order, including returns, exchanges, etc... - Orders [Mark a Fulfillment as Delivered.](https://medusa.apidog.io/mark-a-fulfillment-as-delivered-18089471e0.md): Mark an order's fulfillment as delivered. - Orders [Get Preview](https://medusa.apidog.io/get-preview-18089472e0.md): Retrieve a preview of an order using its associated change, such as an edit. - Orders [Archive an Order](https://medusa.apidog.io/archive-an-order-18089473e0.md): Change the status of an order to archived. - Orders [Cancel Order](https://medusa.apidog.io/cancel-order-18089474e0.md): Cancel an order. The cancelation fails if: - Orders [Cancel Transfer Request](https://medusa.apidog.io/cancel-transfer-request-18089475e0.md): Cancel a request to transfer an order to another customer. - Orders [Create Credit Line for Order](https://medusa.apidog.io/create-credit-line-for-order-18089476e0.md): Create a credit line for an order. - Orders [Request Order Transfer](https://medusa.apidog.io/request-order-transfer-18089477e0.md): Request an order to be transfered to another customer. The transfer is confirmed by sending a request to the [Accept Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferaccept) Store API route. - Orders [Complete Order](https://medusa.apidog.io/complete-order-18089478e0.md): Mark an order as completed. - Orders [Update Order](https://medusa.apidog.io/update-order-18089479e0.md): Update an order's details. - Orders [Get an Order](https://medusa.apidog.io/get-an-order-18089480e0.md): Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. - Orders [List Line Items](https://medusa.apidog.io/list-line-items-18089481e0.md): Retrieve a list of line items in a order. The line items can be filtered by fields like FILTER FIELDS. The line items can also be paginated. - Orders [Cancel Fulfillment](https://medusa.apidog.io/cancel-fulfillment-18089482e0.md): Cancel an order's fulfillment. The fulfillment can't be canceled if it's shipped. - Orders [Create an Order Fulfillment](https://medusa.apidog.io/create-an-order-fulfillment-18089483e0.md): Create a fulfillment for an order. The creation fails if the order is canceled. - Orders [Create Shipment for an Order's Fulfillment](https://medusa.apidog.io/create-shipment-for-an-orders-fulfillment-18089484e0.md): Create a shipment for an order's fulfillment. - Orders [List Orders](https://medusa.apidog.io/list-orders-18089485e0.md): Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. - Payment Collections [Delete a Payment Collection](https://medusa.apidog.io/delete-a-payment-collection-18089486e0.md): Delete a payment collection. - Payment Collections [Create Payment Collection](https://medusa.apidog.io/create-payment-collection-18089487e0.md): Create a payment collection. - Payment Collections [Mark a Payment Collection as Paid](https://medusa.apidog.io/mark-a-payment-collection-as-paid-18089488e0.md): Mark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider. - Products [Create Product Import](https://medusa.apidog.io/create-product-import-18089489e0.md): Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/import` API route. - Products [Confirm Product Import](https://medusa.apidog.io/confirm-product-import-18089490e0.md): Confirm that a created product import should start importing the products into Medusa. - Products [Export Products](https://medusa.apidog.io/export-products-18089491e0.md): Start a product export process to retrieve a CSV of exported products. - Products [Manage Products](https://medusa.apidog.io/manage-products-18089492e0.md): Manage products to create, update, or delete them. - Products [Manage Variants in a Product](https://medusa.apidog.io/manage-variants-in-a-product-18089493e0.md): Manage variants in a product to create, update, or delete them. - Products [Associate Variant with Inventory Item](https://medusa.apidog.io/associate-variant-with-inventory-item-18089494e0.md): Associate with a product variant an inventory item that manages its inventory details. - Products [Remove Inventory Item Association with Product Variant](https://medusa.apidog.io/remove-inventory-item-association-with-product-variant-18089495e0.md): Remove the association between an inventory item and its product variant. - Products [Update Product Variant's Inventory Details](https://medusa.apidog.io/update-product-variants-inventory-details-18089496e0.md): Update the inventory item that manages the inventory details of a product variant. - Products [Delete a Product](https://medusa.apidog.io/delete-a-product-18089497e0.md): Delete a product. - Products [Get a Product](https://medusa.apidog.io/get-a-product-18089498e0.md): Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. - Products [Update a Product](https://medusa.apidog.io/update-a-product-18089499e0.md): Update a product's details. - Products [Create a Product Option](https://medusa.apidog.io/create-a-product-option-18089500e0.md): Create an option for a product. - Products [List a Product's Options](https://medusa.apidog.io/list-a-products-options-18089501e0.md): Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated. - Products [Get a Product's Option](https://medusa.apidog.io/get-a-products-option-18089502e0.md): Retrieve a product's option by its ID. - Products [Delete an Option from Product](https://medusa.apidog.io/delete-an-option-from-product-18089503e0.md): Delete an option from a product. - Products [Update a Product's Option](https://medusa.apidog.io/update-a-products-option-18089504e0.md): Update the details of a product option. - Products [Get Variant of a Product](https://medusa.apidog.io/get-variant-of-a-product-18089505e0.md): Retrieve a product's variant by its ID. - Products [Delete Product Variant](https://medusa.apidog.io/delete-product-variant-18089506e0.md): Delete a variant of a product. - Products [Update a Product Variant](https://medusa.apidog.io/update-a-product-variant-18089507e0.md): Update a variant's details. - Products [Manage Variants Inventory in a Product](https://medusa.apidog.io/manage-variants-inventory-in-a-product-18089508e0.md): Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items. - Products [Create a Product Variant](https://medusa.apidog.io/create-a-product-variant-18089509e0.md): Create a variant for a product. - Products [List Variants of a Product](https://medusa.apidog.io/list-variants-of-a-product-18089510e0.md): Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. - Products [Create Product](https://medusa.apidog.io/create-product-18089511e0.md): Create a product. - Products [List Products](https://medusa.apidog.io/list-products-18089512e0.md): Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. - Claims [Get a Claim](https://medusa.apidog.io/get-a-claim-18089513e0.md): Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned using the query parameters. - Claims [Cancel a Claim](https://medusa.apidog.io/cancel-a-claim-18089514e0.md): Cancel a claim and its associated return. - Claims [Add Inbound Items to a Claim](https://medusa.apidog.io/add-inbound-items-to-a-claim-18089515e0.md): Add inbound (or return) items to a claim. These inbound items will have a `RETURN_ITEM` action. - Claims [Remove an Inbound Item from Claim](https://medusa.apidog.io/remove-an-inbound-item-from-claim-18089516e0.md): Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` action. - Claims [Update Inbound Items of a Claim](https://medusa.apidog.io/update-inbound-items-of-a-claim-18089517e0.md): Update an inbound (or return) item of a claim using the `ID` of the item's `RETURN_ITEM` action. - Claims [Add an Inbound Shipping Method to a Claim](https://medusa.apidog.io/add-an-inbound-shipping-method-to-a-claim-18089518e0.md): Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a `SHIPPING_ADD` action. - Claims [Cancel Claim Request](https://medusa.apidog.io/cancel-claim-request-18089519e0.md): Cancel a requested claim. - Claims [Confirm a Claim Request](https://medusa.apidog.io/confirm-a-claim-request-18089520e0.md): Confirm a claim request, applying its changes on the associated order. - Claims [Add Claim Items to a Claim](https://medusa.apidog.io/add-claim-items-to-a-claim-18089521e0.md): Add order items to a claim as claim items. These claim items will have the action `WRITE_OFF_ITEM`. - Claims [Remove a Claim Item from a Claim](https://medusa.apidog.io/remove-a-claim-item-from-a-claim-18089522e0.md): Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. - Claims [Update a Claim Item](https://medusa.apidog.io/update-a-claim-item-18089523e0.md): Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` action. - Claims [Remove Inbound Shipping Method from Claim](https://medusa.apidog.io/remove-inbound-shipping-method-from-claim-18089524e0.md): Remove the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. - Claims [Update Inbound Shipping Method of a Claim](https://medusa.apidog.io/update-inbound-shipping-method-of-a-claim-18089525e0.md): Update the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. - Claims [Add Outbound Items to a Claim](https://medusa.apidog.io/add-outbound-items-to-a-claim-18089526e0.md): Add outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action. - Claims [Remove an Outbound Item from Claim](https://medusa.apidog.io/remove-an-outbound-item-from-claim-18089527e0.md): Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` action. - Claims [Update Outbound Item of a Claim](https://medusa.apidog.io/update-outbound-item-of-a-claim-18089528e0.md): Update an outbound (or new) item of a claim using the `ID` of the item's `ITEM_ADD` action. - Claims [Add Outbound Shipping Methods to a Claim](https://medusa.apidog.io/add-outbound-shipping-methods-to-a-claim-18089529e0.md): Add an outbound shipping method to a claim. The outbound shipping method will have a `SHIPPING_ADD` action. - Claims [Remove Outbound Shipping Method from Claim](https://medusa.apidog.io/remove-outbound-shipping-method-from-claim-18089530e0.md): Remove the shipping method for delivering outbound items in the claim using the `ID` of the method's `SHIPPING_ADD` action. - Claims [Update Outbound Shipping Method of a Claim](https://medusa.apidog.io/update-outbound-shipping-method-of-a-claim-18089531e0.md): Update the shipping method for delivering outbound items in a claim using the `ID` of the method's `SHIPPING_ADD` action. - Claims [Create a Claim](https://medusa.apidog.io/create-a-claim-18089532e0.md): Create a claim. The claim is still in the request state, and the changes are only applied on the order once the claim is confirmed. - Claims [List Claims](https://medusa.apidog.io/list-claims-18089533e0.md): Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated. - Currencies [Get a Currency](https://medusa.apidog.io/get-a-currency-18089534e0.md): Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters. - Currencies [List Currencies](https://medusa.apidog.io/list-currencies-18089535e0.md): Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. - Exchanges [Get an Exchange](https://medusa.apidog.io/get-an-exchange-18089536e0.md): Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters. - Exchanges [Cancel an Exchange](https://medusa.apidog.io/cancel-an-exchange-18089537e0.md): Cancel an exchange and its associated return. - Exchanges [Add Inbound Items to an Exchange](https://medusa.apidog.io/add-inbound-items-to-an-exchange-18089538e0.md): Add inbound (or return) items to an exchange. These inbound items will have the action `RETURN_ITEM`. - Exchanges [Remove Inbound Item from Exchange](https://medusa.apidog.io/remove-inbound-item-from-exchange-18089539e0.md): Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. - Exchanges [Update an Inbount Item of an Exchange](https://medusa.apidog.io/update-an-inbount-item-of-an-exchange-18089540e0.md): Update an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. - Exchanges [Add an Inbound Shipping Method to an Exchange](https://medusa.apidog.io/add-an-inbound-shipping-method-to-an-exchange-18089541e0.md): Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a `SHIPPING_ADD` action. - Exchanges [Cancel Exchange Request](https://medusa.apidog.io/cancel-exchange-request-18089542e0.md): Cancel a requested exchange. - Exchanges [Confirm an Exchange](https://medusa.apidog.io/confirm-an-exchange-18089543e0.md): Confirm an exchange request, applying its changes on the associated order. - Exchanges [Remove Inbound Shipping Method from Exchange](https://medusa.apidog.io/remove-inbound-shipping-method-from-exchange-18089544e0.md): Remove the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. - Exchanges [Update Inbound Shipping Method of an Exchange](https://medusa.apidog.io/update-inbound-shipping-method-of-an-exchange-18089545e0.md): Update the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. - Exchanges [Add Outbound Items to Exchange](https://medusa.apidog.io/add-outbound-items-to-exchange-18089546e0.md): Add outbound (or new) items to an exchange. These outbound items will have the action `ITEM_ADD`. - Exchanges [Remove Outbound Item from Exchange](https://medusa.apidog.io/remove-outbound-item-from-exchange-18089547e0.md): Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. - Exchanges [Update Outbound Item of an Exchange](https://medusa.apidog.io/update-outbound-item-of-an-exchange-18089548e0.md): Update an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. - Exchanges [Add Outbound Shipping Method to Exchange](https://medusa.apidog.io/add-outbound-shipping-method-to-exchange-18089549e0.md): Add an outbound shipping method to an exchange. The outbound shipping method will have a `SHIPPING_ADD` action. - Exchanges [Remove Outbound Shipping Method from Exchange](https://medusa.apidog.io/remove-outbound-shipping-method-from-exchange-18089550e0.md): Remove the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. - Exchanges [Update Outbound Shipping Method of Exchange](https://medusa.apidog.io/update-outbound-shipping-method-of-exchange-18089551e0.md): Update the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. - Exchanges [Create Exchange](https://medusa.apidog.io/create-exchange-18089552e0.md): Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed. - Exchanges [List Exchanges](https://medusa.apidog.io/list-exchanges-18089553e0.md): Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated. - Fulfillments [Cancel a Fulfillment](https://medusa.apidog.io/cancel-a-fulfillment-18089554e0.md): Cancel a fulfillment. The fulfillment can't be shipped or delivered. - Fulfillments [Create Fulfillment](https://medusa.apidog.io/create-fulfillment-18089555e0.md): Create a fulfillment for an order, return, exchange, and more. - Fulfillments [Create a Shipment for a Fulfillment](https://medusa.apidog.io/create-a-shipment-for-a-fulfillment-18089556e0.md): Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled. - Invites [Refresh Invite Token](https://medusa.apidog.io/refresh-invite-token-18089557e0.md): Refresh the token of an invite. - Invites [Get an Invite](https://medusa.apidog.io/get-an-invite-18089558e0.md): Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. - Invites [Delete Invite](https://medusa.apidog.io/delete-invite-18089559e0.md): Delete an invite. - Invites [Accept Invite](https://medusa.apidog.io/accept-invite-18089560e0.md): Accept an invite and create a new user. - Invites [Create Invite](https://medusa.apidog.io/create-invite-18089561e0.md): Create a invite. - Invites [List Invites](https://medusa.apidog.io/list-invites-18089562e0.md): Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - Notifications [Get a Notification](https://medusa.apidog.io/get-a-notification-18089563e0.md): Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned. - Notifications [List Notifications](https://medusa.apidog.io/list-notifications-18089564e0.md): Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated. - Payments [Get a Payment](https://medusa.apidog.io/get-a-payment-18089565e0.md): Retrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned. - Payments [Capture Payment](https://medusa.apidog.io/capture-payment-18089566e0.md): Capture an amount of a payment. This uses the `capturePayment` method of the payment provider associated with the payment's collection. - Payments [Refund Payment](https://medusa.apidog.io/refund-payment-18089567e0.md): Refund an amount of a payment. This uses the `refundPayment` method of the payment provider associated with the payment's collection. - Payments [List Payment Providers](https://medusa.apidog.io/list-payment-providers-18089568e0.md): Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. - Payments [List Payments](https://medusa.apidog.io/list-payments-18089569e0.md): Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. - Returns [Cancel a return.](https://medusa.apidog.io/cancel-a-return-18089570e0.md): Cancel a return. - Returns [Get a Return](https://medusa.apidog.io/get-a-return-18089571e0.md): Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned. - Returns [Update a Return](https://medusa.apidog.io/update-a-return-18089572e0.md): Update a return's details. - Returns [Add Damaged Items to Return](https://medusa.apidog.io/add-damaged-items-to-return-18089573e0.md): Add damaged items, whose quantity is to be dismissed, to a return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`. - Returns [Remove Damaged Item from Return](https://medusa.apidog.io/remove-damaged-item-from-return-18089574e0.md): Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. - Returns [Update Damaged Item of Return](https://medusa.apidog.io/update-damaged-item-of-return-18089575e0.md): Update a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. - Returns [Add Received Items to Return](https://medusa.apidog.io/add-received-items-to-return-18089576e0.md): Add received items in a return. These items will have the action `RECEIVE_RETURN_ITEM`. - Returns [Remove a Received Item from Return](https://medusa.apidog.io/remove-a-received-item-from-return-18089577e0.md): Remove a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. - Returns [Update a Received Item in a Return](https://medusa.apidog.io/update-a-received-item-in-a-return-18089578e0.md): Update a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. - Returns [Confirm Return Receival](https://medusa.apidog.io/confirm-return-receival-18089579e0.md): Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and reflects the changes on the order. - Returns [Add Requested Items to Return](https://medusa.apidog.io/add-requested-items-to-return-18089580e0.md): Add items that are requested to be returned. These items will have the action `RETURN_ITEM`. - Returns [Remove Item from Return](https://medusa.apidog.io/remove-item-from-return-18089581e0.md): Remove a requested item to be returned by the ID of the item's `RETURN_ITEM` action. - Returns [Update Requested Item in Return](https://medusa.apidog.io/update-requested-item-in-return-18089582e0.md): Update a requested item to be returned by the ID of the item's `RETURN_ITEM` action. - Returns [Add a Shipping Method to a Return](https://medusa.apidog.io/add-a-shipping-method-to-a-return-18089583e0.md): Add a shipping method to a return. The shipping method will have a `SHIPPING_ADD` action. - Returns [Remove Shipping Method from Return](https://medusa.apidog.io/remove-shipping-method-from-return-18089584e0.md): Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. - Returns [Update a Shipping Method of a Return](https://medusa.apidog.io/update-a-shipping-method-of-a-return-18089585e0.md): Update a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. - Returns [Start Return Receival](https://medusa.apidog.io/start-return-receival-18089586e0.md): Start a return receival process to be later confirmed using the `/admin/returns/:id/receive/confirm` API route. - Returns [Cancel Return Receival](https://medusa.apidog.io/cancel-return-receival-18089587e0.md): Cancel the receival process previously started, and hasn't been confirmed, of a return. - Returns [Confirm Return Request](https://medusa.apidog.io/confirm-return-request-18089588e0.md): Confirm a requested return. The changes are applied on the inventory quantity and the order only after the return has been confirmed as received using the `/admin/returns/:id/received/confirm`. - Returns [Cancel Return Request](https://medusa.apidog.io/cancel-return-request-18089589e0.md): Cancel a requested return. - Returns [Create Return](https://medusa.apidog.io/create-return-18089590e0.md): Create a return. The return can later be requested or confirmed. - Returns [List Returns](https://medusa.apidog.io/list-returns-18089591e0.md): Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated. - Users [Get Logged-In User](https://medusa.apidog.io/get-logged-in-user-18089592e0.md): Retrieve the logged-in user's details. - Users [Delete a User](https://medusa.apidog.io/delete-a-user-18089593e0.md): Delete a user. - Users [Get a User](https://medusa.apidog.io/get-a-user-18089594e0.md): Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. - Users [Update a User](https://medusa.apidog.io/update-a-user-18089595e0.md): Update a user's details. - Users [List Users](https://medusa.apidog.io/list-users-18089596e0.md): Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - Workflows Executions [Get a Workflows Execution](https://medusa.apidog.io/get-a-workflows-execution-18089597e0.md): Retrieve a workflows execution by its ID. You can expand the workflows execution's relations or select the fields that should be returned. - Workflows Executions [Subscribe to a Workflow's Execution](https://medusa.apidog.io/subscribe-to-a-workflows-execution-18089598e0.md): Subscribe to a workflow's execution to receive real-time information about its steps, status, and data. - Workflows Executions [Get Workflow Execution's Details](https://medusa.apidog.io/get-workflow-executions-details-18089599e0.md): Get the details of the workflow's execution. - Workflows Executions [Subscribe to Step of a Workflow's Execution](https://medusa.apidog.io/subscribe-to-step-of-a-workflows-execution-18089600e0.md): Subscribe to a step in a workflow's execution to receive real-time information about its status and data. - Workflows Executions [Fail a Step in a Workflow's Execution](https://medusa.apidog.io/fail-a-step-in-a-workflows-execution-18089601e0.md): Set the status of a step in a workflow's execution as failed. This is useful for long-running workflows. - Workflows Executions [Succeed a Step in a Workflow's Execution](https://medusa.apidog.io/succeed-a-step-in-a-workflows-execution-18089602e0.md): Set the status of a step in a workflow's execution as successful. This is useful for long-running workflows. - Workflows Executions [List Workflows Executions](https://medusa.apidog.io/list-workflows-executions-18089603e0.md): 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. - Workflows Executions [Execute a Workflow](https://medusa.apidog.io/execute-a-workflow-18089604e0.md): Execute a workflow by its ID. - Api Keys [Revoke API Key](https://medusa.apidog.io/revoke-api-key-18089605e0.md): Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, it can't be used by client applications. - Api Keys [Get API Key](https://medusa.apidog.io/get-api-key-18089606e0.md): Retrieve an API key by its ID. You can expand the API key's relations or select the fields that should be returned using the query parameters. - Api Keys [Update an API Key](https://medusa.apidog.io/update-an-api-key-18089607e0.md): Update an API key's details. - Api Keys [Delete an Api Key](https://medusa.apidog.io/delete-an-api-key-18089608e0.md): Delete a publishable or secret API key. - Api Keys [Manage Sales Channels of a Publishable API Key](https://medusa.apidog.io/manage-sales-channels-of-a-publishable-api-key-18089609e0.md): Manage the sales channels of a publishable API key, either to associate them or remove them from the API key. - Api Keys [Create Api Key](https://medusa.apidog.io/create-api-key-18089610e0.md): Create a secret or publishable API key. - Api Keys [List API Keys](https://medusa.apidog.io/list-api-keys-18089611e0.md): 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. - Price Lists [Remove Products from Price List](https://medusa.apidog.io/remove-products-from-price-list-18089612e0.md): Remove products from a price list. - Price Lists [Delete a Price List](https://medusa.apidog.io/delete-a-price-list-18089613e0.md): Delete a price list. - Price Lists [Get a Price List](https://medusa.apidog.io/get-a-price-list-18089614e0.md): Retrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned. - Price Lists [Update a Price List](https://medusa.apidog.io/update-a-price-list-18089615e0.md): Update a price list's details. - Price Lists [Manage Prices in Price List](https://medusa.apidog.io/manage-prices-in-price-list-18089616e0.md): Manage the prices of a price list to create, update, or delete them. - Price Lists [Create Price List](https://medusa.apidog.io/create-price-list-18089617e0.md): Create a price list. - Price Lists [List Price Lists](https://medusa.apidog.io/list-price-lists-18089618e0.md): 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. - Stores [Get a Store](https://medusa.apidog.io/get-a-store-18089619e0.md): Retrieve a store by its ID. You can expand the store's relations or select the fields that should be returned. - Stores [Update a Store](https://medusa.apidog.io/update-a-store-18089620e0.md): Update a store's details. - Stores [List Stores](https://medusa.apidog.io/list-stores-18089621e0.md): Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. - Tax Rates [Create Tax Rule for a Rate](https://medusa.apidog.io/create-tax-rule-for-a-rate-18089622e0.md): Create a tax rule for a rate. - Tax Rates [Delete a Tax Rate](https://medusa.apidog.io/delete-a-tax-rate-18089623e0.md): Delete a tax rate. - Tax Rates [Get a Tax Rate](https://medusa.apidog.io/get-a-tax-rate-18089624e0.md): Retrieve a tax rate by its ID. You can expand the tax rate's relations or select the fields that should be returned. - Tax Rates [Update a Tax Rate](https://medusa.apidog.io/update-a-tax-rate-18089625e0.md): Update a tax rate's details. - Tax Rates [Remove Rule of Tax Rate](https://medusa.apidog.io/remove-rule-of-tax-rate-18089626e0.md): Remove a tax rate's rule. - Tax Rates [Create Tax Rate](https://medusa.apidog.io/create-tax-rate-18089627e0.md): Create a tax rate. - Tax Rates [List Tax Rates](https://medusa.apidog.io/list-tax-rates-18089628e0.md): 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. - Price Preferences [Delete a Price Preference](https://medusa.apidog.io/delete-a-price-preference-18089629e0.md): Delete a price preference. - Price Preferences [Get a Price Preference](https://medusa.apidog.io/get-a-price-preference-18089630e0.md): Retrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned. - Price Preferences [Update a Price Preference](https://medusa.apidog.io/update-a-price-preference-18089631e0.md): Update a price preference's details. - Price Preferences [Create Price Preference](https://medusa.apidog.io/create-price-preference-18089632e0.md): Create a price preference. - Price Preferences [List Price Preferences](https://medusa.apidog.io/list-price-preferences-18089633e0.md): Retrieve a list of price preferences. The price preferences can be filtered by fields such as `id`. The price preferences can also be sorted or paginated. - Return Reasons [Delete a Return Reason](https://medusa.apidog.io/delete-a-return-reason-18089634e0.md): Delete a return reason. - Return Reasons [Get a Return Reason](https://medusa.apidog.io/get-a-return-reason-18089635e0.md): Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. - Return Reasons [Update a Return Reason](https://medusa.apidog.io/update-a-return-reason-18089636e0.md): Update a return reason's details. - Return Reasons [Create Return Reason](https://medusa.apidog.io/create-return-reason-18089637e0.md): Create a return reason. - Return Reasons [List Return Reasons](https://medusa.apidog.io/list-return-reasons-18089638e0.md): Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. - Sales Channels [Delete a Sales Channel](https://medusa.apidog.io/delete-a-sales-channel-18089639e0.md): Delete a sales channel. - Sales Channels [Get a Sales Channel](https://medusa.apidog.io/get-a-sales-channel-18089640e0.md): Retrieve a sales channel by its ID. You can expand the sales channel's relations or select the fields that should be returned. - Sales Channels [Update a Sales Channel](https://medusa.apidog.io/update-a-sales-channel-18089641e0.md): Update a sales channel's details. - Sales Channels [Manage Products in Sales Channel](https://medusa.apidog.io/manage-products-in-sales-channel-18089642e0.md): Manage products in a sales channel to add or remove them from the channel. - Sales Channels [Create Sales Channel](https://medusa.apidog.io/create-sales-channel-18089643e0.md): Create a sales channel. - Sales Channels [List Sales Channels](https://medusa.apidog.io/list-sales-channels-18089644e0.md): 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. - Stock Locations [Delete a Stock Location](https://medusa.apidog.io/delete-a-stock-location-18089645e0.md): Delete a stock location. - Stock Locations [Get a Stock Location](https://medusa.apidog.io/get-a-stock-location-18089646e0.md): Retrieve a stock location by its ID. You can expand the stock location's relations or select the fields that should be returned. - Stock Locations [Update a Stock Location](https://medusa.apidog.io/update-a-stock-location-18089647e0.md): Update a stock location's details. - Stock Locations [Add Fulfillment Set to Stock Location](https://medusa.apidog.io/add-fulfillment-set-to-stock-location-18089648e0.md): Create and add a fulfillment set to a stock location. - Stock Locations [Manage Fulfillment Providers of a Stock Location](https://medusa.apidog.io/manage-fulfillment-providers-of-a-stock-location-18089649e0.md): Manage the fulfillment providers to add or remove them from a stock location. - Stock Locations [Manage Sales Channels of a Stock Location](https://medusa.apidog.io/manage-sales-channels-of-a-stock-location-18089650e0.md): Manage the sales channels in a stock location by adding or removing them. - Stock Locations [Create Stock Location](https://medusa.apidog.io/create-stock-location-18089651e0.md): Create a stock location. - Stock Locations [List Stock Locations](https://medusa.apidog.io/list-stock-locations-18089652e0.md): Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated. - Tax Regions [Delete a Tax Region](https://medusa.apidog.io/delete-a-tax-region-18089653e0.md): Delete a tax region. - Tax Regions [Update a Tax Region](https://medusa.apidog.io/update-a-tax-region-18089654e0.md): Update a tax region's details. - Tax Regions [Get a Tax Region](https://medusa.apidog.io/get-a-tax-region-18089655e0.md): Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned. - Tax Regions [Create Tax Region](https://medusa.apidog.io/create-tax-region-18089656e0.md): Create a tax region. - Tax Regions [List Tax Regions](https://medusa.apidog.io/list-tax-regions-18089657e0.md): Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated. - Promotions [List Rule Attribute Options of a Rule Type](https://medusa.apidog.io/list-rule-attribute-options-of-a-rule-type-18089658e0.md): Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. - Promotions [List Rules of a Promotion](https://medusa.apidog.io/list-rules-of-a-promotion-18089659e0.md): Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: - Promotions [List Rule Values Given a Rule Attribute](https://medusa.apidog.io/list-rule-values-given-a-rule-attribute-18089660e0.md): Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type. - Promotions [Manage the Buy Rules of a Promotion](https://medusa.apidog.io/manage-the-buy-rules-of-a-promotion-18089661e0.md): Manage the buy rules of a `buyget` promotion to create, update, or delete them. - Promotions [Manage a Promotion's Rules](https://medusa.apidog.io/manage-a-promotions-rules-18089662e0.md): Manage the rules of a promotion to create, update, or delete them. - Promotions [Manage Target Rules of a Promotion](https://medusa.apidog.io/manage-target-rules-of-a-promotion-18089663e0.md): Manage the target rules of a promotion to create, update, or delete them. - Promotions [Get a Promotion](https://medusa.apidog.io/get-a-promotion-18089664e0.md): Retrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned. - Promotions [Delete a Promotion](https://medusa.apidog.io/delete-a-promotion-18089665e0.md): Delete a promotion. - Promotions [Update a Promotion](https://medusa.apidog.io/update-a-promotion-18089666e0.md): Update a promotion's details. - Promotions [List Promotions](https://medusa.apidog.io/list-promotions-18089667e0.md): Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. - Promotions [Create Promotion](https://medusa.apidog.io/create-promotion-18089668e0.md): Create a promotion. - Customer Groups [Get a Customer Group](https://medusa.apidog.io/get-a-customer-group-18089669e0.md): Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned. - Customer Groups [Update a Customer Group](https://medusa.apidog.io/update-a-customer-group-18089670e0.md): Update a customer group's details. - Customer Groups [Delete a Customer Group](https://medusa.apidog.io/delete-a-customer-group-18089671e0.md): Delete a customer group. Customers in the group aren't deleted. - Customer Groups [Manage Customers of a Customer Group](https://medusa.apidog.io/manage-customers-of-a-customer-group-18089672e0.md): Manage the customers of a group to add or remove them from the group. - Customer Groups [Create Customer Group](https://medusa.apidog.io/create-customer-group-18089673e0.md): Create a customer group. - Customer Groups [List Customer Groups](https://medusa.apidog.io/list-customer-groups-18089674e0.md): 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. - Product Tags [Delete a Product Tag](https://medusa.apidog.io/delete-a-product-tag-18089675e0.md): Delete a product tag. This doesn't delete products using the tag. - Product Tags [Get a Product Tag](https://medusa.apidog.io/get-a-product-tag-18089676e0.md): Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned. - Product Tags [Update a Product Tag](https://medusa.apidog.io/update-a-product-tag-18089677e0.md): Update a product tag's details. - Product Tags [Create Product Tag](https://medusa.apidog.io/create-product-tag-18089678e0.md): Create a product tag. - Product Tags [List Product Tags](https://medusa.apidog.io/list-product-tags-18089679e0.md): Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. - Product Types [Delete a Product Type](https://medusa.apidog.io/delete-a-product-type-18089680e0.md): Delete a product type. This doesn't delete products of this type. - Product Types [Get a Product Type](https://medusa.apidog.io/get-a-product-type-18089681e0.md): Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned. - Product Types [Update a Product Type](https://medusa.apidog.io/update-a-product-type-18089682e0.md): Update a product type's details. - Product Types [Create Product Type](https://medusa.apidog.io/create-product-type-18089683e0.md): Create a product type. - Product Types [List Product Types](https://medusa.apidog.io/list-product-types-18089684e0.md): Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. - Refund Reasons [Get a Refund Reason](https://medusa.apidog.io/get-a-refund-reason-18089685e0.md): Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned. - Refund Reasons [Update a Refund Reason](https://medusa.apidog.io/update-a-refund-reason-18089686e0.md): Update a refund reason's details. - Refund Reasons [Delete a Refund Reason](https://medusa.apidog.io/delete-a-refund-reason-18089687e0.md): Delete a refund reason. - Refund Reasons [Create Refund Reason](https://medusa.apidog.io/create-refund-reason-18089688e0.md): Create a refund reason. - Refund Reasons [List Refund Reasons](https://medusa.apidog.io/list-refund-reasons-18089689e0.md): Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated. - Uploads [Get a File](https://medusa.apidog.io/get-a-file-18089690e0.md): Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned. - Uploads [Delete a File](https://medusa.apidog.io/delete-a-file-18089691e0.md): Delete a file. Uses the installed file module provider to delete the file. - Uploads [Upload Files](https://medusa.apidog.io/upload-files-18089692e0.md): Upload files to the configured File Module Provider. - Campaigns [Manage the Promotions of a Campaign](https://medusa.apidog.io/manage-the-promotions-of-a-campaign-18089693e0.md): Manage the promotions of a campaign, either by adding them or removing them from the campaign. - Campaigns [Get a Campaign](https://medusa.apidog.io/get-a-campaign-18089694e0.md): Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned using the query parameters. - Campaigns [Delete a Campaign](https://medusa.apidog.io/delete-a-campaign-18089695e0.md): Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign. - Campaigns [Update a Campaign](https://medusa.apidog.io/update-a-campaign-18089696e0.md): Update a campaign's details. - Campaigns [List Campaigns](https://medusa.apidog.io/list-campaigns-18089697e0.md): Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. - Campaigns [Create Campaign](https://medusa.apidog.io/create-campaign-18089698e0.md): Create a campaign. - Collections [Manage Products of a Collection](https://medusa.apidog.io/manage-products-of-a-collection-18089699e0.md): Manage the products of a collection by adding or removing them from the collection. - Collections [Delete a Collection](https://medusa.apidog.io/delete-a-collection-18089700e0.md): Delete a product collection. - Collections [Get a Collection](https://medusa.apidog.io/get-a-collection-18089701e0.md): Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned using the query parameters. - Collections [Update a Collection](https://medusa.apidog.io/update-a-collection-18089702e0.md): Update a collection's details. - Collections [Create Collection](https://medusa.apidog.io/create-collection-18089703e0.md): Create a collection. - Collections [List Collections](https://medusa.apidog.io/list-collections-18089704e0.md): Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. - Customers [Manage Customer Groups of Customer](https://medusa.apidog.io/manage-customer-groups-of-customer-18089705e0.md): Manage the customer groups of a customer, adding or removing the customer from those groups. - Customers [Get a Customer](https://medusa.apidog.io/get-a-customer-18089706e0.md): Retrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned. - Customers [Delete a Customer](https://medusa.apidog.io/delete-a-customer-18089707e0.md): Delete a customer. - Customers [Update a Customer](https://medusa.apidog.io/update-a-customer-18089708e0.md): Update a customer's details. - Customers [List Addresses](https://medusa.apidog.io/list-addresses-18089709e0.md): Retrieve a list of addresses in a customer. The addresses can be filtered by fields like `query`. The addresses can also be paginated. - Customers [Add a Customer Address](https://medusa.apidog.io/add-a-customer-address-18089710e0.md): Add an address to a customer. - Customers [List Addresses](https://medusa.apidog.io/list-addresses-18089711e0.md): Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated. - Customers [Remove an Address from Customer](https://medusa.apidog.io/remove-an-address-from-customer-18089712e0.md): Remove a customer's address. - Customers [Update a Customer's Address](https://medusa.apidog.io/update-a-customers-address-18089713e0.md): Update a customer address's details. - Customers [Create Customer](https://medusa.apidog.io/create-customer-18089714e0.md): Create a customer. - Customers [List Customers](https://medusa.apidog.io/list-customers-18089715e0.md): Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. - Product Categories [Manage Products in Product Category](https://medusa.apidog.io/manage-products-in-product-category-18089716e0.md): Manage products of a category to add or remove them. - Product Categories [Delete a Product Category](https://medusa.apidog.io/delete-a-product-category-18089717e0.md): Delete a product category. This doesn't deleted products in that category. - Product Categories [Get a Product Category](https://medusa.apidog.io/get-a-product-category-18089718e0.md): Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. - Product Categories [Update a Product Category](https://medusa.apidog.io/update-a-product-category-18089719e0.md): Update a product category's details. - Product Categories [Create Product Category](https://medusa.apidog.io/create-product-category-18089720e0.md): Create a product category. - Product Categories [List Product Categories](https://medusa.apidog.io/list-product-categories-18089721e0.md): Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. - Reservations [Get a Reservation](https://medusa.apidog.io/get-a-reservation-18089722e0.md): Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned. - Reservations [Update a Reservation](https://medusa.apidog.io/update-a-reservation-18089723e0.md): Update a reservation's details. - Reservations [Delete a Reservation](https://medusa.apidog.io/delete-a-reservation-18089724e0.md): Delete a reservation. - Reservations [Create Reservation](https://medusa.apidog.io/create-reservation-18089725e0.md): Create a reservation. - Reservations [List Reservations](https://medusa.apidog.io/list-reservations-18089726e0.md): Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated. - Shipping Profiles [Delete a Shipping Profile](https://medusa.apidog.io/delete-a-shipping-profile-18089727e0.md): Delete a shipping profile. - Shipping Profiles [Get a Shipping Profile](https://medusa.apidog.io/get-a-shipping-profile-18089728e0.md): Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned. - Shipping Profiles [Update a Shipping Profile](https://medusa.apidog.io/update-a-shipping-profile-18089729e0.md): Update a shipping profile's details. - Shipping Profiles [Create Shipping Profile](https://medusa.apidog.io/create-shipping-profile-18089730e0.md): Create a shipping profile. - Shipping Profiles [List Shipping Profiles](https://medusa.apidog.io/list-shipping-profiles-18089731e0.md): Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated. - Regions [Get a Region](https://medusa.apidog.io/get-a-region-18089732e0.md): Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned. - Regions [Delete a Region](https://medusa.apidog.io/delete-a-region-18089733e0.md): Delete a region. - Regions [Update a Region](https://medusa.apidog.io/update-a-region-18089734e0.md): Update a region's details. - Regions [Create Region](https://medusa.apidog.io/create-region-18089735e0.md): Create a region. - Regions [List Regions](https://medusa.apidog.io/list-regions-18089736e0.md): Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. - Tax Providers [List Tax Providers](https://medusa.apidog.io/list-tax-providers-18089737e0.md): Retrieve a list of tax providers installed in the Medusa application through Tax Module Providers. The tax providers can be filtered by fields such as `id`. The tax providers can also be sorted or paginated. - Shipping Options [Manage the Rules of a Shipping Option](https://medusa.apidog.io/manage-the-rules-of-a-shipping-option-18089738e0.md): Manage the rules of a shipping option to create, update, or delete them. - Shipping Options [Create Shipping Option](https://medusa.apidog.io/create-shipping-option-18089739e0.md): Create a shipping option. - Shipping Options [List Shipping Options](https://medusa.apidog.io/list-shipping-options-18089740e0.md): Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. - Shipping Options [Delete a Shipping Option](https://medusa.apidog.io/delete-a-shipping-option-18089741e0.md): Delete a shipping option. - Shipping Options [Get a Shipping Option](https://medusa.apidog.io/get-a-shipping-option-18089742e0.md): Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned. - Shipping Options [Update a Shipping Option](https://medusa.apidog.io/update-a-shipping-option-18089743e0.md): Update a shipping option's details. - Product Variants [List Product Variants](https://medusa.apidog.io/list-product-variants-18089744e0.md): Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated.