{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Price Book Modifiers API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Price Book Modifiers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of all modifiers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "This endpoint supports filtering. See [Filtering]().\n"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "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**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "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**](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              }
            ]
          },
          "docs": "Retrieves a list of price modifiers for the specified price book.\n\n### Filtering\n\nFiltering is supported on this endpoint. For the general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\nYou can filter on the following attributes and operators.\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |\n| `eq` | `external_ref`, `name` | Checks if the values you provide matches a price modifier. | `filter=eq(name,largesupplement)` |\n"
        },
        {
          "info": {
            "name": "Create a Modifier",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Get a Modifier",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers/:modifierID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book"
              },
              {
                "name": "modifierID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book Modifier"
              }
            ]
          },
          "docs": "Retrieves the specified price book modifier from the specified price book."
        },
        {
          "info": {
            "name": "Update a Modifier",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers/:modifierID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book"
              },
              {
                "name": "modifierID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book Modifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price modifier is not updated."
        },
        {
          "info": {
            "name": "Delete a Modifier",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/modifiers/:modifierID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book"
              },
              {
                "name": "modifierID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a Price Book Modifier"
              }
            ]
          },
          "docs": "Deletes the specified price book modifier."
        }
      ]
    }
  ],
  "bundled": true
}