List Price Lists

GET

/admin/price-lists

Price Lists

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

Response Example

200 - Example 1

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "price_lists": [
    {
      "id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
      "name": "VIP Prices",
      "description": "Prices for VIP customers",
      "starts_at": "2019-08-24T14:15:22Z",
      "ends_at": "2019-08-24T14:15:22Z",
      "includes_tax": false,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "type": "sale",
      "status": "draft",
      "customer_groups": [
        {
          "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
          "name": "VIP",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "customers": [
            {}
          ],
          "price_lists": [
            {}
          ],
          "metadata": {
            "car": "white"
          }
        }
      ],
      "prices": [
        {
          "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
          "amount": 100,
          "min_quantity": 1,
          "max_quantity": 1,
          "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
          "price_list": {},
          "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
          "variant": {},
          "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
          "region": {},
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "currency_code": "usd",
          "currency": {
            "symbol": "$",
            "symbol_native": "$",
            "name": "US Dollar",
            "includes_tax": false,
            "code": "usd"
          }
        }
      ]
    }
  ]
}

Request

Query Params

limit

number

optional

Limit the number of price lists returned.

offset

number

optional

The number of price lists to skip when retrieving the price lists.

expand

string

optional

Comma-separated relations that should be expanded in the returned price lists.

fields

string

optional

Comma-separated fields that should be included in the returned price lists.

order

string

optional

A price-list field to sort-order the retrieved price lists by.

string

optional

Filter by ID

string

optional

term to search price lists' description, name, and customer group's name.

status

array[string]

optional

Filter by status.

name

string

optional

Filter by name

customer_groups

array[string]

optional

Filter by customer-group IDs.

type

array[string]

optional

Filter by type.

array[string]

optional

filter by dates less than this date

Example:

["","",""]

array[string]

optional

filter by dates greater than this date

Example:

["","",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["","",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["","",""]

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of price lists skipped when retrieving the price lists.

limit

integer

required

The number of items per page

price_lists

array[object (Price List) {13}]

required

An array of price lists details.

string

required

The price list's ID

Example:

pl_01G8X3CKJXCG5VXVZ87H9KC09W

name

string

required

The price list's name

Example:

VIP Prices

description

string

required

The price list's description

Example:

Prices for VIP customers

starts_at

string <date-time> | null

required

The date with timezone that the Price List starts being valid.

ends_at

string <date-time> | null

required

The date with timezone that the Price List stops being valid.

includes_tax

boolean

optional

Whether the price list prices include tax

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

type

enum<string>

required

The type of Price List. This can be one of either sale or override.

Allowed values:

saleoverride

Default:

sale

status

enum<string>

required

The status of the Price List

Allowed values:

activedraft

Default:

draft

customer_groups

array[object (Customer Group) {8}]

optional

The details of the customer groups that the Price List can apply to.

prices

array[object (Money Amount) {15}]

optional

The prices that belong to the price list, represented as a Money Amount.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-10 11:56:36

Create a Price List

List Product Types