Skip to main content
POST
/
vendor
/
price-lists
/
{id}
/
prices
Create price list
curl --request POST \
  --url https://api.example.com/vendor/price-lists/{id}/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variant_id": "<string>",
  "rules": {},
  "currency_code": "usd",
  "amount": 123,
  "min_quantity": 123,
  "max_quantity": 123
}
'
{
  "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

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the price list.

Query Parameters

​
fields
string

Comma-separated fields to include in the response.

Body

application/json
​
variant_id
string

The ID of the product variant this price list is for.

​
rules
object

The price's rules.

​
currency_code
string

The price's currency code.

Example:

"usd"

​
amount
number

The price's amount.

​
min_quantity
number

The minimum quantity that must be available in the cart for the price to be applied.

​
max_quantity
number

The maximum quantity allowed to be available in the cart for the price to be applied.

Response

201 - application/json

OK

​
price_list
object

The price list's details.