{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Batch Metafields API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Batch Metafields", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get All Cart Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key." }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter" }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all cart metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all cart metafields." }, { "info": { "name": "BigCommerce Get All Brand Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key." }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all brand metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all brand metafields." }, { "info": { "name": "BigCommerce Get All Category Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key." }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all category metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all category metafields." }, { "info": { "name": "BigCommerce Get All Product Variant Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/variants/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key." }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all variant metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/variants/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/variants/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/variants/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all variant metafields." }, { "info": { "name": "BigCommerce Get All Product Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key." }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all product metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all product metafields." }, { "info": { "name": "BigCommerce Get All Channel Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`." } ] }, "docs": "Get all channel metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all channel metafields." }, { "info": { "name": "BigCommerce Get All Order Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafields", "params": [ { "name": "page", "value": "", "type": "query", "description": "Specifies the page number in a limited (paginated) list of products.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Controls the number of items per page in a limited (paginated) list of products.\n" }, { "name": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "key:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter." }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "namespace:in", "value": "", "type": "query", "description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get all order metafields." }, { "info": { "name": "BigCommerce Create multiple Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Update multiple Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple metafields." }, { "info": { "name": "BigCommerce Delete All Metafields", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/metafields", "body": { "type": "json", "data": "{}" } }, "docs": "Delete all order metafields." } ] } ], "bundled": true }