Gets all Prices by Price Book ID

GET 
https://euwest.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices

Retrieves all the product prices in the specified price book.

Filtering

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

Operator	Attribute	Description	Example
eq	external_ref, sku	Checks if the values you provide matches a price.	filter=eq(sku,some-sku)
in	sku	Checks if the values you provide are included in a product SKU.	`filter=in(sku,some-sku)'

Request

Path Parameters

pricebookID stringrequired

The unique identifier of a price book.

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 product price list.

application/json

Schema

Schema

meta object

Contains the results for the entire collection.

results object

totalintegernullable

Total number of results for the entire collection.

Example: 1

page object

limitinteger

The maximum number of records for all pages.

Example: 10

offsetinteger

The current offset by number of pages.

Example: 0

currentinteger

The current number of pages.

Example: 0

totalinteger

The total number of records for the entire collection.

Example: 1

data object[]required

Array [

typestringrequired

Possible values: [product-price]

Default value: product-price

Example: product-price

pricebook_external_refstringnullable

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.

Example: a-pricebook-external-ref

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.

amountint64nullable

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

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_quantityint64nullable

The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.

Example: 10

amountint64nullable

The price for each quantity.

Example: 50

skustringrequired

The product SKU that the price belongs to.

Possible values: non-empty

Example: product-sku-a

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_idsuuid[]

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_fromdate-timenullable

The start date of the sale.

Example: 2023-09-22T09:00:00Z

valid_todate-timenullable

The end date of the sale.

Example: 2023-09-24T09:00:00Z

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.

amountint64nullable

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

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_quantityint64nullable

The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.

Example: 10

amountint64nullable

The price for each quantity.

Example: 50

external_refstringnullable

A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

Example: external-ref

created_atdate-time

The date and time when the price was created.

Example: 2020-09-22T09:00:00Z

updated_atdate-time

The date and time when the price was last updated.

Example: 2020-09-22T09:00:00Z

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

idstringrequired

The unique identifier for the product price.

Example: a915553d-935d-4d56-870b-817b47a44a99

meta object

Information that provides context to other data sets.

ownerstringnullable

The resource owner, either organization or store.

Example: store

pricebook_idstring

The unique identifier of the price book.

Example: 4c45e4ec-26e0-4043-86e4-c15b9cf985a7

]

links object

Links are used to allow you to move between requests.

selfurinullable

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

Example: /pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/prices?filter=like(sku,*product*)

firsturinullable

Always the first page.

lasturinullable

This is null if there is only one page.

prevurinullable

This is null if there is only one page.

nexturinullable

This is null if there is only one page.

Example (auto)

{
  "meta": {
    "results": {
      "total": 1
    },
    "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/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/prices?filter=like(sku,*product*)",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

default

Unexpected error

application/json

Schema

Schema

errors object[]
Array [
detailstring
Example: The price already exists
statusstring
Example: 409
titlestring
Example: conflict
]

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

pricebookID — pathrequired

filter — query

page[limit] — query

page[offset] — query

ResponseClear

Click the Send API Request button above and see the response here!