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.priceList.create({
title: "My Price List",
status: "active",
type: "sale",
prices: [
{
variant_id: "variant_123",
amount: 10,
currency_code: "usd",
rules: {
region_id: "reg_123"
}
}
]
})
.then(({ price_list }) => {
console.log(price_list)
}){
"price_list": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"rules": {},
"starts_at": "<string>",
"ends_at": "<string>",
"status": "draft",
"type": "sale",
"prices": [
{
"variant_id": "<string>",
"rules": {},
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}Create Price List
Create a price list.
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.priceList.create({
title: "My Price List",
status: "active",
type: "sale",
prices: [
{
variant_id: "variant_123",
amount: 10,
currency_code: "usd",
rules: {
region_id: "reg_123"
}
}
]
})
.then(({ price_list }) => {
console.log(price_list)
}){
"price_list": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"rules": {},
"starts_at": "<string>",
"ends_at": "<string>",
"status": "draft",
"type": "sale",
"prices": [
{
"variant_id": "<string>",
"rules": {},
"id": "<string>",
"title": "<string>",
"currency_code": "usd",
"amount": 123,
"raw_amount": {},
"min_quantity": 123,
"max_quantity": 123,
"price_set_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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.
Apply a search query to the price list's searchable properties.
Filter by a specific price list ID.
Filter by a price list's start date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by a price list's end date.
Show child attributes
Show child attributes
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Filter by an exact match.
Filter by values not equal to this parameter.
Filter by values in this array.
Filter by values in this array.
Filter by values not in this array.
Filter by values not in this array.
Filter by values not matching the conditions in this parameter.
Filter by values greater than this parameter. Useful for numbers and dates only.
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Filter by values less than this parameter. Useful for numbers and dates only.
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Apply a like filter. Useful for strings only.
Apply a regex filter. Useful for strings only.
Apply a case-insensitive like filter. Useful for strings only.
Filter to apply on full-text properties.
Filter arrays that have overlapping values with this parameter.
Filter arrays that have overlapping values with this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain some of the values of this parameter.
Filter arrays that contain all values of this parameter.
Filter arrays that contain all values of this parameter.
Filter by whether a value for this parameter exists (not null).
Filter by price list statuses.
A price list status.
draft, active Filter by multiple price list rules count. Filter by price list rules count.
A price list's rules count.
Limit the number of items returned in the list.
The number of items to skip when retrieving a 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 -.
The price list's with deleted.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Body
The price list's details.
The price list's title.
The price list's description.
The date and time the price list starts at.
The date and time the price list ends at.
The price list's status.
active, draft The price list's type.
sale, override The price list's rules.
{ "product_category_id": "pcat_123" }The price list's prices.
Show child attributes
Show child attributes
The price's currency code.
The price's amount.
The ID of the product variant this price is for.
The minimum quantity required in the cart for this price to be applied.
The maximum quantity in the cart that shouldn't be crossed for this price to be applied.
The price's rules.
{ "region_id": "reg_123" }Response
OK
The price list's details.
The price list's details.
Show child attributes
Show child attributes
The price list's ID.
The price list's title.
The price list's description.
The price list's rules.
The date the price list starts.
The date the price list ends.
The price list's status.
draft, active The price list's type.
sale, override The price list's prices.
Show child attributes
Show child attributes
The ID of the product variant this price list is for.
The price's rules.
The price's ID.
The price's title.
The price's currency code.
"usd"
The price's amount.
The price's raw amount.
The minimum quantity that must be available in the cart for the price to be applied.
The maximum quantity allowed to be available in the cart for the price to be applied.
The ID of the price set this price belongs to.
The date the price was created.
The date the price was updated.
The date the price was deleted.
The date the price list was created.
The date the price list was updated.
The date the price list was deleted.