{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Products API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "Get all products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/products", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "The number of records to offset the results by." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The number of records per page. The maximum limit is 100." }, { "name": "filter", "value": "", "type": "query", "description": "Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).\n\nFor more information about the attributes and operators that are supported, see [Get all products](/docs/api/pxm/products/get-all-products).\n" }, { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" } ] }, "docs": "Retrieves a list of all your products in the Product Experience Manager system.\n\nYou can also use `include` to retrieve top-level resources, such as files or images, and key attribute data, such as SKU or slug for component products in a product bundle. With this option, you can get more information about the products in a product bundle in your store front, improving the buying experience for your shoppers.\n\n#### Pagination\n\nThis endpoint supports offset-based pagination using `page[offset]` an" }, { "info": { "name": "Create a product or bundle", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/products", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a product or bundle with the attributes that are defined in the body.\n\n#### Product Types\n\nProduct Experience Manager automatically assigns types to the products you create. You can filter on product types. Product types can also be used in catalogs. For example, in your catalog, you can filter on `parent` so that only your parent products are displayed in your storefront. \n\nSee [**Product Types**](/docs/api/pxm/products/products#product-types).\n\n#### Product Tags\n\nYou can use product ta" }, { "info": { "name": "Get a product", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/products/:productID", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." }, { "name": "include", "value": "", "type": "query", "description": "Using the include parameter, you can retrieve top-level resources.\n\n- Files or main image. For example, `include=files,main_image`.\n- Component product data. For example, `include=component_products`.\n- Key attribute data, such as SKU or slug.\n" } ] }, "docs": "Returns a product by its identifier. \n\nYou can also use `include=component_products` to retrieve top-level resources, such as files or images, and key attribute data, such as SKU or slug for component products in a product bundle. With this option, you can get more information about the products in a product bundle in your store front, improving the buying experience for your shoppers.\n" }, { "info": { "name": "Update a product or bundle", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/products/:productID", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ], "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 product or bundle is not updated." }, { "info": { "name": "Delete a product", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/products/:productID", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ] }, "docs": "Deletes the specified product.\n\nYou cannot delete a product if it is part of a bundle. You must first delete the bundle before you delete the product.\n" }, { "info": { "name": "Attach multiple nodes", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/products/attach_nodes", "body": { "type": "json", "data": "{}" } }, "docs": "Assigns products to multiple hierarchies and their children nodes. You can apply a filter to search for the appropriate products to attach to a node. For general filtering syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n \n The following attributes and operators are supported.\n \n | Operator | Attribute | Description " }, { "info": { "name": "Detach multiple nodes", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/products/detach_nodes", "body": { "type": "json", "data": "{}" } }, "docs": "Dissociates products from multiple hierarchies and their children nodes. You can apply filters to search for the appropriate products to detach. For general filtering syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n \nThe following attributes and operators are supported.\n \n | Operator | Attribute | Description " }, { "info": { "name": "Get a product's nodes", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/nodes", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "The number of records to offset the results by." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The number of records per page. The maximum limit is 100." }, { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ] }, "docs": "Returns the nodes associated with the product. Products must be in a `live` status." } ] } ], "bundled": true }