Overview
Scanner API
Admin API
- GETList Promotions
- POSTCreate Promotion
- GETList Rule Attribute Options of a Rule Type
- GETList Rule Values Given a Rule Attribute
- GETGet a Promotion
- POSTUpdate a Promotion
- DELDelete a Promotion
- POSTManage the Buy Rules of a Promotion
- POSTManage a Promotion's Rules
- POSTManage Target Rules of a Promotion
- GETList Rules of a Promotion
- GET
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.listRuleValues("rules", "attr_123")
.then(({ values }) => {
console.log(values)
}){
"limit": 123,
"offset": 123,
"count": 123,
"values": [
{
"value": "reg_123",
"label": "Europe Region"
}
]
}List Rule Values Given a Rule Attribute
Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type.
For example, if you provide the ID of the currency_code rule attribute, and set rule_type to rules, a list of currencies are retrieved in label-value pairs.
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.listRuleValues("rules", "attr_123")
.then(({ values }) => {
console.log(values)
}){
"limit": 123,
"offset": 123,
"count": 123,
"values": [
{
"value": "reg_123",
"label": "Europe Region"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The rule type.
rules, target-rules, buy-rules The rule attribute's ID.
Query Parameters
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
Whether to include deleted records in the result.
The application method target type to retrieve rules for.
Apply a search query on the rule values' searchable properties.
Filter by a specific rule value.
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.
Response
OK
The paginated list of rule values.
The maximum number of items returned.
The number of items skipped before retrieving the returned items.
The total number of items.