Gets all Prices

GET 
/pcm/pricebooks/prices

Retrieves all the prices.

Filtering

This endpoint supports filtering. For general syntax, see Filtering.

Operator	Attribute	Description	Example
eq	external_ref, sku, id	Equals. Checks if the values of two operands are equal. If they are, the condition is true.	filter=eq(sku,some-sku)
in	external_ref, sku, id	In. Checks if the values are included in the specified list. If they are, the condition is true.	filter=in(sku,some-sku)
like	external_ref, sku	Like. Checks if the operand contains the specified string. Wildcards are supported.	filter=like(sku,some-sku)
gt	updated_at, created_at	Greater than. Checks if the value on the left of the operator is greater than the value on the right. If it is, the condition is true.	filter=gt(updated_at,2018-04-16T10:11:59.715Z)
lt	updated_at, created_at	Less than. Checks if the value on the left of the operator is less than the value on the right. If it is, the condition is true.	filter=lt(updated_at,2018-04-16T10:11:59.715Z)

Request

Query Parameters

filter string

This endpoint supports filtering. See Filtering.

page[limit] int64

Possible values: >= 1

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the page length store setting is used.

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the page length store setting is used.

Responses

200

The price list.

application/json

Schema

Schema

meta object

Contains the results for the entire collection.

page object

limit integer

The maximum number of records for all pages.

offset integer

The current offset by number of pages.

current integer

The current number of pages.

total integer

The total number of records for the entire collection.

data object[]required
Array [
type stringrequired
Possible values: [product-price]
Default value: product-price
pricebook_external_ref stringnullable
The unique attribute associated with the price book. This can be an external reference from a separate company system, for example. The maximum length is 2048 characters.
attributes objectrequired
currencies object
A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.
property name* amount
The three-letter ISO code for the currency associated with this price.
amount int64nullable
The price in the lowest denomination for the specified currency. This is a product's list price.
includes_tax boolean
Whether this price includes tax.
tiers object
The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.
property name* tier-price
The name of the tier, for example, Pencils.
minimum_quantity int64nullable
The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.
amount int64nullable
The price for each quantity.
sku stringrequired
Possible values: non-empty
The product SKU that the price belongs to.
sales object
The sales price that an item is eligible for based on the price book.
property name* sale
The name of the sale, such as Summer Sale.
bundle_ids uuid[]
A list of product IDs in a bundle that you want to specify a sale price for.
schedule objectnullable
The schedule of the sale. Contains an optional valid_from and valid_to parameter for the start and end date of a sale.
For sale prices in the same price book:
• the schedules must not be exactly the same.
• schedules can partially overlap. If the schedule does contain overlapping sales prices, the sale price of the smallest sale period is chosen.
• if you have just one sale price, without a schedule, this is effectively a permanent price. If you want to add more sale prices to the price book, you must configure a schedule for the sale price.
Sale prices in different price books can have overlapping schedules.
valid_from date-timenullable
The start date of the sale.
valid_to date-timenullable
The end date of the sale.
currencies object
A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.
property name* amount
The three-letter ISO code for the currency associated with this price.
amount int64nullable
The price in the lowest denomination for the specified currency. This is a product's list price.
includes_tax boolean
Whether this price includes tax.
tiers object
The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.
property name* tier-price
The name of the tier, for example, Pencils.
minimum_quantity int64nullable
The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.
amount int64nullable
The price for each quantity.
external_ref stringnullable
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
created_at date-time
The date and time when the price was created.
updated_at date-time
The date and time when the price was last updated.
admin_attributes object
You can add custom attributes to a product price. For example, you may want to add custom attributes that can automate price updates based on predefined rules, saving time and reducing human error or you might want to integrate price attributes with your other company systems, (ERP, CRM) ensuring consistency and accuracy across platforms.
admin_attributes are not displayed in catalogs. This means admin_attributes can only be viewed by administrators. If you want a custom attribute to be displayed in a catalog, you must add a shopper_attribute.
admin_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name* stringnullable
shopper_attributes object
You can add custom attributes to a product price. For example, you can set prices based on customer segments. For instance, you can offer different prices for wholesale and retail customers or provide discounts to loyal customers. Following on from this, you might want to offer personalized offers and prices, enhancing the shopping experience.
shopper_attributes are displayed in catalogs. This means shopper_attributes can be viewed by both shoppers and administrators. If you do not want a custom attribute to be displayed in a catalog, you must add an admin_attribute.
shopper_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name* stringnullable
id stringrequired
The unique identifier for the product price.
meta object
Information that provides context to other data sets.
owner stringnullable
The resource owner, either organization or store.
pricebook_id string
The unique identifier of the price book.
]
links object

Links are used to allow you to move between requests.

self urinullable

Single entities use a self parameter with a link to that specific resource.

first urinullable

Always the first page.

prev urinullable

This is null if there is only one page.

next urinullable

This is null if there is only one page.

Example (from schema)

{
  "meta": {
    "page": {
      "limit": 10,
      "offset": 0,
      "current": 0,
      "total": 1
    }
  },
  "data": [
    {
      "type": "product-price",
      "pricebook_external_ref": "a-pricebook-external-ref",
      "attributes": {
        "currencies": {
          "USD": {
            "amount": 100,
            "includes_tax": false,
            "tiers": {
              "min_5": {
                "minimum_quantity": 5,
                "amount": 50
              }
            }
          },
          "CAD": {
            "amount": 127,
            "includes_tax": false,
            "tiers": {
              "min_10": {
                "minimum_quantity": 10,
                "amount": 100
              }
            }
          },
          "GBP": {
            "amount": 73,
            "includes_tax": true,
            "tiers": {
              "min_20": {
                "minimum_quantity": 20,
                "amount": 60
              }
            }
          }
        },
        "sku": "product-sku-a",
        "sales": {
          "summer": {
            "schedule": {
              "valid_form": "2023-12-24T09:00:00",
              "valid_to": "2023-12-25T09:00:00"
            },
            "currencies": {
              "USD": {
                "amount": 90,
                "includes_tax": false,
                "tiers": {
                  "min_5": {
                    "minimum_quantity": 5,
                    "amount": 40
                  }
                }
              },
              "CAD": {
                "amount": 117,
                "includes_tax": false,
                "tiers": {
                  "min_10": {
                    "minimum_quantity": 10,
                    "amount": 80
                  }
                }
              },
              "GBP": {
                "amount": 65,
                "includes_tax": true,
                "tiers": {
                  "min_20": {
                    "minimum_quantity": 20,
                    "amount": 50
                  }
                }
              }
            }
          }
        },
        "external_ref": "external-ref",
        "created_at": "2020-09-22T09:00:00Z",
        "updated_at": "2020-09-22T09:00:00Z",
        "admin_attributes": {
          "cost_of_goods": "42.0",
          "charge_type": "credit card"
        },
        "shopper_attributes": {
          "cost_of_goods": "42.0",
          "charge_type": "credit card"
        }
      },
      "id": "a915553d-935d-4d56-870b-817b47a44a99",
      "meta": {
        "owner": "store",
        "pricebook_id": "4c45e4ec-26e0-4043-86e4-c15b9cf985a7"
      }
    }
  ],
  "links": {
    "self": "/pcm/pricebooks/prices?filter=like(sku,product)",
    "first": "string",
    "prev": "string",
    "next": "string"
  }
}

default

Unexpected error

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "The price already exists",
      "status": "409",
      "title": "conflict"
    }
  ]
}

Loading...