{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Variations API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Variations", "type": "folder" }, "items": [ { "info": { "name": "Build child products", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/build", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "With product variations in Product Experience Manager, you can create product variations and different options for each variation and use both to create child products for a product. Each child product is a unique combination of options associated with the product. \n\nChild products inherit attributes from their parent products. When you make changes to the attributes of the parent products, you can rebuild your child products, ensuring that changes to the parent products are propagated to the c" }, { "info": { "name": "Get child products", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/children", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ] }, "docs": "Get child products" }, { "info": { "name": "Get all product variation relationships", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/relationships/variations", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ] }, "docs": "Get all product variation relationships" }, { "info": { "name": "Create a product variation relationship", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/relationships/variations", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a product variation relationship" }, { "info": { "name": "Replace a product variation relationship", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/relationships/variations", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace a product variation relationship" }, { "info": { "name": "Delete a product variation relationships", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/products/:productID/relationships/variations", "params": [ { "name": "productID", "value": "", "type": "path", "description": "A unique identifier for the product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a product variation relationships" }, { "info": { "name": "Get all variations", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations", "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." } ] }, "docs": "Get all variations" }, { "info": { "name": "Create a variation", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/variations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a variation" }, { "info": { "name": "Get a variation", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." } ] }, "docs": "Get a variation" }, { "info": { "name": "Update a variation", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." } ], "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 variation is not updated." }, { "info": { "name": "Delete a variation and all it's associated options.", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." } ] }, "docs": "Delete a variation and all it's associated options." }, { "info": { "name": "Get all variation options", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "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." } ] }, "docs": "Get all variation options" }, { "info": { "name": "Create a variation option", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a variation option" }, { "info": { "name": "Get a variation option", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." } ] }, "docs": "Get a variation option" }, { "info": { "name": "Update a variation option", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a variation option" }, { "info": { "name": "Delete a variation option", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." } ] }, "docs": "Delete a variation option" }, { "info": { "name": "Get all modifiers", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." }, { "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." } ] }, "docs": "Get all modifiers" }, { "info": { "name": "Create a modifier", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can specify different modifiers for different options in a variation. When you build child products using options in variations, the properties of a child products depends on the modifier set for the options that are applied to the child product.\n \nThe table below describes the different types of modifiers.\n\n| Modifier | Data Type | Effect |\n| :--- | :--- | :--- |\n| `name_equals` | `string` | Overrides the name of the child product with the name specified by the modifier. |\n| `name_append` |" }, { "info": { "name": "Get a modifier", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers/:modifierID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." }, { "name": "modifierID", "value": "", "type": "path", "description": "A unique identifier for the modifier." } ] }, "docs": "Get a modifier" }, { "info": { "name": "Update a modifier", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers/:modifierID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." }, { "name": "modifierID", "value": "", "type": "path", "description": "A unique identifier for the 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 modifier is not updated." }, { "info": { "name": "Delete a modifier", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/pcm/variations/:variationID/options/:optionID/modifiers/:modifierID", "params": [ { "name": "variationID", "value": "", "type": "path", "description": "A unique identifier for the variation." }, { "name": "optionID", "value": "", "type": "path", "description": "A unique identifier for the option." }, { "name": "modifierID", "value": "", "type": "path", "description": "A unique identifier for the modifier." } ] }, "docs": "You cannot delete a modifier if it is in use. Deleting a modifier in us returns a `422 Failed Validation` error." } ] } ], "bundled": true }