Medusa Admin API
Medusa Admin API endpoints from Medusa
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Medusa Admin API endpoints from Medusa
Endpoints 400
Api Keys
- GETList API Keys
/admin/api-keys?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&title=string&token=string&type=secret&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&revoked_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Api Key
/admin/api-keysCreate a secret or publishable API key. A secret API key is used for admin authentication. A publishable API key is used by client applications to set the… - GETGet API Key
/admin/api-keys/:id?fields=stringRetrieve 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. - POSTUpdate an API Key
/admin/api-keys/:id?fields=stringUpdate an API key's details. - DELETEDelete an Api Key
/admin/api-keys/:idDelete a publishable or secret API key. - POSTRevoke API Key
/admin/api-keys/:id/revoke?fields=stringRevokes 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. - POSTManage Sales Channels of a Publishable API Key
/admin/api-keys/:id/sales-channels?fields=stringManage the sales channels of a publishable API key, either to associate them or remove them from the API key.
Auth
- DELETEDisable a Multi-Factor Authentication (MFA) Factor
/auth/mfa/factors/:idDisable a multi-factor authentication (MFA) factor for the authenticated user. Once disabled, the factor can no longer be used to verify MFA challenges. When… - POSTSet Authentication Session
/auth/sessionSet 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… - DELETEDelete Authentication Session
/auth/sessionDeletes the cookie session ID previously set for authentication. - POSTRefresh Authentication Token
/auth/token/refreshRefresh 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… - GETList Auth Providers for Admin Users
/auth/user/providersRetrieve a list of auth providers for the user actor type. This is useful to show the authentication option for the available providers. - POSTAuthenticate User
/auth/user/:auth_providerAuthenticate a user and receive the JWT token to be used in the header of subsequent requests. When used with a third-party provider, such as Google, the… - POSTValidate Authentication Callback
/auth/user/:auth_provider/callbackThis API route is used by your dashboard or frontend application when a third-party provider redirects to it after authentication. It validates the… - POSTRetrieve Registration JWT Token
/auth/user/:auth_provider/registerThis 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,… - POSTGenerate Reset Password Token for Admin User
/auth/user/:auth_provider/reset-passwordGenerate 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.… - POSTReset an Admin User's Password
/auth/user/:auth_provider/updateReset an admin user's password using a reset-password token generated with the Generate Reset Password Token API route. You pass the token as a bearer token…
Campaigns
- GETList Campaigns
/admin/campaigns?fields=string&offset=0.0&limit=0.0&order=string&with_deleted=true&q=string&campaign_identifier=string&budget={"currency_code":"usd"}&$and={}&$or={}Retrieve a list of campaigns. The campaigns can be filtered by fields such as id. The campaigns can also be sorted or paginated. - POSTCreate Campaign
/admin/campaigns?fields=stringCreate a campaign. - GETGet a Campaign
/admin/campaigns/:id?fields=stringRetrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned using the query parameters. - POSTUpdate a Campaign
/admin/campaigns/:id?fields=stringUpdate a campaign's details. - DELETEDelete a Campaign
/admin/campaigns/:idDelete a campaign by its ID. This doesn't delete promotions that belong to this campaign. - POSTManage the Promotions of a Campaign
/admin/campaigns/:id/promotions?fields=stringManage the promotions of a campaign, either by adding them or removing them from the campaign.
Claims
- GETList Claims
/admin/claims?fields=string&offset=0.0&limit=0.0&order=string&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&id=string&order_id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve a list of claims. The claims can be filtered by fields such as id. The claims can also be sorted or paginated. - POSTCreate a Claim
/admin/claims?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}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. - GETGet a Claim
/admin/claims/:id?fields=stringRetrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned using the query parameters. - POSTCancel a Claim
/admin/claims/:id/cancelCancel a claim and its associated return. - POSTAdd Claim Items to a Claim
/admin/claims/:id/claim-items?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}Add order items to a claim as claim items. These claim items will have the action WRITE_OFF_ITEM. - POSTUpdate a Claim Item
/admin/claims/:id/claim-items/:action_id?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}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… - DELETERemove a Claim Item from a Claim
/admin/claims/:id/claim-items/:action_id?fields=stringRemove 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… - POSTAdd Inbound Items to a Claim
/admin/claims/:id/inbound/itemsAdd inbound (or return) items to a claim. These inbound items will have a RETURN_ITEM action. - POSTUpdate Inbound Items of a Claim
/admin/claims/:id/inbound/items/:action_idUpdate 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… - DELETERemove an Inbound Item from Claim
/admin/claims/:id/inbound/items/:action_id?fields=stringRemove 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… - POSTAdd an Inbound Shipping Method to a Claim
/admin/claims/:id/inbound/shipping-methodAdd an inbound (or return) shipping method to a claim. The inbound shipping method will have a SHIPPING_ADD action. - POSTUpdate Inbound Shipping Method of a Claim
/admin/claims/:id/inbound/shipping-method/:action_id?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}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,… - DELETERemove Inbound Shipping Method from Claim
/admin/claims/:id/inbound/shipping-method/:action_id?fields=stringRemove 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,… - POSTAdd Outbound Items to a Claim
/admin/claims/:id/outbound/items?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}Add outbound (or new) items to a claim. These outbound items will have an ITEM_ADD action. - POSTUpdate Outbound Item of a Claim
/admin/claims/:id/outbound/items/:action_id?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}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… - DELETERemove an Outbound Item from Claim
/admin/claims/:id/outbound/items/:action_id?fields=stringRemove 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… - POSTAdd Outbound Shipping Methods to a Claim
/admin/claims/:id/outbound/shipping-method?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}Add an outbound shipping method to a claim. The outbound shipping method will have a SHIPPING_ADD action. - POSTUpdate Outbound Shipping Method of a Claim
/admin/claims/:id/outbound/shipping-method/:action_id?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}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… - DELETERemove Outbound Shipping Method from Claim
/admin/claims/:id/outbound/shipping-method/:action_id?fields=stringRemove 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… - POSTConfirm a Claim Request
/admin/claims/:id/request?fields=string&id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}Confirm a claim request, applying its changes on the associated order. - DELETECancel Claim Request
/admin/claims/:id/requestCancel a requested claim.
Collections
- GETList Collections
/admin/collections?fields=string&offset=0.0&limit=0.0&order=string&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&q=string&id=string&handle=string&title=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&external_id=stringRetrieve a list of collections. The collections can be filtered by fields such as id. The collections can also be sorted or paginated. - POSTCreate Collection
/admin/collections?fields=stringCreate a collection. - GETGet a Collection
/admin/collections/:id?fields=stringRetrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned using the query parameters. - POSTUpdate a Collection
/admin/collections/:id?fields=stringUpdate a collection's details. - DELETEDelete a Collection
/admin/collections/:idDelete a product collection. - POSTManage Products of a Collection
/admin/collections/:id/products?fields=stringManage the products of a collection by adding or removing them from the collection.
Currencies
- GETList Currencies
/admin/currencies?fields=string&offset=0.0&limit=0.0&order=string&q=string&code=string&$and={}&$or={}&with_deleted=trueRetrieve a list of currencies. The currencies can be filtered by fields such as id. The currencies can also be sorted or paginated. - GETGet a Currency
/admin/currencies/:code?fields=stringRetrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters.
Customer Groups
- GETList Customer Groups
/admin/customer-groups?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&name=string&customers=string&created_by=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Customer Group
/admin/customer-groups?fields=stringCreate a customer group. - GETGet a Customer Group
/admin/customer-groups/:id?fields=stringRetrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned. - POSTUpdate a Customer Group
/admin/customer-groups/:id?fields=stringUpdate a customer group's details. - DELETEDelete a Customer Group
/admin/customer-groups/:idDelete a customer group. Customers in the group aren't deleted. - POSTManage Customers of a Customer Group
/admin/customer-groups/:id/customers?fields=stringManage the customers of a group to add or remove them from the group.
Customers
- GETList Customers
/admin/customers?fields=string&offset=0.0&limit=0.0&order=string&groups=string&q=string&id=string&email=user@example.com&company_name=string&first_name=string&last_name=string&created_by=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&has_account=true&with_deleted=trueRetrieve a list of customers. The customers can be filtered by fields such as id. The customers can also be sorted or paginated. - POSTCreate Customer
/admin/customers?fields=stringCreate a customer. - POSTExport Customers
/admin/customers/export?groups=string&has_account=true&q=string&id=string&email=user@example.com&company_name=string&first_name=string&last_name=string&created_by=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}Start a customer export process to retrieve a file of exported customers. Use the query parameters to filter the exported customers and select the fields to… - GETGet a Customer
/admin/customers/:id?fields=stringRetrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned. - POSTUpdate a Customer
/admin/customers/:id?fields=stringUpdate a customer's details. - DELETEDelete a Customer
/admin/customers/:idDelete a customer. - GETList Addresses
/admin/customers/:id/addresses?fields=string&offset=0.0&limit=0.0&order=string&q=string&company=string&city=string&country_code=string&province=us-ca&postal_code=string&$and={}&$or={}&with_deleted=trueRetrieve a list of addresses in a customer. The addresses can be filtered by fields like query. The addresses can also be paginated. - POSTAdd a Customer Address
/admin/customers/:id/addresses?fields=stringAdd an address to a customer. - GETList Addresses
/admin/customers/:id/addresses/:address_id?fields=stringRetrieve a list of a customer's addresses. The addresses can be filtered by fields like company. The addresses can also be paginated. - POSTUpdate a Customer's Address
/admin/customers/:id/addresses/:address_id?fields=stringUpdate a customer address's details. - DELETERemove an Address from Customer
/admin/customers/:id/addresses/:address_id?fields=stringRemove a customer's address. - POSTManage Customer Groups of Customer
/admin/customers/:id/customer-groups?fields=stringManage the customer groups of a customer, adding or removing the customer from those groups.
Draft Orders
- GETList Draft Orders
/admin/draft-orders?fields=string&offset=0.0&limit=0.0&order=string&id=string&$and={}&$or={}&sales_channel_id=string®ion_id=string&q=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&customer_id=string&with_deleted=trueRetrieve 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. - POSTCreate Draft Order
/admin/draft-orders?fields=stringCreate a draft order. This creates an order with the is_draft_order property enabled. You can later convert the draft order to an order. - GETGet a Draft Order
/admin/draft-orders/:id?fields=stringRetrieve 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. - POSTUpdate a Draft Order
/admin/draft-orders/:id?fields=stringUpdate 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… - DELETEDelete a Draft Order
/admin/draft-orders/:idDelete a draft order. - POSTConvert a Draft Order to an Order
/admin/draft-orders/:id/convert-to-orderConvert a draft order to an order. This will finalize the draft order and create a new order with the same details. - POSTCreate a Draft Order Edit
/admin/draft-orders/:id/editCreate 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… - DELETECancel Edit on Draft Order
/admin/draft-orders/:id/editCancel an unconfirmed edit on a draft order. - POSTConfirm an Edit on a Draft Order
/admin/draft-orders/:id/edit/confirmConfirm an edit on a draft order. This will apply the changes made to the draft order. - POSTAdd Item to Draft Order Edit
/admin/draft-orders/:id/edit/itemsAdd an item to a draft order edit. - POSTUpdate Existing Item in Draft Order Edit
/admin/draft-orders/:id/edit/items/item/:item_idUpdate an existing item in a draft order edit. - POSTUpdate New Item in Draft Order Edit
/admin/draft-orders/:id/edit/items/:action_idUpdate 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… - DELETERemove Item from Draft Order Edit
/admin/draft-orders/:id/edit/items/:action_idRemove 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… - POSTAdd Promotions to Draft Order Edit
/admin/draft-orders/:id/edit/promotionsAdd promotions to a draft order edit. - DELETERemove Promotions from Draft Order Edit
/admin/draft-orders/:id/edit/promotionsRemove specified promotions from a draft order edit. - POSTRequest Edit on Draft Order
/admin/draft-orders/:id/edit/requestChange the status of a draft order's edit to be requested. Later, the edit can be confirmed or canceled. - POSTAdd Shipping Method to Draft Order Edit
/admin/draft-orders/:id/edit/shipping-methodsAdd a shipping method to a draft order edit. - POSTUpdate Existing Shipping Method in Draft Order Edit
/admin/draft-orders/:id/edit/shipping-methods/method/:method_idUpdate an existing shipping method in a draft order edit. - DELETERemove Shipping Method from Draft Order Edit
/admin/draft-orders/:id/edit/shipping-methods/method/:method_idRemove an existing shipping method from a draft order edit. - POSTUpdate New Shipping Method in Draft Order Edit
/admin/draft-orders/:id/edit/shipping-methods/:action_idUpdate 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… - DELETERemove New Shipping Method from Draft Order
/admin/draft-orders/:id/edit/shipping-methods/:action_idRemove 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,…
Exchanges
- GETList Exchanges
/admin/exchanges?fields=string&offset=0.0&limit=0.0&order=string&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&id=string&order_id=string&status=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&with_deleted=trueRetrieve a list of exchanges. The exchanges can be filtered by fields such as id. The exchanges can also be sorted or paginated. - POSTCreate Exchange
/admin/exchanges?fields=stringCreate an exchange request. Its changes aren't applied on the order until the exchange is confirmed. - GETGet an Exchange
/admin/exchanges/:id?fields=stringRetrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters. - POSTCancel an Exchange
/admin/exchanges/:id/cancelCancel an exchange and its associated return. - POSTAdd Inbound Items to an Exchange
/admin/exchanges/:id/inbound/items?fields=stringAdd inbound (or return) items to an exchange. These inbound items will have the action RETURN_ITEM. - POSTUpdate an Inbount Item of an Exchange
/admin/exchanges/:id/inbound/items/:action_idUpdate 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… - DELETERemove Inbound Item from Exchange
/admin/exchanges/:id/inbound/items/:action_id?fields=stringRemove 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… - POSTAdd an Inbound Shipping Method to an Exchange
/admin/exchanges/:id/inbound/shipping-methodAdd an inbound (or return) shipping method to an exchange. The inbound shipping method will have a SHIPPING_ADD action. - POSTUpdate Inbound Shipping Method of an Exchange
/admin/exchanges/:id/inbound/shipping-method/:action_id?fields=stringUpdate 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… - DELETERemove Inbound Shipping Method from Exchange
/admin/exchanges/:id/inbound/shipping-method/:action_id?fields=stringRemove 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… - POSTAdd Outbound Items to Exchange
/admin/exchanges/:id/outbound/items?fields=stringAdd outbound (or new) items to an exchange. These outbound items will have the action ITEM_ADD. - POSTUpdate Outbound Item of an Exchange
/admin/exchanges/:id/outbound/items/:action_id?fields=stringUpdate 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… - DELETERemove Outbound Item from Exchange
/admin/exchanges/:id/outbound/items/:action_id?fields=stringRemove 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… - POSTAdd Outbound Shipping Method to Exchange
/admin/exchanges/:id/outbound/shipping-method?fields=stringAdd an outbound shipping method to an exchange. The outbound shipping method will have a SHIPPING_ADD action. - POSTUpdate Outbound Shipping Method of Exchange
/admin/exchanges/:id/outbound/shipping-method/:action_id?fields=stringUpdate 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… - DELETERemove Outbound Shipping Method from Exchange
/admin/exchanges/:id/outbound/shipping-method/:action_id?fields=stringRemove 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… - POSTConfirm an Exchange
/admin/exchanges/:id/request?fields=stringConfirm an exchange request, applying its changes on the associated order. - DELETECancel Exchange Request
/admin/exchanges/:id/requestCancel a requested exchange.
Feature Flags
- GETList Feature Flags
/admin/feature-flagsRetrieve 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.
Fulfillment Providers
- GETList Fulfillment Providers
/admin/fulfillment-providers?fields=string&offset=0.0&limit=0.0&order=string&id=string&is_enabled=true&q=string&stock_location_id=string&with_deleted=trueRetrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as id. The fulfillment providers can also be sorted or… - GETList Fulfillment Options
/admin/fulfillment-providers/:id/optionsRetrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.
Fulfillment Sets
- DELETEDelete Fulfillment Set
/admin/fulfillment-sets/:idDelete a fulfillment set. - POSTAdd a Service Zone to a Fulfillment Set
/admin/fulfillment-sets/:id/service-zones?fields=stringAdd a service zone to a fulfillment set. - GETGet a Service Zone in a Fulfillment Set
/admin/fulfillment-sets/:id/service-zones/:zone_id?fields=stringRetrieve a service zone that belongs to a fulfillment set. be paginated. - POSTUpdate the Service Zone of a Fulfillment Set
/admin/fulfillment-sets/:id/service-zones/:zone_id?fields=stringUpdate the details of a service zone in a fulfillment set. - DELETERemove a Service Zone from Fulfillment Set
/admin/fulfillment-sets/:id/service-zones/:zone_idRemove a service zone that belongs to a fulfillment set.
Fulfillments
- POSTCreate Fulfillment
/admin/fulfillments?fields=stringCreate a fulfillment for an order, return, exchange, and more. - POSTCancel a Fulfillment
/admin/fulfillments/:id/cancel?fields=stringCancel a fulfillment. The fulfillment can't be shipped or delivered. To cancel the fulfillment, the cancelFulfillment method of the associated fulfillment… - POSTCreate a Shipment for a Fulfillment
/admin/fulfillments/:id/shipment?fields=stringCreate a shipment for a fulfillment. The fulfillment must not be shipped or canceled.
Gift Cards
- GETList Gift Cards
/admin/gift-cards?id=string&customer_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&fields=string&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Gift Card
/admin/gift-cardsCreate a gift card. - GETGet a Gift Card
/admin/gift-cards/:idRetrieve a gift card by its ID. You can expand the gift card's relations or select the fields that should be returned. - POSTUpdate a Gift Card
/admin/gift-cards/:idUpdate a gift card's details. - GETList Gift Card's Orders
/admin/gift-cards/:id/ordersRetrieve the list of orders that a gift card was used in.
Index
- GETGet Index Details
/admin/index/detailsDeprecated. Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp. - POSTTrigger Index Sync
/admin/index/syncDeprecated. Trigger reindexing or re-ingestion of the Index Module.
Inventory Items
- GETList Inventory Items
/admin/inventory-items?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&sku=string&origin_country=string&mid_code=string&hs_code=string&material=string&requires_shipping=true&weight={"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$like":"string","$ilike":"string","$re":"string","$contains":["string"],"$gt":"string","$gte":"string","$lt":"string","$lte":"string"}&length={"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$like":"string","$ilike":"string","$re":"string","$contains":["string"],"$gt":"string","$gte":"string","$lt":"string","$lte":"string"}&height={"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$like":"string","$ilike":"string","$re":"string","$contains":["string"],"$gt":"string","$gte":"string","$lt":"string","$lte":"string"}&width={"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$like":"string","$ilike":"string","$re":"string","$contains":["string"],"$gt":"string","$gte":"string","$lt":"string","$lte":"string"}&location_levels={"location_id":"string"}&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Inventory Item
/admin/inventory-items?fields=stringCreate an inventory item. - POSTExport Inventory Items
/admin/inventory-items/export?id=string&q=string&sku=string&origin_country=string&mid_code=string&hs_code=string&material=string&requires_shipping=true&weight=0.0&length=0.0&height=0.0&width=0.0&location_levels={"location_id":"string"}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}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… - POSTManage Inventory Levels
/admin/inventory-items/location-levels/batchManage inventory levels to create, update, or delete them. - GETGet a Inventory Item
/admin/inventory-items/:id?fields=stringRetrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned. - POSTUpdate an Inventory Item
/admin/inventory-items/:id?fields=stringUpdate an inventory item's details. - DELETEDelete Inventory Item
/admin/inventory-items/:idDelete an inventory item. - GETList Inventory Levels
/admin/inventory-items/:id/location-levels?fields=string&offset=0.0&limit=0.0&order=string&with_deleted=true&location_id=stringRetrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like location_id. The inventory levels… - POSTCreate Inventory Level for Inventory Item
/admin/inventory-items/:id/location-levels?fields=stringCreate an inventory level for an inventory item. - POSTManage Inventory Levels of Inventory Item
/admin/inventory-items/:id/location-levels/batchManage the inventory levels of an inventory item to create or delete them. - POSTUpdate an Inventory Level of an Inventory Item
/admin/inventory-items/:id/location-levels/:location_id?fields=stringUpdates the details of an inventory item's inventory level using its associated location ID. - DELETERemove Inventory Level of Inventory Item
/admin/inventory-items/:id/location-levels/:location_id?fields=stringRemove the inventory level of an inventory item. If the inventory level has reserved quantity greater than 0, an error is thrown.
Invites
- GETList Invites
/admin/invites?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&email=user@example.com&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve a list of invites. The invites can be filtered by fields such as id. The invites can also be sorted or paginated. - POSTCreate Invite
/admin/invites?fields=stringCreate a invite. - POSTAccept Invite
/admin/invites/accept?token=string&fields=stringAccept 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… - GETGet an Invite
/admin/invites/:id?fields=stringRetrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. - DELETEDelete Invite
/admin/invites/:idDelete an invite. - POSTRefresh Invite Token
/admin/invites/:id/resend?fields=stringRefresh the token of an invite.
Layouts
- GETList Layout Configurations
/admin/layouts/configurations?id=string&zone=string&user_id=string&is_system_default=true&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}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. - GETList Layout Configurations
/admin/layouts/:zone/configurationRetrieve a list of layout configurations for a specific zone. These are the configurations made by the users for their admin dashboard layouts. - POSTAdd Layout Configuration
/admin/layouts/:zone/configurationAdd 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… - DELETEClear Configuration of Layout
/admin/layouts/:zone/configurationClears all user layout configurations for a given zone. This action will remove any customizations made by the user and revert to the system defaults.
Locales
- GETList Locales
/admin/locales?q=string&code=string&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}Retrieve a list of locales. The locales can be filtered by fields such as code. The locales can also be sorted or paginated. - GETGet a Locale
/admin/locales/:code?fields=stringRetrieve a locale by its code. You can expand the locale's relations or select the fields that should be returned.
Modules
- GETList Modules
/admin/modulesRetrieve the modules installed in the Medusa application. You can use this API route to check whether a module, such as the RBAC Module, is installed.
Multi-Factor Authentication
- POSTVerify a Multi-Factor Authentication (MFA) Challenge
/auth/mfa/challenges/:id/verifyVerify a multi-factor authentication (MFA) challenge issued during login. On success, this completes the authentication flow and returns a JWT token that can… - GETList Multifactor Authentication (MFA) Factors
/auth/mfa/factorsRetrieve the list of multi-factor authentication (MFA) factors registered for the authenticated user, including both pending (not yet verified) and enabled… - POSTStart Multi-Factor Authentication (MFA) Factor Enrollment
/auth/mfa/factorsStart the enrollment of a new multi-factor authentication (MFA) factor for the authenticated user. The response contains the factor along with… - POSTVerify and Enable a Multi-Factor Authentication (MFA) Factor
/auth/mfa/factors/:id/verifyVerify a pending multi-factor authentication (MFA) factor by submitting a code generated from it. A successful verification enables the factor, after which it… - POSTGenerate Multi-Factor Authentication (MFA) Recovery Codes
/auth/mfa/recovery-codesGenerate a new set of single-use recovery codes for the authenticated user. Recovery codes can be used to verify MFA challenges when the user does not have…
Notifications
- GETList Notifications
/admin/notifications?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&channel=email&$and={}&$or={}&with_deleted=true&to=stringRetrieve a list of notifications. The notifications can be filtered by fields such as id. The notifications can also be sorted or paginated. - GETGet a Notification
/admin/notifications/:id?fields=stringRetrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned.
Order Changes
- POSTUpdate an Order Change
/admin/order-changes/:id?created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&id=string&status=string&change_type=string&$and={}&$or={}&fields=stringUpdate 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 Edits
- POSTCreate Order Edit
/admin/order-editsCreate an order edit. - DELETECancel Order Edit
/admin/order-edits/:idCancel a requested order edit. - POSTConfirm Order Edit
/admin/order-edits/:id/confirmConfirm an order edit request and apply the changes on the order. - POSTAdd Items to Order Edit
/admin/order-edits/:id/itemsAdd new items to an order edit. These items will have the action ITEM_ADD. - POSTUpdate Order Item Quantity of Order Edit
/admin/order-edits/:id/items/item/:item_idUpdate 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. - POSTUpdate an Item in an Order Edit
/admin/order-edits/:id/items/:action_idUpdate 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… - DELETERemove Item from Order Edit
/admin/order-edits/:id/items/:action_idRemove 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… - POSTRequest Order Edit
/admin/order-edits/:id/requestChange the status of an active order edit to requested. - POSTAdd Shipping Method to Order Edit
/admin/order-edits/:id/shipping-methodAdd a shipping method to an exchange. The shipping method will have a SHIPPING_ADD action. - POSTUpdate Shipping Method of an Order Edit
/admin/order-edits/:id/shipping-method/:action_idUpdate 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… - DELETERemove Shipping Method from Order Edit
/admin/order-edits/:id/shipping-method/:action_idRemove 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…
Orders
- GETList Orders
/admin/orders?fields=string&offset=0.0&limit=0.0&order=string&id=string&status=string&$and={}&$or={}&sales_channel_id=string®ion_id=string&q=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&customer_id=string&with_deleted=trueRetrieve a list of orders. The orders can be filtered by fields such as id. The orders can also be sorted or paginated. - POSTExport Orders
/admin/orders/export?id=string&sales_channel_id=string®ion_id=string&customer_id=string&q=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&status=canceled&$and={}&$or={}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.… - GETGet an Order
/admin/orders/:id?fields=string&version=0.0Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. - POSTUpdate Order
/admin/orders/:id?version=0.0&fields=stringUpdate 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… - POSTArchive an Order
/admin/orders/:id/archive?fields=string&version=0.0Change the status of an order to archived. - POSTCancel Order
/admin/orders/:id/cancel?fields=string&version=0.0Cancel an order. The cancelation fails if: The order has captured payments. The order has refund payments. The order has fulfillments that aren't canceled. - GETList Changes on an Order
/admin/orders/:id/changes?fields=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&id=string&status=string&change_type=string&$and={}&$or={}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… - POSTComplete Order
/admin/orders/:id/complete?fields=string&version=0.0Mark an order as completed. - POSTCreate Credit Line for Order
/admin/orders/:id/credit-lines?fields=string&version=0.0Create a credit line for an order. - POSTCreate an Order Fulfillment
/admin/orders/:id/fulfillments?fields=string&version=0.0Create a fulfillment for an order. The creation fails if the order is canceled. - POSTCancel Fulfillment
/admin/orders/:id/fulfillments/:fulfillment_id/cancelCancel an order's fulfillment. The fulfillment can't be canceled if it's shipped. - POSTMark a Fulfillment as Delivered.
/admin/orders/:id/fulfillments/:fulfillment_id/mark-as-delivered?fields=string&version=0.0Mark an order's fulfillment as delivered. - POSTCreate Shipment for an Order's Fulfillment
/admin/orders/:id/fulfillments/:fulfillment_id/shipments?fields=string&version=0.0Create a shipment for an order's fulfillment. - GETList Line Items
/admin/orders/:id/line-items?fields=string&id=string&item_id=string&version=0.0Retrieve 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. - POSTAuthorize Payment Session
/admin/orders/:id/payment-sessions/authorizeAuthorize a payment session for an order. This is useful for orders created from draft orders. - GETGet Preview
/admin/orders/:id/previewRetrieve a preview of an order using its associated change, such as an edit. - GETList Shipping Options for Order
/admin/orders/:id/shipping-optionsRetrieve 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… - POSTRequest Order Transfer
/admin/orders/:id/transfer?fields=string&version=0.0Request an order to be transfered to another customer. The transfer is confirmed by sending a request to the Accept Order Transfer Store API route. - POSTCancel Transfer Request
/admin/orders/:id/transfer/cancel?fields=string&version=0.0Cancel a request to transfer an order to another customer. - POSTTransfer Order to Guest Customer
/admin/orders/:id/transfer/guest?version=0.0&fields=stringTransfer 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…
Payment Collections
- POSTCreate Payment Collection
/admin/payment-collections?fields=stringCreate a payment collection. - DELETEDelete a Payment Collection
/admin/payment-collections/:idDelete a payment collection. - POSTMark a Payment Collection as Paid
/admin/payment-collections/:id/mark-as-paid?fields=stringMark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider. - POSTInitialize Payment Session in Payment Collection
/admin/payment-collections/:id/payment-sessions?fields=stringInitialize 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…
Payments
- GETList Payments
/admin/payments?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&payment_session_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve a list of payments. The payments can be filtered by fields such as id. The payments can also be sorted or paginated. - GETList Payment Providers
/admin/payments/payment-providers?fields=string&offset=0.0&limit=0.0&order=string&id=string&is_enabled=true&$and={}&$or={}&with_deleted=trueRetrieve 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. - GETGet a Payment
/admin/payments/:id?fields=stringRetrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned. - POSTCapture Payment
/admin/payments/:id/capture?fields=stringCapture an amount of a payment. This uses the capturePayment method of the payment provider associated with the payment's collection. - POSTRefund Payment
/admin/payments/:id/refund?fields=stringRefund an amount of a payment. This uses the refundPayment method of the payment provider associated with the payment's collection.
Plugins
- GETList Plugins
/admin/pluginsRetrieve the list of plugins installed in the Medusa application.
Price Lists
- GETList Price Lists
/admin/price-lists?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&starts_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&ends_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&status=active&rules_count=0.0&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Price List
/admin/price-lists?fields=string&q=string&id=string&starts_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&ends_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&status=draft&rules_count=0.0&limit=0.0&offset=0.0&order=string&with_deleted=true&$and={}&$or={}Create a price list. - GETGet a Price List
/admin/price-lists/:id?fields=stringRetrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned. - POSTUpdate a Price List
/admin/price-lists/:id?fields=stringUpdate a price list's details. - DELETEDelete a Price List
/admin/price-lists/:idDelete a price list. - GETList Prices for a Price List
/admin/price-lists/:id/prices?fields=stringRetrieve a list of prices in a price list. The prices can be filtered by fields like FILTER FIELDS. The prices can also be paginated. - POSTManage Prices in Price List
/admin/price-lists/:id/prices/batch?fields=stringManage the prices of a price list to create, update, or delete them. - POSTRemove Products from Price List
/admin/price-lists/:id/products?fields=stringRemove products from a price list.
Price Preferences
- GETList Price Preferences
/admin/price-preferences?fields=string&offset=0.0&limit=0.0&order=string&id=string&attribute=string&value=string&q=string&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Price Preference
/admin/price-preferences?fields=stringCreate a price preference. - GETGet a Price Preference
/admin/price-preferences/:id?fields=stringRetrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned. - POSTUpdate a Price Preference
/admin/price-preferences/:id?fields=stringUpdate a price preference's details. - DELETEDelete a Price Preference
/admin/price-preferences/:idDelete a price preference.
Product Categories
- GETList Product Categories
/admin/product-categories?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&description=string&handle=string&parent_category_id=string&include_ancestors_tree=true&include_descendants_tree=true&is_internal=true&is_active=true&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&external_id=stringRetrieve 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. - POSTCreate Product Category
/admin/product-categories?fields=string&include_ancestors_tree=true&include_descendants_tree=trueCreate a product category. - GETGet a Product Category
/admin/product-categories/:id?fields=string&include_ancestors_tree=true&include_descendants_tree=true&is_internal=true&is_active=true&q=string&id=string&description=string&parent_category_id=string&handle=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&$and={}&$or={}&external_id=stringRetrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. - POSTUpdate a Product Category
/admin/product-categories/:id?fields=string&include_ancestors_tree=true&include_descendants_tree=trueUpdate a product category's details. - DELETEDelete a Product Category
/admin/product-categories/:idDelete 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… - POSTManage Products in Product Category
/admin/product-categories/:id/products?fields=string&include_ancestors_tree=true&include_descendants_tree=trueManage products of a category to add or remove them.
Product Options
- GETList Product Options
/admin/product-options?title=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&order=string&q=string&is_exclusive=true&limit=0.0&offset=0.0&with_deleted=true&fields=string&$and={}&$or={}&id=stringRetrieve 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. - POSTCreate Product Option
/admin/product-optionsCreate a product option. - GETGet a Product Option
/admin/product-options/:id?fields=stringRetrieve a product option by its ID. You can expand the product option's relations or select the fields that should be returned. - POSTUpdate a Product Option
/admin/product-options/:idUpdate a product option's details. - DELETEDelete a Product Option
/admin/product-options/:idDelete a product option. - GETList Product Option Values
/admin/product-options/:id/values?q=string&id=string&value=string&option_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}Retrieve a list of values in a product option. The values can be filtered by fields like id. The values can also be paginated. - GETGet Product Option Value
/admin/product-options/:id/values/:value_id?fields=stringGet a product option value by its ID. - POSTUpdate Product Option Value
/admin/product-options/:id/values/:value_idUpdate a product option value's details. - DELETERemove Value from Product Option
/admin/product-options/:id/values/:value_idRemove a Value from a product option.
Product Tags
- GETList Product Tags
/admin/product-tags?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&value=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&external_id=stringRetrieve 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. - POSTCreate Product Tag
/admin/product-tags?fields=stringCreate a product tag. - GETGet a Product Tag
/admin/product-tags/:id?fields=stringRetrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned. - POSTUpdate a Product Tag
/admin/product-tags/:id?fields=stringUpdate a product tag's details. - DELETEDelete a Product Tag
/admin/product-tags/:idDelete a product tag. This doesn't delete products using the tag.
Product Types
- GETList Product Types
/admin/product-types?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&value=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&external_id=stringRetrieve 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. - POSTCreate Product Type
/admin/product-types?fields=stringCreate a product type. - GETGet a Product Type
/admin/product-types/:id?fields=stringRetrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned. - POSTUpdate a Product Type
/admin/product-types/:id?fields=stringUpdate a product type's details. - DELETEDelete a Product Type
/admin/product-types/:idDelete a product type. This doesn't delete products of this type.
Product Variants
- GETList Product Variants
/admin/product-variants?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&manage_inventory=true&allow_backorder=true&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&ean=string&upc=string&barcode=string&sku=stringRetrieve 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.
Products
- GETList Products
/admin/products?fields=string&offset=0.0&limit=0.0&order=string&price_list_id=string&q=string&status=draft&sales_channel_id=string&title=string&handle=string&id=string&is_giftcard=true&type_id=string&category_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&collection_id=string&variants={"id":"string","manage_inventory":true,"allow_backorder":true,"created_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"updated_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"deleted_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"limit":0.0,"offset":0.0,"order":"string","fields":"string","$and":[{}],"$or":[{}],"ean":"string","upc":"string","barcode":"string","with_deleted":true,"sku":"string"}&with_deleted=true&external_id=string&tag_id=string&option_id=string&option_value_id=stringRetrieve a list of products. The products can be filtered by fields such as id. The products can also be sorted or paginated. - POSTCreate Product
/admin/products?fields=stringCreate a product. - POSTManage Products
/admin/products/batch?fields=stringManage products to create, update, or delete them. - POSTExport Products
/admin/products/export?fields=string&tags={"id":["string"]}&variants={"options":{"value":"string","option_id":"string","option":{}},"sku":"string","ean":"string","upc":"string","barcode":"string"}&title=string&status=draft&id=string&sales_channel_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&handle=string&is_giftcard=true&collection_id=string&type_id=string&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&order=string&q=string&category_id=string&limit=0.0&offset=0.0&with_deleted=true&$and={}&$or={}&price_list_id=string&external_id=string&tag_id=string&option_id=string&option_value_id=stringStart 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… - POSTCreate Product Import
/admin/products/importDeprecated. Create a new product import process. The products aren't imported until the import is confirmed with the /admin/products/:transaction-id/import… - POSTConfirm Product Import
/admin/products/import/:transaction_id/confirmDeprecated. Confirm that a created product import should start importing the products into Medusa. - POSTCreate Product Import
/admin/products/importsCreate a new product import process. The products aren't imported until the import is confirmed with the /admin/products/:transaction-id/imports API route. - POSTConfirm Product Import
/admin/products/imports/:transaction_id/confirmConfirm that a created product import should start importing the products into Medusa. - GETGet a Product
/admin/products/:id?fields=stringRetrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. - POSTUpdate a Product
/admin/products/:id?fields=stringUpdate a product's details. If you pass variants in the request body, they replace the product's full variant list, and existing variants that aren't included… - DELETEDelete a Product
/admin/products/:idDelete a product. - POSTManage Variants of Product Image
/admin/products/:id/images/:image_id/variants/batchManage the association between product variants and a product image. You can add or remove associations between variants and the image. - GETList a Product's Options
/admin/products/:id/options?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&title=string&$and={}&$or={}&with_deleted=true&is_exclusive=trueRetrieve a list of options of a product. The options can be filtered by fields like id. The options can also be paginated. - POSTAdd Options to Product
/admin/products/:id/options/batchAdd a list of options to a product. - GETList Variants of a Product
/admin/products/:id/variants?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&manage_inventory=true&allow_backorder=true&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&ean=string&upc=string&barcode=string&sku=stringRetrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. - POSTCreate a Product Variant
/admin/products/:id/variants?fields=stringCreate a variant for a product. - POSTManage Variants in a Product
/admin/products/:id/variants/batch?fields=stringManage variants in a product to create, update, or delete them. - POSTManage Variants Inventory in a Product
/admin/products/:id/variants/inventory-items/batchManage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items. - GETGet Variant of a Product
/admin/products/:id/variants/:variant_id?fields=stringRetrieve a product's variant by its ID. - POSTUpdate a Product Variant
/admin/products/:id/variants/:variant_id?fields=stringUpdate a variant's details. - DELETEDelete Product Variant
/admin/products/:id/variants/:variant_id?fields=stringDelete a variant of a product. - POSTManage Images of Product Variant
/admin/products/:id/variants/:variant_id/images/batchManage the association between product images and a product variant. You can add or remove associations between images and the variant. - POSTAssociate Variant with Inventory Item
/admin/products/:id/variants/:variant_id/inventory-items?fields=stringAssociate with a product variant an inventory item that manages its inventory details. - POSTUpdate Product Variant's Inventory Details
/admin/products/:id/variants/:variant_id/inventory-items/:inventory_item_id?fields=stringUpdate the inventory item that manages the inventory details of a product variant. - DELETERemove Inventory Item Association with Product Variant
/admin/products/:id/variants/:variant_id/inventory-items/:inventory_item_id?fields=stringRemove the association between an inventory item and its product variant.
Promotions
- GETList Promotions
/admin/promotions?fields=string&offset=0.0&limit=0.0&order=string&q=string&code=string&campaign_id=string&application_method={"currency_code":"string"}&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true&id=stringRetrieve a list of promotions. The promotions can be filtered by fields such as id. The promotions can also be sorted or paginated. - POSTCreate Promotion
/admin/promotions?fields=stringCreate a promotion. - GETList Rule Attribute Options of a Rule Type
/admin/promotions/rule-attribute-options/:rule_type?promotion_type=standard&application_method_type=fixed&application_method_target_type=itemsRetrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule… - GETList Rule Values Given a Rule Attribute
/admin/promotions/rule-value-options/:rule_type/:rule_attribute_id?offset=0.0&limit=0.0&order=string&with_deleted=true&application_method_target_type=string&q=string&value=string&fields=stringRetrieve 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… - GETGet a Promotion
/admin/promotions/:id?fields=stringRetrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned. - POSTUpdate a Promotion
/admin/promotions/:id?fields=stringUpdate a promotion's details. - DELETEDelete a Promotion
/admin/promotions/:idDelete a promotion. - POSTManage the Buy Rules of a Promotion
/admin/promotions/:id/buy-rules/batch?promotion_type=standard&application_method_type=fixed&application_method_target_type=itemsManage the buy rules of a buyget promotion to create, update, or delete them. - POSTManage a Promotion's Rules
/admin/promotions/:id/rules/batch?promotion_type=standard&application_method_type=fixed&application_method_target_type=itemsManage the rules of a promotion to create, update, or delete them. - POSTManage Target Rules of a Promotion
/admin/promotions/:id/target-rules/batch?promotion_type=standard&application_method_type=fixed&application_method_target_type=itemsManage the target rules of a promotion to create, update, or delete them. - GETList Rules of a Promotion
/admin/promotions/:id/:rule_type?fields=string&promotion_type=standard&application_method_type=fixed&application_method_target_type=itemsRetrieve 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…
Property Labels
- GETList Property Labels
/admin/property-labels?entity=string&property=string&q=string&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=stringRetrieve 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. - POSTCreate Property Label
/admin/property-labelsCreate a property label. - POSTCreate Property Label
/admin/property-labels/batchCreate a property label. - GETGet a Property Label
/admin/property-labels/:idRetrieve a property label by its ID. - POSTUpdate a Property Label
/admin/property-labels/:idUpdate a property label's details. - DELETEDelete a Property Label
/admin/property-labels/:idDelete a property label.
Refund Reasons
- GETList Refund Reasons
/admin/refund-reasons?fields=string&offset=0.0&limit=0.0&order=string&id=string&q=string&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Refund Reason
/admin/refund-reasons?fields=stringCreate a refund reason. - GETGet a Refund Reason
/admin/refund-reasons/:id?fields=stringRetrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned. - POSTUpdate a Refund Reason
/admin/refund-reasons/:id?fields=stringUpdate a refund reason's details. - DELETEDelete a Refund Reason
/admin/refund-reasons/:idDelete a refund reason.
Regions
- GETList Regions
/admin/regions?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&name=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}¤cy_code=string&with_deleted=trueRetrieve a list of regions. The regions can be filtered by fields such as id. The regions can also be sorted or paginated. - POSTCreate Region
/admin/regions?fields=stringCreate a region. - GETGet a Region
/admin/regions/:id?fields=stringRetrieve a region by its ID. You can expand the region's relations or select the fields that should be returned. - POSTUpdate a Region
/admin/regions/:id?fields=stringUpdate a region's details. - DELETEDelete a Region
/admin/regions/:idDelete a region.
Reservations
- GETList Reservations
/admin/reservations?fields=string&offset=0.0&limit=0.0&order=string&location_id=string&inventory_item_id=string&line_item_id=string&created_by=string&description=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&with_deleted=true&q=string&quantity={"$and":[{}],"$or":[{}],"$eq":"string","$ne":0.0,"$in":[0.0],"$nin":[0.0],"$not":"string","$gt":0.0,"$gte":0.0,"$lt":0.0,"$lte":0.0,"$like":0.0,"$re":0.0,"$ilike":0.0,"$fulltext":0.0,"$overlap":[0.0],"$contains":[0.0],"$contained":[0.0],"$exists":true}Retrieve a list of reservations. The reservations can be filtered by fields such as id. The reservations can also be sorted or paginated. - POSTCreate Reservation
/admin/reservations?fields=stringCreate a reservation. - GETGet a Reservation
/admin/reservations/:id?fields=stringRetrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned. - POSTUpdate a Reservation
/admin/reservations/:id?fields=stringUpdate a reservation's details. - DELETEDelete a Reservation
/admin/reservations/:idDelete a reservation.
Return Reasons
- GETList Return Reasons
/admin/return-reasons?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&value=string&label=string&description=string&parent_return_reason_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=trueRetrieve 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. - POSTCreate Return Reason
/admin/return-reasons?fields=stringCreate a return reason. - GETGet a Return Reason
/admin/return-reasons/:id?fields=stringRetrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
http://localhost:9000https://api.medusajs.com- Authentication
- HTTP Basic authentication (username and password)
A bearer token in the Authorization header
An API key in the connect.sid cookie
A bearer token in the Authorization header - Operations
- 420 operations on 277 pathsPOST 217GET 132DELETE 71
4 marked deprecated - Main resources
- Products 25Returns 22Claims 21Draft Orders 21Orders 20Exchanges 18Customers 12Inventory Items 12Users 12Order Edits 11
- Response formats
application/jsontext/plaintext/event-stream- Description format
- OpenAPI 3.0.0, API version
2.22.7 - Links
- OpenAPI document
- Listed from
- Medusa (Admin API)'s published OpenAPI description (medusajs/medusa) (MIT)
How to test the Medusa Admin API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Medusa Admin API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List API Keys” (GET /admin/api-keys?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&title=string&token=string&type=secret&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&revoked_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&with_deleted=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Medusa Admin API?
Medusa Admin API endpoints from Medusa It is listed under E-commerce and has 420 endpoints.
Who publishes the Medusa Admin API?
It is listed from Medusa's public API description (an OpenAPI document), not published by Medusa on Swastik Codes. Anyone who controls medusajs.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Medusa Admin API?
Its description lists 2 base URLs: http://localhost:9000, https://api.medusajs.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Medusa Admin API?
It accepts 4 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header; an API key in the connect.sid cookie; A bearer token in the Authorization header.
How many endpoints does the Medusa Admin API have?
420 operations on 277 paths (217 POST, 132 GET, 71 DELETE). The largest groups are Products, Returns, Claims, Draft Orders. This listing's collection holds the first 400.
Is forking the Medusa Admin API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.