Skip to main content
GET
/
admin
/
promotions
/
{id}
/
{rule_type}
JS SDK
import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.promotion.listRules("promo_123", "rules")
.then(({ rules }) => {
  console.log(rules)
})
{
  "rules": [
    {
      "id": "<string>",
      "values": [
        "cusgroup_123"
      ],
      "description": "<string>",
      "attribute": "customer_group_id",
      "operator": "gt"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The promotion's ID.

​
rule_type
enum<string>
required

The type of rules to retrieve.

Available options:
rules,
target-rules,
buy-rules

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
promotion_type
enum<string>

The type The promotion's type.

Available options:
standard,
buyget
​
application_method_type
enum<string>

The promotion's application method type.

Available options:
fixed,
percentage
​
application_method_target_type
enum<string>

The promotion's application method target type.

Available options:
items,
shipping_methods,
order

Response

OK

The list of promotion rules.

​
rules
object[]
required

The list of promotion rules.