Price Lists

Part of the Products API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List price lists

GET /admin/api/v1/products/price-lists

Retrieve a paginated list of price lists with filtering and sorting

🔒 Requires a valid Bearer token.

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: currency, company, creator, items	`currency,items`
`filter[id]`	string	No	Comma-separated list of IDs to filter by
`filter[name]`	string	No	Filter by price list name (partial match)
`filter[currency_id]`	string	No	Comma-separated list of currency IDs to filter by
`filter[is_active]`	boolean	No	Filter by active state
`sort`	string	Yes	Sort field	`sort`
`page`	integer	Yes	Page number	`1`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/products/price-lists?include=currency%2Citems&sort=sort&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/products/price-lists?include=currency%2Citems&sort=sort&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/products/price-lists?include=currency%2Citems&sort=sort&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/products/price-lists?include=currency%2Citems&sort=sort&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": 1,
      "name": "Public Price List",
      "sort": 1,
      "is_active": true,
      "currency_id": 20,
      "creator_id": null,
      "company_id": null,
      "created_at": "2026-10-09T09:49:56.000000Z",
      "updated_at": "2026-10-09T09:49:56.000000Z"
    },
    {
      "id": 1,
      "name": "Public Price List",
      "sort": 1,
      "is_active": true,
      "currency_id": 20,
      "creator_id": null,
      "company_id": null,
      "created_at": "2026-10-09T09:49:56.000000Z",
      "updated_at": "2026-10-09T09:49:56.000000Z"
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Create price list

POST /admin/api/v1/products/price-lists

Create a new price list together with its pricing rules

🔒 Requires a valid Bearer token.

Body parameters

Parameter	Type	Required	Description
`name`	string	Yes	Price list name (max 255 characters). Must not be greater than 255 characters.
`currency_id`	integer	Yes	Currency the price list is expressed in. Orders using this list adopt its currency. Must match an existing stored value.
`company_id`	integer	No	Company ID. Leave empty to share the price list across companies. Must match an existing stored value.
`sort`	integer	No
`is_active`	boolean	No	Whether the price list can be applied to new orders.
`items`	object[]	No	Price rules. The most specific rule that matches a product decides its price.
`items[].id`	integer	No	Must match an existing stored value.
`items[].display_apply_to`	string	No	Whether the rule targets a product or a category. Defaults to product.
`items[].type`	string	Yes	How the price is computed: fixed, percentage or formula.
`items[].base`	string	No	Price the rule starts from: list_price, standard_price or price_rules.
`items[].product_id`	integer	No	Product the rule applies to. Leave empty to cover all products. Pass a variant to scope the rule to that variant alone. Must match an existing stored value.
`items[].category_id`	integer	No	Category the rule applies to. Leave empty to cover all categories. Must match an existing stored value.
`items[].base_price_list_id`	integer	No	This field is required when items.*.base is price_rules. Must match an existing stored value.
`items[].min_quantity`	number	No	Quantity, in the product unit of measure, from which the rule applies. Must be at least 0.
`items[].fixed_price`	number	No	Unit price used when the rule type is fixed.
`items[].percent_price`	number	No	Discount percentage used when the rule type is percentage. Negative applies a mark-up.
`items[].price_discount`	number	No
`items[].price_markup`	number	No
`items[].price_round`	number	No	Must be at least 0.
`items[].price_surcharge`	number	No
`items[].price_min_margin`	number	No
`items[].price_max_margin`	number	No
`items[].starts_at`	string	No	Must be a valid date.
`items[].ends_at`	string	No	Must be a valid date. Must be a date after or equal to items.*.starts_at.

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/products/price-lists" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Wholesale",
  "currency_id": 1,
  "company_id": 1,
  "sort": 16,
  "is_active": true,
  "items": [
    {
      "id": 16,
      "display_apply_to": "product",
      "type": "fixed",
      "base": "list_price",
      "product_id": 1,
      "category_id": 1,
      "base_price_list_id": 16,
      "min_quantity": 10,
      "fixed_price": 42.5,
      "percent_price": 25,
      "price_discount": 4326.41688,
      "price_markup": 4326.41688,
      "price_round": 77,
      "price_surcharge": 4326.41688,
      "price_min_margin": 4326.41688,
      "price_max_margin": 4326.41688,
      "starts_at": "2026-10-12T10:50:03",
      "ends_at": "2052-11-04"
    }
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/products/price-lists", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Wholesale",
  "currency_id": 1,
  "company_id": 1,
  "sort": 16,
  "is_active": true,
  "items": [
    {
      "id": 16,
      "display_apply_to": "product",
      "type": "fixed",
      "base": "list_price",
      "product_id": 1,
      "category_id": 1,
      "base_price_list_id": 16,
      "min_quantity": 10,
      "fixed_price": 42.5,
      "percent_price": 25,
      "price_discount": 4326.41688,
      "price_markup": 4326.41688,
      "price_round": 77,
      "price_surcharge": 4326.41688,
      "price_min_margin": 4326.41688,
      "price_max_margin": 4326.41688,
      "starts_at": "2026-10-12T10:50:03",
      "ends_at": "2052-11-04"
    }
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/products/price-lists', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Wholesale',
    'currency_id' => 1,
    'company_id' => 1,
    'sort' => 16,
    'is_active' => true,
    'items' => [
      [
        'id' => 16,
        'display_apply_to' => 'product',
        'type' => 'fixed',
        'base' => 'list_price',
        'product_id' => 1,
        'category_id' => 1,
        'base_price_list_id' => 16,
        'min_quantity' => 10,
        'fixed_price' => 42.5,
        'percent_price' => 25,
        'price_discount' => 4326.41688,
        'price_markup' => 4326.41688,
        'price_round' => 77,
        'price_surcharge' => 4326.41688,
        'price_min_margin' => 4326.41688,
        'price_max_margin' => 4326.41688,
        'starts_at' => '2026-10-12T10:50:03',
        'ends_at' => '2052-11-04',
      ],
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/products/price-lists"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Wholesale",
    "currency_id": 1,
    "company_id": 1,
    "sort": 16,
    "is_active": True,
    "items": [
        {
            "id": 16,
            "display_apply_to": "product",
            "type": "fixed",
            "base": "list_price",
            "product_id": 1,
            "category_id": 1,
            "base_price_list_id": 16,
            "min_quantity": 10,
            "fixed_price": 42.5,
            "percent_price": 25,
            "price_discount": 4326.41688,
            "price_markup": 4326.41688,
            "price_round": 77,
            "price_surcharge": 4326.41688,
            "price_min_margin": 4326.41688,
            "price_max_margin": 4326.41688,
            "starts_at": "2026-10-12T10:50:03",
            "ends_at": "2052-11-04",
        },
    ],
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

json

{
  "data": {
    "id": 1,
    "name": "Public Price List",
    "sort": 1,
    "is_active": true,
    "currency_id": 20,
    "creator_id": null,
    "company_id": null,
    "created_at": "2026-10-09T09:49:56.000000Z",
    "updated_at": "2026-10-09T09:49:56.000000Z"
  },
  "message": "Price list created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show price list

GET /admin/api/v1/products/price-lists/{id}

Retrieve a specific price list by its ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The price list ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: currency, company, creator, items	`currency,items`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/products/price-lists/{id}?include=currency%2Citems" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/products/price-lists/{id}?include=currency%2Citems", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/products/price-lists/{id}?include=currency%2Citems', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/products/price-lists/{id}?include=currency%2Citems"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": 1,
    "name": "Public Price List",
    "sort": 1,
    "is_active": true,
    "currency_id": 20,
    "creator_id": null,
    "company_id": null,
    "created_at": "2026-10-09T09:49:56.000000Z",
    "updated_at": "2026-10-09T09:49:56.000000Z"
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Update price list

PUT /admin/api/v1/products/price-lists/{id}

Update an existing price list. Sending items replaces the existing rules.

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The price list ID

Body parameters

Parameter	Type	Required	Description
`name`	string	No	Price list name (max 255 characters). Must not be greater than 255 characters.
`currency_id`	integer	No	Currency the price list is expressed in. Orders using this list adopt its currency. Must match an existing stored value.
`company_id`	integer	No	Company ID. Leave empty to share the price list across companies. Must match an existing stored value.
`sort`	integer	No
`is_active`	boolean	No	Whether the price list can be applied to new orders.
`items`	object[]	No	Price rules. The most specific rule that matches a product decides its price.
`items[].id`	integer	No	Must match an existing stored value.
`items[].display_apply_to`	string	No	Whether the rule targets a product or a category. Defaults to product.
`items[].type`	string	Yes	How the price is computed: fixed, percentage or formula.
`items[].base`	string	No	Price the rule starts from: list_price, standard_price or price_rules.
`items[].product_id`	integer	No	Product the rule applies to. Leave empty to cover all products. Pass a variant to scope the rule to that variant alone. Must match an existing stored value.
`items[].category_id`	integer	No	Category the rule applies to. Leave empty to cover all categories. Must match an existing stored value.
`items[].base_price_list_id`	integer	No	This field is required when items.*.base is price_rules. Must match an existing stored value.
`items[].min_quantity`	number	No	Quantity, in the product unit of measure, from which the rule applies. Must be at least 0.
`items[].fixed_price`	number	No	Unit price used when the rule type is fixed.
`items[].percent_price`	number	No	Discount percentage used when the rule type is percentage. Negative applies a mark-up.
`items[].price_discount`	number	No
`items[].price_markup`	number	No
`items[].price_round`	number	No	Must be at least 0.
`items[].price_surcharge`	number	No
`items[].price_min_margin`	number	No
`items[].price_max_margin`	number	No
`items[].starts_at`	string	No	Must be a valid date.
`items[].ends_at`	string	No	Must be a valid date. Must be a date after or equal to items.*.starts_at.

cURLJavaScriptPHPPython

bash

curl -X PUT "https://your-domain.com/admin/api/v1/products/price-lists/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Wholesale",
  "currency_id": 1,
  "company_id": 1,
  "sort": 16,
  "is_active": true,
  "items": [
    {
      "id": 16,
      "display_apply_to": "product",
      "type": "fixed",
      "base": "list_price",
      "product_id": 1,
      "category_id": 1,
      "base_price_list_id": 16,
      "min_quantity": 10,
      "fixed_price": 42.5,
      "percent_price": 25,
      "price_discount": 4326.41688,
      "price_markup": 4326.41688,
      "price_round": 77,
      "price_surcharge": 4326.41688,
      "price_min_margin": 4326.41688,
      "price_max_margin": 4326.41688,
      "starts_at": "2026-10-12T10:50:03",
      "ends_at": "2052-11-04"
    }
  ]
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/products/price-lists/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Wholesale",
  "currency_id": 1,
  "company_id": 1,
  "sort": 16,
  "is_active": true,
  "items": [
    {
      "id": 16,
      "display_apply_to": "product",
      "type": "fixed",
      "base": "list_price",
      "product_id": 1,
      "category_id": 1,
      "base_price_list_id": 16,
      "min_quantity": 10,
      "fixed_price": 42.5,
      "percent_price": 25,
      "price_discount": 4326.41688,
      "price_markup": 4326.41688,
      "price_round": 77,
      "price_surcharge": 4326.41688,
      "price_min_margin": 4326.41688,
      "price_max_margin": 4326.41688,
      "starts_at": "2026-10-12T10:50:03",
      "ends_at": "2052-11-04"
    }
  ]
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/products/price-lists/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Wholesale',
    'currency_id' => 1,
    'company_id' => 1,
    'sort' => 16,
    'is_active' => true,
    'items' => [
      [
        'id' => 16,
        'display_apply_to' => 'product',
        'type' => 'fixed',
        'base' => 'list_price',
        'product_id' => 1,
        'category_id' => 1,
        'base_price_list_id' => 16,
        'min_quantity' => 10,
        'fixed_price' => 42.5,
        'percent_price' => 25,
        'price_discount' => 4326.41688,
        'price_markup' => 4326.41688,
        'price_round' => 77,
        'price_surcharge' => 4326.41688,
        'price_min_margin' => 4326.41688,
        'price_max_margin' => 4326.41688,
        'starts_at' => '2026-10-12T10:50:03',
        'ends_at' => '2052-11-04',
      ],
    ],
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/products/price-lists/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Wholesale",
    "currency_id": 1,
    "company_id": 1,
    "sort": 16,
    "is_active": True,
    "items": [
        {
            "id": 16,
            "display_apply_to": "product",
            "type": "fixed",
            "base": "list_price",
            "product_id": 1,
            "category_id": 1,
            "base_price_list_id": 16,
            "min_quantity": 10,
            "fixed_price": 42.5,
            "percent_price": 25,
            "price_discount": 4326.41688,
            "price_markup": 4326.41688,
            "price_round": 77,
            "price_surcharge": 4326.41688,
            "price_min_margin": 4326.41688,
            "price_max_margin": 4326.41688,
            "starts_at": "2026-10-12T10:50:03",
            "ends_at": "2052-11-04",
        },
    ],
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": 1,
    "name": "Public Price List",
    "sort": 1,
    "is_active": true,
    "currency_id": 20,
    "creator_id": null,
    "company_id": null,
    "created_at": "2026-10-09T09:49:56.000000Z",
    "updated_at": "2026-10-09T09:49:56.000000Z"
  },
  "message": "Price list updated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Delete price list

DELETE /admin/api/v1/products/price-lists/{id}

Delete a price list and its pricing rules

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The price list ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/products/price-lists/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/products/price-lists/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/products/price-lists/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/products/price-lists/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Price list deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Price Lists ​

List price lists ​

Create price list ​

Show price list ​

Update price list ​

Delete price list ​

Price Lists

List price lists

Create price list

Show price list

Update price list

Delete price list