{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Custom Template Associations API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Custom Template Associations", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get Custom Template Associations", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/custom-template-associations", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "query", "description": "Channel ID to return only custom template associations for a given Channel" }, { "name": "entity_id:in", "value": "", "type": "query", "description": "Filter by a list of entity IDs. Must be used together with \"type\" filter." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page" }, { "name": "page", "value": "", "type": "query", "description": "Which page number to return, based on the page size. Used to paginate large collections." }, { "name": "type", "value": "", "type": "query", "description": "Filter associations by type" }, { "name": "is_valid", "value": "", "type": "query", "description": "Optional toggle to filter for exclusively valid or invalid associations entries. An invalid entry is one where its file name does not match up to an existing custom layout file in the currently active theme for the channel." } ] }, "docs": "Get a collection of the storeʼs custom template associations across all storefronts" }, { "info": { "name": "BigCommerce Upsert Custom Template Associations", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/custom-template-associations", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert new custom template associations data across all storefronts. If an existing record is found for the combination of channel ID, entity ID, and type, the existing record will be overwritten with the new template." }, { "info": { "name": "BigCommerce Delete Custom Template Associations", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/custom-template-associations", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id:in", "value": "", "type": "query", "description": "List of Association IDs to delete explicitly." }, { "name": "entity_id:in", "value": "", "type": "query", "description": "List of Entity IDs to delete explicitly. Must be used together with \"type\"" }, { "name": "channel_id", "value": "", "type": "query", "description": "Channel ID provided to delete all custom template associations for a given Channel" }, { "name": "type", "value": "", "type": "query", "description": "Filter associations by type" } ] }, "docs": "Delete custom template associations. At least one query parameter must be used." } ] } ], "bundled": true }