How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Medusa Promotions API

A promotion discounts an amount or percentage off a cart's items, shipping methods, or the entire order.Promotions have different types, such as a `standard` promotion that just discounts an amount, or a `buyget` promotion to enforce a "buy X get Y" promotion.A promotion has rules to restrict how and when they're applied.Promotions belong to a campaign, which sets conditions on the promotion such as when it starts and ends.These API routes allow admin users to manage promotions.

Medusa Promotions API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Promotions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 11 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

11 operations 8 paths 12 schemas 1 DELETE5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 4

Medusa Promotions API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Promotions 11

A promotion discounts an amount or percentage off a cart's items, shipping methods, or the entire order. Promotions have different types, such as a standard promotion that just di…

GET
/admin/promotions
List Promotions
GetPromotions 15 params → 200400401404409422500
POST
/admin/promotions
Create Promotion
PostPromotions 1 param body → 200400401404409422500
GET
/admin/promotions/rule-attribute-options/{rule_type}
List Rule Attribute Options of a Rule Type
GetPromotionsRuleAttributeOptionsRule_type 4 params → 200400401404409422500
GET
/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}
List Rule Values Given a Rule Attribute
GetPromotionsRuleValueOptionsRule_typeRule_attribute_id 10 params → 200400401404409422500
GET
/admin/promotions/{id}
Get a Promotion
GetPromotionsId 2 params → 200400401404409422500
POST
/admin/promotions/{id}
Update a Promotion
PostPromotionsId 2 params body → 200400401404409422500
DELETE
/admin/promotions/{id}
Delete a Promotion
DeletePromotionsId 1 param → 200400401404409422500
POST
/admin/promotions/{id}/buy-rules/batch
Manage the Buy Rules of a Promotion
PostPromotionsIdBuyRulesBatch 4 params body → 200400401404409422500
POST
/admin/promotions/{id}/rules/batch
Manage a Promotion's Rules
PostPromotionsIdRulesBatch 4 params body → 200400401404409422500
POST
/admin/promotions/{id}/target-rules/batch
Manage Target Rules of a Promotion
PostPromotionsIdTargetRulesBatch 4 params body → 200400401404409422500
GET
/admin/promotions/{id}/{rule_type}
List Rules of a Promotion
GetPromotionsIdRule_type 6 params → 200400401404409422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AdminPromotion (15 properties), AdminApplicationMethod (12 properties), AdminCampaign (11 properties), AdminUpdatePromotionRule (5 properties). Each schema is shown below with its type and property counts.

AdminPromotion
object
The promotion's details.
15 properties 4 required
AdminApplicationMethod
object
The application method's details.
12 properties 1 required
AdminPromotionResponse
object
The promotion's details.
1 property 1 required
Error
object
3 properties
AdminUpdatePromotionRule
object
The properties to update in a buy rule.
5 properties 2 required
AdminCampaign
object
The campaign's details.
11 properties 11 required
AdminRuleAttributeOption
object
The details of a potential rule attribute.
4 properties 4 required
BasePromotionRuleValue
object
The rule value's details.
2 properties 1 required
BaseRuleOperatorOptions
object
The operator's details.
3 properties 3 required
AdminCreatePromotionRule
object
The promotion rule's details.
4 properties 3 required
AdminRuleValueOption
object
The details of a potential rule value.
2 properties 2 required
AdminPromotionRule
object
The promotion rule's details.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-promotions-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Promotions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.