{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Prices API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Prices", "type": "folder" }, "items": [ { "info": { "name": "Gets all Prices by Price Book ID", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices", "params": [ { "name": "pricebookID", "value": "", "type": "path", "description": "The 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 all the product prices in the specified price book.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |\n| `eq` | `external_ref`, `sku` | Checks if the values you provide matches a price. | `filter=eq(sku,some-sku)` |\n| `in` | `sku` | Checks if the values you provide are included in a product SKU. | `filter=in(sku,some-sku)' |\n" }, { "info": { "name": "Add a Product Price to a Price Book", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices", "params": [ { "name": "pricebookID", "value": "", "type": "path", "description": "The unique identifier of a price book." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Price books contain prices for the products in your catalog. Use the Prices API to adds the prices for a product to a specified price book. If the prices for the product already exist in the price book, the operation fails and the existing product prices are not updated." }, { "info": { "name": "Get a Product Price by Price Book ID", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices/:priceID", "params": [ { "name": "pricebookID", "value": "", "type": "path", "description": "The unique identifier of a price book." }, { "name": "priceID", "value": "", "type": "path", "description": "A unique identifier of a price book price." } ] }, "docs": "Retrieves a specified product price (`priceId`) in the specified price book (`id`)." }, { "info": { "name": "Update a Product Price in a Price Book", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices/:priceID", "params": [ { "name": "pricebookID", "value": "", "type": "path", "description": "The unique identifier of a price book." }, { "name": "priceID", "value": "", "type": "path", "description": "A unique identifier of a price book price." } ], "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 is not updated." }, { "info": { "name": "Delete a Product Price from a Price Book", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/:pricebookID/prices/:priceID", "params": [ { "name": "pricebookID", "value": "", "type": "path", "description": "The unique identifier of a price book." }, { "name": "priceID", "value": "", "type": "path", "description": "A unique identifier of a price book price." } ] }, "docs": "Deletes a product price from the specified price book." }, { "info": { "name": "Gets all Prices", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/pricebooks/prices", "params": [ { "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": "Allows you to retrieve all prices for a product, irrespective of the different price books that include that product's price. For example, you can filter for all prices for a specified `sku`, or filter for all prices changed before or after a given date. This will retrieve prices from all price books.\n\n### Filtering\n\nThis endpoint supports filtering. For general syntax, see [Filtering](/guides/Getting-Started/filtering).\n\n| Operator | Attribute | Description | Example |\n| --- | --- | --- | --- |" } ] } ], "bundled": true }