{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Scripts API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Scripts", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get All Scripts", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "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": "sort", "value": "", "type": "query", "description": "Field name to sort the scripts by. Note: Since `id` increments when new scripts are added, you can use that field to sort by script create date.\n" }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" }, { "name": "channel_id:in", "value": "", "type": "query", "description": "Filters list of scripts by the associated channel_id." } ] }, "docs": "Returns a list of *Scripts*. Optional parameters can be passed in.\n\nThis operation will only return scripts generated by the API key and password used to create the script originally. " }, { "info": { "name": "BigCommerce Create a Script", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a *Script*.\n\n**Required Fields**\n* name\n\n**Read Only Fields**\n* uuid\n\n**Limits**\n* 50 scripts per channel.\n\n**Notes**\n* If the `kind` is `src`:\n * Specify the `src` property. \n * Optionally, you can supply a `load_method`. \n * Do not specify the `html` field.\n* If the `kind` is `script_tag`:\n * Specify the `html` property.\n * Do not specify the `src` field.\n* Each app can have 10 scripts installed.\n* Multiple scripts can be created [per call](/docs/integrations/scripts#notes). " }, { "info": { "name": "BigCommerce Get a Script", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/:uuid", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The identifier for a specific script." } ] }, "docs": "Returns a single *Script*." }, { "info": { "name": "BigCommerce Update a Script", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/:uuid", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The identifier for a specific script." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Script*." }, { "info": { "name": "BigCommerce Delete a Script", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/content/scripts/:uuid", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "uuid", "value": "", "type": "path", "description": "The identifier for a specific script." } ] }, "docs": "Deletes a *Script*." } ] } ], "bundled": true }