{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Product Modifiers API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Product Modifiers", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get All Product Modifiers", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/modifiers", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" }, { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products." }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products." }, { "name": "include_fields", "value": "", "type": "query", "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded." } ] }, "docs": "Returns a list of all *Product Modifiers*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Product Modifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/modifiers", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a *Product Modifier*.\n\n**Required Fields**\n* `required`\n* `display_name`\n* `type`\n\n**Read-Only Fields**\n* `id`\n\n**Notes**\nIt takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values." }, { "info": { "name": "BigCommerce Get a Product Modifier", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/modifiers/:modifier_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" }, { "name": "modifier_id", "value": "", "type": "path", "description": "The ID of the `Modifier`.\n" }, { "name": "include_fields", "value": "", "type": "query", "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded." } ] }, "docs": "Returns a single *Product Modifier*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Update a Product Modifier", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/modifiers/:modifier_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" }, { "name": "modifier_id", "value": "", "type": "path", "description": "The ID of the `Modifier`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Product Modifier*." }, { "info": { "name": "BigCommerce Delete a Product Modifier", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/modifiers/:modifier_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" }, { "name": "modifier_id", "value": "", "type": "path", "description": "The ID of the `Modifier`.\n" } ] }, "docs": "Deletes a *Product Modifier*." } ] } ], "bundled": true }