Skip to main content
POST
/
admin
/
price-preferences
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.pricePreference.create({
  attribute: "region_id",
  value: "region_123",
  is_tax_inclusive: true
})
.then(({ price_preference }) => {
  console.log(price_preference)
})
{
  "price_preference": {
    "id": "<string>",
    "attribute": "region_id",
    "value": "reg_123",
    "is_tax_inclusive": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

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.

Body

application/json

The price preference's details.

​
attribute
string

The name of the attribute the price preference applies on.

Example:

"currency_code"

​
value
string

The attribute's value.

Example:

"usd"

​
is_tax_inclusive
boolean

Whether the price is tax inclusive if the value of the specified attribute matches the specified value.

Response

OK

The price preference's details.

​
price_preference
object
required

The price preference's details.