List Price Lists

GET

/admin/price-lists

Retrieve a list of price lists. The price lists can be filtered by fields such as id. The price lists can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "price_lists": [
        {
            "id": "string",
            "title": "string",
            "description": "string",
            "rules": {},
            "starts_at": "string",
            "ends_at": "string",
            "prices": [
                {
                    "variant_id": "string",
                    "rules": {},
                    "id": "string",
                    "title": "string",
                    "currency_code": "usd",
                    "amount": 0,
                    "raw_amount": {},
                    "min_quantity": 0,
                    "max_quantity": 0,
                    "price_set_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z"
                }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "status": "draft",
            "type": "sale"
        }
    ],
    "estimate_count": 0
}

Request

Authorization

Query Params

fields

string

fields

optional

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.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

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 -.

string

optional

Search term to filter the price list's searchable properties.

optional

One of

array[string]

Filter by a price list ID.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["",""]

$eq

array[string]

optional

Example:

["",""]

$not

array[string]

optional

Example:

["",""]

status

array[string]

optional

Filter by the price list's status.

Allowed values:

activedraft

rules_count

array[number]

optional

Filter by the price list's rules count.

Responses

🟢200OK

application/json

Body

The paginated list of price lists.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

price_lists

array[object (AdminPriceList) {12}]

required

The list of price lists.

string

required

The price list's ID.

title

string

title

required

The price list's title.

description

string

description

required

The price list's description.

rules

object

required

The price list's rules.

starts_at

string

starts_at

required

The date the price list starts.

ends_at

string

ends_at

required

The date the price list ends.

prices

array[object (AdminPriceListPrice) {13}]

required

The price list's prices.

created_at

string <date-time>

created_at

required

The date the price list was created.

updated_at

string <date-time>

updated_at

required

The date the price list was updated.

deleted_at

string <date-time>

deleted_at

required

The date the price list was deleted.

status

enum<string>

required

The price list's status.

Allowed values:

draftactive

type

enum<string>

required

The price list's type.

Allowed values:

saleoverride

estimate_count

number

estimate_count

optional

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create Price List

Get a Store