Skip to main content
POST
/
vendor
/
price-lists
Create price list
curl --request POST \
  --url https://api.example.com/vendor/price-lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "rules": {},
  "starts_at": "<string>",
  "ends_at": "<string>",
  "status": "draft",
  "type": "sale",
  "prices": [
    {
      "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.

Query Parameters

​
fields
string

Comma-separated fields to include in the response.

Body

application/json
​
title
string

The price list's title.

​
description
string

The price list's description.

​
rules
object

The price list's rules.

​
starts_at
string

The date the price list starts.

​
ends_at
string

The date the price list ends.

​
status
enum<string>

The price list's status.

Available options:
draft,
active
​
type
enum<string>

The price list's type.

Available options:
sale,
override
​
prices
object[]

The price list's prices.

Response

201 - application/json

OK

​
price_list
object

The price list's details.