Gets a list of all modifiers

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

Retrieves a list of price modifiers for the specified price book.

Filtering

Filtering is supported on this endpoint. For the general syntax, see Filtering.

You can filter on the following attributes and operators.

Operator	Attribute	Description	Example
eq	external_ref, name	Checks if the values you provide matches a price modifier.	filter=eq(name,largesupplement)

Request

Path Parameters

pricebookID stringrequired

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 price modifier 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: [price-modifier]
Default value: price-modifier
Example: price-modifier
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
external_refstringnullable
A unique identifier associated with the price modifier. This can be an external reference from a separate company system, for example. The maximum length is 2048 characters.
Example: external-ref
currencies objectrequired
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
namestringrequired
A name for the modifier. You must give the price modifier a unique name. Price modifier names are case-sensitive.
Example: large-supplement
modifier_typestringrequired
There are three modifier types.
• price_increment - Increases the price of a product.
• price_decrement - Decreases the price of a product.
• price_equals - Sets the price of a product to the amount you specify.
Possible values: [price_equals, price_increment, price_decrement]
Example: price_equals
created_atdate-time
The date and time when the price book was created.
Example: 2020-09-22T09:00:00Z
updated_atdate-time
The date and time when the price book was last updated.
Example: 2020-09-22T09:00:00Z
idstringrequired
A unique identifier for the price modifier.
Example: 37f2eed6-0bea-4d0b-a3c6-24cc76143bfd
meta object
ownerstringnullable
The product owner, either organization or store.
Example: store
]
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/modifiers
firsturinullable
Always the first page.
Example: /pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25
lasturinullable
This is null if there is only one page.
Example: /pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25
prevurinullable
This is null if there is only one page.
Example: /pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25
nexturinullable
This is null if there is only one page.
Example: /pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=25&page[limit]=25

Example (auto)

{
  "meta": {
    "results": {
      "total": 1
    },
    "page": {
      "limit": 10,
      "offset": 0,
      "current": 0,
      "total": 1
    }
  },
  "data": [
    {
      "type": "price-modifier",
      "pricebook_external_ref": "a-pricebook-external-ref",
      "attributes": {
        "external_ref": "external-ref",
        "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
              }
            }
          }
        },
        "name": "large-supplement",
        "modifier_type": "price_equals",
        "created_at": "2020-09-22T09:00:00Z",
        "updated_at": "2020-09-22T09:00:00Z"
      },
      "id": "37f2eed6-0bea-4d0b-a3c6-24cc76143bfd",
      "meta": {
        "owner": "store"
      }
    }
  ],
  "links": {
    "self": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers",
    "first": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25",
    "last": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25",
    "prev": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=0&page[limit]=25",
    "next": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7/modifiers?page[offset]=25&page[limit]=25"
  }
}

default

Unexpected error

application/json

Schema

Schema

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

Example (auto)

{
  "errors": [
    {
      "detail": "The modifier 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/modifiers");
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!