Create a Modifier

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

You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price. This enables you to configure the price of child products, for example, to be lower than its base product, without having to individually update the price of your child products. There are three types of price modifier.

Request

Responses

201

The created price modifier

default

Unexpected error.

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.Post, "https://euwest.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"price-modifier\",\n    \"attributes\": {\n      \"currencies\": {\n        \"USD\": {\n          \"amount\": 100,\n          \"includes_tax\": false,\n          \"tiers\": {\n            \"min_5\": {\n              \"minimum_quantity\": 5,\n              \"amount\": 50\n            }\n          }\n        },\n        \"CAD\": {\n          \"amount\": 127,\n          \"includes_tax\": false,\n          \"tiers\": {\n            \"min_10\": {\n              \"minimum_quantity\": 10,\n              \"amount\": 100\n            }\n          }\n        },\n        \"GBP\": {\n          \"amount\": 73,\n          \"includes_tax\": true,\n          \"tiers\": {\n            \"min_20\": {\n              \"minimum_quantity\": 20,\n              \"amount\": 60\n            }\n          }\n        }\n      },\n      \"name\": \"large-supplement\",\n      \"modifier_type\": \"price_equals\",\n      \"external_ref\": \"external-ref\"\n    }\n  }\n}", null, "application/json");
request.Content = content;
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

Body required

{
  "data": {
    "type": "price-modifier",
    "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
            }
          }
        }
      },
      "name": "large-supplement",
      "modifier_type": "price_equals",
      "external_ref": "external-ref"
    }
  }
}

ResponseClear

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