Medusa Admin

Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign.

Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` 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.

Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` 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.

Remove the shipping method for returning items in the claim 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.

Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` 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.

Remove the shipping method for delivering outbound items in the claim 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.

Cancel a requested claim.

Delete a product collection.

Delete a customer group. Customers in the group aren't deleted.

Delete a customer.

Remove a customer's address.

Delete a draft order.

Cancel an unconfirmed edit on a draft order.

Remove an order item from a draft order edit by the ID of the item's `ITEM_ADD` or `ITEM_UPDATE` 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.

Remove specified promotions from a draft order edit.

Remove a shipping method that was added to a draft order edit 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.

Remove an existing shipping method from a draft order edit.

Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` 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.

Remove the shipping method for returning items in the exchange 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.

Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` 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.

Remove the shipping method for delivering outbound items in the exchange 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.

Cancel a requested exchange.

Delete a fulfillment set.

Remove a service zone that belongs to a fulfillment set.

Delete an inventory item.

Remove the inventory level of an inventory item. If the inventory level has reserved quantity greater than `0`, an error is thrown.

Delete an invite.

Clears all user layout configurations for a given zone. This action will remove any customizations made by the user and revert to the system defaults.

Cancel a requested order edit.

Remove an added item in the order edit by the ID of the item's `ITEM_ADD` 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.

Remove a shipping method in the order edit by 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.

Delete a payment collection.

Delete a price list.

Delete a price preference.

Delete a product category. This doesn't delete the products in that category. A product category that has child categories can't be deleted, so you must delete its child categories first.

Delete a product option.

Remove a Value from a product option.

Delete a product tag. This doesn't delete products using the tag.

Delete a product type. This doesn't delete products of this type.

Delete a product.

Delete a variant of a product.

Remove the association between an inventory item and its product variant.

Delete a promotion.

Delete a property label.

Delete a refund reason.

Delete a region.

Delete a reservation.

Delete a return reason.

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. 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. return.

Cancel the receival process previously started, and hasn't been confirmed, of a return.

Remove a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` 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. return.

Cancel a requested return.

Remove a requested item to be returned by the ID of the item's `RETURN_ITEM` 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. return.

Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` 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.

Delete a sales channel.

Delete a shipping option type.

Delete a shipping option.

Delete a shipping profile.

Delete a stock location.

Delete a tax rate.

Remove a tax rate's rule.

Delete a tax region.

Delete a file. Uses the installed file module provider to delete the file.

Delete a user.

Remove view configurations of an entity. An admin user can only delete their own configurations.

Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated.

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.

Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated.

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.

Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated.

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.

Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated.

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.

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.

Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned.

Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated.

Retrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned.

Retrieve a list of addresses in a customer. The addresses can be filtered by fields like `query`. The addresses can also be paginated.

Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated.

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.

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.

Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated.

Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.

Retrieve a list of feature flags. The feature flags can be filtered by fields such as `id`. The feature flags can also be sorted or paginated.

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.

Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.

Retrieve a service zone that belongs to a fulfillment set. be paginated.

Retrieve a list of gift cards. The gift cards can be filtered by fields such as `id`. The gift cards can also be sorted or paginated.

Retrieve a gift card by its ID. You can expand the gift card's relations or select the fields that should be returned.

Retrieve the list of orders that a gift card was used in.

Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp.

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.

Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned.

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.

Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated.

Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned.

Retrieve a list of layout configurations made by admin users. The layouts can be filtered by fields such as `id`. The layouts can also be sorted or paginated.

Retrieve a list of layout configurations for a specific zone. These are the configurations made by the users for their admin dashboard layouts.

Retrieve a list of locales. The locales can be filtered by fields such as `code`. The locales can also be sorted or paginated.

Retrieve a locale by its code. You can expand the locale's relations or select the fields that should be returned.

Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated.

Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned.

Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated.

Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned.

Retrieve a list of changes made on an order, including returns, exchanges, etc... The changes can be filtered by fields like `created_at`. The changes can also be paginated.

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.

Retrieve a preview of an order using its associated change, such as an edit.

Retrieve a list of shipping options that can be used for outbound shipping in an order. This is especially useful when adding outbound shipping to order exchanges or claims.

Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated.

Retrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned.

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.

Retrieve the list of plugins installed in the Medusa application.

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.

Retrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned.

Retrieve a list of prices in a price list. The prices can be filtered by fields like FILTER FIELDS. The prices can also be paginated.

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.

Retrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned.

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.

Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.

Retrieve a list of product options. The product options can be filtered by fields such as `id`. The product options can also be sorted or paginated.

Retrieve a product option by its ID. You can expand the product option's relations or select the fields that should be returned.

Retrieve a list of values in a product option. The values can be filtered by fields like `id`. The values can also be paginated.

Get a product option value by its ID.

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.

Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.

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.

Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.

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.

Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.

Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.

Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated.

Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated.

Retrieve a product's variant by its ID.

Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated.

Retrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned.

Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved.

Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved: - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved.

Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type. For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to `rules`, a list of currencies are retrieved in label-value pairs.

Retrieve a list of property labels. The property labels can be filtered by fields such as `id`. The property labels can also be sorted or paginated.

Retrieve a property label by its ID.

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.

Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned.

Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.

Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.

Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated.

Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned.

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.

Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.

Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated.

Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned.

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.

Retrieve a sales channel by its ID. You can expand the sales channel's relations or select the fields that should be returned.

Retrieve a list of search. The search can be filtered by fields such as `id`. The search can also be sorted or paginated.

Retrieve a list of shipping option types. The shipping option types can be filtered by fields such as `id`. The shipping option types can also be sorted or paginated.

Retrieve a shipping option type by its ID. You can expand the shipping option type's relations or select the fields that should be returned.

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.

Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned.

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.

Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned.

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.

Retrieve a stock location by its ID. You can expand the stock location's relations or select the fields that should be returned.

Retrieve a list of store credit accounts. The store credit accounts can be filtered by fields such as `id`. The store credit accounts can also be sorted or paginated.

Retrieve a store credit account by its ID. You can expand the store credit account's relations or select the fields that should be returned.

Retrieve a list of transactions in a store credit account. The transactions can be filtered by fields like FILTER FIELDS. The transactions can also be paginated.

Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated.

Retrieve a store by its ID. You can expand the store's relations or select the fields that should be returned.

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.

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.

Retrieve a tax rate by its ID. You can expand the tax rate's relations or select the fields that should be returned.

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.

Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned.

Retrieve a list of translations. The translations can be filtered by fields such as `reference_id` (For example, the ID of a product). The translations can also be sorted or paginated.

Retrieve a list of translatable entities. The entities can be filtered by fields such as `id`. The entities can also be sorted or paginated.

Retrieve the list of translatable fields for all entities, such as products and collections. You can also filter the results by entity type or active entities.

Get statistics on translations for specified locales and entity types. This includes overall translation progress for each entity type, and statistics for each locale within those entity types.

Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned.

Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated.

Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned.

Retrieve the logged-in user's details.

Retrieve a list of views. The views can be filtered by fields such as `id`. The views can also be sorted or paginated.

Retrieve a list of columns in a view for an entity. The columns are retrieved for the authenticated admin user.

Retrieve a list of view configurations of an entity. The configurations can be filtered by fields like `id`. The configurations can also be paginated. An admin user can only retrieve their own configurations.

Get the active view configurations for an entity. If no active view is set, `null` is returned. An admin user can only retrieve their own active configuration.

Retrieve a view configuration for an entity. An admin user can only retrieve their own configurations.

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.

Retrieve a workflows execution by its ID. You can expand the workflows execution's relations or select the fields that should be returned.

Subscribe to a workflow's execution to receive real-time information about its steps, status, and data. This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).

Get the details of the workflow's execution.

Subscribe to workflow execution events for a specific workflow and transaction. This endpoint establishes a Server-Sent Events (SSE) connection, allowing clients to receive real-time updates about the workflow execution. The events include details such as the event type, workflow ID, transaction ID, step information, response, result, and any errors that occur during the execution.

Create a campaign.

Update a campaign's details.

Manage the promotions of a campaign, either by adding them or removing them from the campaign.

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.

Cancel a claim and its associated return.

Add order items to a claim as claim items. These claim items will have the action `WRITE_OFF_ITEM`.

Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` 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.

Add inbound (or return) items to a claim. These inbound items will have a `RETURN_ITEM` action.

Update an inbound (or return) item of a claim using the `ID` of the item's `RETURN_ITEM` 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.

Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a `SHIPPING_ADD` action.

Update the shipping method for returning items in the claim 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.

Add outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.

Update an outbound (or new) item of a claim using the `ID` of the item's `ITEM_ADD` 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.

Add an outbound shipping method to a claim. The outbound shipping method will have a `SHIPPING_ADD` action.

Update the shipping method for delivering outbound items in a claim 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.

Confirm a claim request, applying its changes on the associated order.

Create a collection.

Update a collection's details.

Manage the products of a collection by adding or removing them from the collection.

Create a customer group.

Update a customer group's details.

Manage the customers of a group to add or remove them from the group.

Create a customer.

Update a customer's details.

Add an address to a customer.

Update a customer address's details.

Manage the customer groups of a customer, adding or removing the customer from those groups.

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.

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.

Convert a draft order to an order. This will finalize the draft order and create a new order with the same details.

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.

Confirm an edit on a draft order. This will apply the changes made to the draft order.

Add an item to a draft order edit.

Update a new item that was added to a draft order edit by the ID of the item's `ITEM_ADD` 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.

Update an existing item in a draft order edit.

Add promotions to a draft order edit.

Change the status of a draft order's edit to be requested. Later, the edit can be confirmed or canceled.

Add a shipping method to a draft order edit.

Update a new shipping method that was added to a draft order edit 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.

Update an existing shipping method in a draft order edit.

Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed.

Cancel an exchange and its associated return.

Add inbound (or return) items to an exchange. These inbound items will have the action `RETURN_ITEM`.

Update an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` 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.

Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a `SHIPPING_ADD` action.

Update the shipping method for returning items in the exchange 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.

Add outbound (or new) items to an exchange. These outbound items will have the action `ITEM_ADD`.

Update an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` 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.

Add an outbound shipping method to an exchange. The outbound shipping method will have a `SHIPPING_ADD` action.

Update the shipping method for delivering outbound items in the exchange 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.

Confirm an exchange request, applying its changes on the associated order.

Add a service zone to a fulfillment set.

Update the details of a service zone in a fulfillment set.

Create a fulfillment for an order, return, exchange, and more.

Cancel a fulfillment. The fulfillment can't be shipped or delivered. To cancel the fulfillment, the `cancelFulfillment` method of the associated fulfillment provider is used.

Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled.

Create a gift card.

Update a gift card's details.

Trigger reindexing or re-ingestion of the Index Module.

Create an inventory item.

Start an inventory items export process to retrieve a CSV of exported inventory items. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-inventory-items/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.

Update an inventory item's details.

Create an inventory level for an inventory item.

Manage the inventory levels of an inventory item to create or delete them.

Updates the details of an inventory item's inventory level using its associated location ID.

Manage inventory levels to create, update, or delete them.

Create a invite.

Accept an invite and create a new user. Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route.

Refresh the token of an invite.

Add a layout configuration for a specific zone. This allows you to customize the layout of the admin dashboard for that zone, including the arrangement of widgets and other UI elements.

Update an order change's details. An order change can be an exchange, claim, or edit. For example, you can edit whether an exchange carries over the parent order's promotion.

Create an order edit.

Confirm an order edit request and apply the changes on the order.

Add new items to an order edit. These items will have the action `ITEM_ADD`.

Update an added item in the order edit by the ID of the item's `ITEM_ADD` 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.

Update an existing order item's quantity of an order edit. You can also use this API route to remove an item from an order by setting its quantity to `0`.

Change the status of an active order edit to requested.

Add a shipping method to an exchange. The shipping method will have a `SHIPPING_ADD` action.

Update a shipping method in the order edit by 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.

Start an order export process to retrieve a CSV of exported orders. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-orders/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.

Update an order's details. Updating the order's shipping or billing address doesn't recalculate the order's taxes or totals; the existing tax lines are preserved as-is. You also can't change the address's `country_code`.

Change the status of an order to archived.

Cancel an order. The cancelation fails if: - The order has captured payments. - The order has refund payments. - The order has fulfillments that aren't canceled.

Mark an order as completed.

Create a credit line for an order.

Create a fulfillment for an order. The creation fails if the order is canceled.

Cancel an order's fulfillment. The fulfillment can't be canceled if it's shipped.

Mark an order's fulfillment as delivered.

Create a shipment for an order's fulfillment.

Authorize a payment session for an order. This is useful for orders created from draft orders.

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.

Cancel a request to transfer an order to another customer.

Transfer an order to a guest customer. This is useful when the order email was incorrectly entered and you want to set it to a guest customer. The order will be transferred to a new guest customer with the provided email. For transferring orders to registered customer, check out the [Request Order Transfer](https://docs.medusajs.com/api/admin#orders_postordersidtransfer) API route instead.

Create a payment collection.

Mark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider.

Initialize a Payment Session in a payment collection. This is useful for orders placed outside the checkout flow, such as draft orders, or when a payment session needs to be re-initialized for an existing payment collection.

Capture an amount of a payment. This uses the `capturePayment` method of the payment provider associated with the payment's collection.

Refund an amount of a payment. This uses the `refundPayment` method of the payment provider associated with the payment's collection.

Create a price list.

Update a price list's details.

Manage the prices of a price list to create, update, or delete them.

Remove products from a price list.

Create a price preference.

Update a price preference's details.

Create a product category.

Update a product category's details.

Manage products of a category to add or remove them.

Create a product option.

Update a product option's details.

Update a product option value's details.

Create a product tag.

Update a product tag's details.

Create a product type.

Update a product type's details.

Create a product.

Manage products to create, update, or delete them.

Start a product export process to retrieve a CSV of exported products. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.

Update a product's details.

Manage the association between product variants and a product image. You can add or remove associations between variants and the image.

Add a list of options to a product.

Create a variant for a product.

Manage variants in a product to create, update, or delete them.

Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items.

Update a variant's details.

Manage the association between product images and a product variant. You can add or remove associations between images and the variant.

Associate with a product variant an inventory item that manages its inventory details.

Update the inventory item that manages the inventory details of a product variant.

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.

Confirm that a created product import should start importing the products into Medusa.

Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/imports` API route.

Confirm that a created product import should start importing the products into Medusa.

Create a promotion.

Update a promotion's details.

Manage the buy rules of a `buyget` promotion to create, update, or delete them.

Manage the rules of a promotion to create, update, or delete them.

Manage the target rules of a promotion to create, update, or delete them.

Create a property label.

Create a property label.

Update a property label's details.

Create a refund reason.

Update a refund reason's details.

Create a region.

Update a region's details.

Create a reservation.

Update a reservation's details.

Create a return reason.

Update a return reason's details.

Create a return. The return can later be requested or confirmed.

Update a return's details.

Cancel a return.

Add damaged items, whose quantity is to be dismissed, to a return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`.

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. 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. return.

Start a return receival process to be later confirmed using the `/admin/returns/:id/receive/confirm` API route.

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.

Add received items in a return. These items will have the action `RECEIVE_RETURN_ITEM`.

Update a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` 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. return.

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`.

Add items that are requested to be returned. These items will have the action `RETURN_ITEM`.

Update a requested item to be returned by the ID of the item's `RETURN_ITEM` 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. return.

Add a shipping method to a return. The shipping method will have a `SHIPPING_ADD` action.

Update a shipping method of the return by the ID of the item's `SHIPPING_ADD` 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.

Create a sales channel.

Update a sales channel's details.

Manage products in a sales channel to add or remove them from the channel.

Create a shipping option type.

Update a shipping option type's details.

Create a shipping option.

Update a shipping option's details. When you provide the `prices` array, it replaces the shipping option's existing flat-rate prices: - A price with a matching `id` is updated. - A price without an `id` is created - Any existing price whose `id` isn't included in the array is deleted. The `rules` you provide for a price similarly replace that price's existing rules, so omit a rule to remove it. Omitting the `prices` property entirely leaves the existing prices unchanged, whereas setting `price_type` to `calculated` removes all flat-rate prices.

Manage the rules of a shipping option to create, update, or delete them.