{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Price Books API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Price Books",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all Price Books",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "You can filter on this endpoint. See [Filtering](#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 all price books.\n\n### Filtering\n\nFiltering is supported on this endpoint. For the general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n You can filter on the following attributes and operators.\n\n | Operator | Attribute | Description | Example |\n | --- | --- | --- | --- |\n | `eq` | `external_ref` | Equals. Checks if the values you provide matches a price book. | `filter=eq(external_ref,some-external-ref)` |\n"
        },
        {
          "info": {
            "name": "Create a Price Book",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a price book. You can add the prices to the price book now or update the price book later."
        },
        {
          "info": {
            "name": "Get a Price Book by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a price book."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "To include product prices in a response, add `include=prices`."
              }
            ]
          },
          "docs": "Retrieves the specified price book. To include prices in the response, append `?include=prices` to the path."
        },
        {
          "info": {
            "name": "Update a Price Book by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a price book."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified price book. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price book is not updated."
        },
        {
          "info": {
            "name": "Delete a Price Book by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a price book."
              }
            ]
          },
          "docs": "Deletes the specified price book and all prices in the price book. It does not delete the products. In addition, pricing details in the orders referring to the deleted price book are not deleted."
        },
        {
          "info": {
            "name": "Replicate a Price Book",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/replicate",
            "params": [
              {
                "name": "pricebookID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a price book."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Using this endpoint, you can replicate an existing price book. This is useful because it enables you to quickly and easily create multiple price books with the same pricing structure. When you replicate an existing price book, you can specify a new name, description, and external reference for the replicated price book. Other attributes stay the same.\n"
        }
      ]
    }
  ],
  "bundled": true
}