{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Metafields API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Metafields", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get Cart Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/:cart_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "cart_id", "value": "", "type": "path", "description": "The ID of the `Cart` to which the transactions belong." }, { "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": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Get a cart's metafields." }, { "info": { "name": "BigCommerce Create a Cart Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/:cart_id/metafields", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "cart_id", "value": "", "type": "path", "description": "The ID of the `Cart` to which the transactions belong." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a cart `Metafield`. \n\nIf you create an order from a Cart, you can continue referencing the Cart Metafields even if you delete the original Cart. Use the `cart_id` field on the Order to construct the Cart Metafield endpoint. \n" }, { "info": { "name": "BigCommerce Get a Cart Metafield", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/:cart_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "cart_id", "value": "", "type": "path", "description": "The ID of the `Cart` to which the transactions belong." }, { "name": "metafield_id", "value": "", "type": "path", "description": "The unique ID of the subject `Metafield`." }, { "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": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespaces." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Gets a cart metafield." }, { "info": { "name": "BigCommerce Update a Cart Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/:cart_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "cart_id", "value": "", "type": "path", "description": "The ID of the `Cart` to which the transactions belong." }, { "name": "metafield_id", "value": "", "type": "path", "description": "The unique ID of the subject `Metafield`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a `Metafield`, by `cart_id`.\n" }, { "info": { "name": "BigCommerce Delete a Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/carts/:cart_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "cart_id", "value": "", "type": "path", "description": "The ID of the `Cart` to which the transactions belong." }, { "name": "metafield_id", "value": "", "type": "path", "description": "The unique ID of the subject `Metafield`." } ] }, "docs": "Deletes a `Metafield`.\n" }, { "info": { "name": "BigCommerce Get Brand Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/:brand_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "brand_id", "value": "", "type": "path", "description": "The ID of the `Brand` to which the resource belongs.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter items by ID.\n" }, { "name": "id:in", "value": "", "type": "query" }, { "name": "id:not_in", "value": "", "type": "query" }, { "name": "id:min", "value": "", "type": "query" }, { "name": "id:max", "value": "", "type": "query" }, { "name": "id:greater", "value": "", "type": "query" }, { "name": "id:less", "value": "", "type": "query" }, { "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": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "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 *Brand Metafields*. Optional filter parameters can be passed in. " }, { "info": { "name": "BigCommerce Create a Brand Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/:brand_id/metafields", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "brand_id", "value": "", "type": "path", "description": "The ID of the `Brand` to which the resource belongs.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a *Brand Metafield*.\n\n**Required Fields**\n- permission_set\n- namespace\n- key\n- value\n\n**Read-Only Fields**\n- id\n\n**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center." }, { "info": { "name": "BigCommerce Get a Brand Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/:brand_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "brand_id", "value": "", "type": "path", "description": "The ID of the `Brand` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\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 *Brand Metafield*. Optional filter parameters can be passed in." }, { "info": { "name": "BigCommerce Update a Brand Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/:brand_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "brand_id", "value": "", "type": "path", "description": "The ID of the `Brand` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Brand Metafield*.\n\n**Required Fields** \n* none\n\n**Read-Only Fields**\n* id\n* These fields can only be modified by the app (API credentials) that created the metafield:\n\t* namespace\n\t* key\n\t* permission_set\n\n**Usage Notes**\n* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message.\n* The maxiumum number of metafields allowed on each order, product, category, variant," }, { "info": { "name": "BigCommerce Delete a Brand Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/:brand_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "brand_id", "value": "", "type": "path", "description": "The ID of the `Brand` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Deletes a *Brand Metafield*." }, { "info": { "name": "BigCommerce Get Category Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/:category_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "path", "description": "The ID of the `Category` to which the resource belongs.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter items by ID.\n" }, { "name": "id:in", "value": "", "type": "query" }, { "name": "id:not_in", "value": "", "type": "query" }, { "name": "id:min", "value": "", "type": "query" }, { "name": "id:max", "value": "", "type": "query" }, { "name": "id:greater", "value": "", "type": "query" }, { "name": "id:less", "value": "", "type": "query" }, { "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": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "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 *Metafields* on a *Category*. Optional filter parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Category Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/:category_id/metafields", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "path", "description": "The ID of the `Category` to which the resource belongs.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a *Category Metafield*.\n\n**Required Fields:**\n- permission_set\n- namespace\n- key\n- value\n\n**Read-Only Fields**\n- id\n\n**Note:** The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits (Help Center)](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center." }, { "info": { "name": "BigCommerce Get a Category Metafield", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/:category_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "path", "description": "The ID of the `Category` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\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 *Category Metafield*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Update a Category Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/:category_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "path", "description": "The ID of the `Category` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Category Metafield*.\n\n**Required Fields**\n* none\n\n**Read-Only Fields**\n* id\n* These fields can only be modified by the app (API credentials) that created the metafield:\n\t* namespace\n\t* key\n\t* permission_set\n\n**Usage Notes**\n* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message. " }, { "info": { "name": "BigCommerce Delete a Category Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories/:category_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "category_id", "value": "", "type": "path", "description": "The ID of the `Category` to which the resource belongs.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Deletes a *Category Metafield*." }, { "info": { "name": "BigCommerce Get Product Variant Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n" }, { "name": "variant_id", "value": "", "type": "path", "description": "ID of the variant on a product, or on an associated Price List Record.\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": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "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 product variant *Metafields*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Product Variant Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id/metafields", "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. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n" }, { "name": "variant_id", "value": "", "type": "path", "description": "ID of the variant on a product, or on an associated Price List Record.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a product variant *Metafield*.\n\n**Required Fields:**\n* permission_set\n* namespace\n* key\n* value\n\n**Read-Only Fields**\n* id\n\n**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center." }, { "info": { "name": "BigCommerce Get a Product Variant Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n" }, { "name": "variant_id", "value": "", "type": "path", "description": "ID of the variant on a product, or on an associated Price List Record.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\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 variant *Metafield*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Update Product Variant Metafields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id/metafields/:metafield_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. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n" }, { "name": "variant_id", "value": "", "type": "path", "description": "ID of the variant on a product, or on an associated Price List Record.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a product variant *Metafield*.\n\n**Required Fields:**\n* none\n\n**Read-Only Fields**\n* id\n* These fields can only be modified by the app (API credentials) that created the metafield:\n\t* namespace\n\t* key\n\t* permission_set\n\n**Usage Notes**\n* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message. " }, { "info": { "name": "BigCommerce Delete a Product Variant Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n" }, { "name": "variant_id", "value": "", "type": "path", "description": "ID of the variant on a product, or on an associated Price List Record.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Deletes a product variant *Metafield*." }, { "info": { "name": "BigCommerce Get Product Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/metafields", "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": "key", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "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 *Product Metafields*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Product Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/metafields", "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 Metafield*.\n\n**Required Fields:**\n* permission_set\n* namespace\n* key\n* value\n\n**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center." }, { "info": { "name": "BigCommerce Get a Product Metafield", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/metafields/:metafield_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": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\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 Metafield*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Update a Product Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/metafields/:metafield_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": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Product Metafield*.\n\n**Required Fields**\n* none\n\n**Read-Only Fields**\n* id\n* These fields can only be modified using the API account that created the metafield:\n\t* `namespace`\n\t* `key`\n\t* `permission_set`\n\t* `value`\n\n**Usage Notes**\n* Attempting to modify the `namespace`, `key`, `permission_set`, or `value` field using an API account different from the one used to create those metafields will result in a `403` error message. " }, { "info": { "name": "BigCommerce Delete a Product Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/metafields/:metafield_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": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Deletes a *Product Metafield*." }, { "info": { "name": "BigCommerce Get Channel Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of a channel." }, { "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": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs namespace." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`." } ] }, "docs": "Returns a list of metafields on a channel. Optional filter parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Channel Metafield", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id/metafields", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of a channel." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a channel metafield.\n\n**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, channel, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center." }, { "info": { "name": "BigCommerce Get a Channel Metafield", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of a channel." }, { "name": "metafield_id", "value": "", "type": "path" } ] }, "docs": "Returns a single channel metafield." }, { "info": { "name": "BigCommerce Update a Channel Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of a channel." }, { "name": "metafield_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a single channel metafield.\n\n**Usage Notes**\n* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a `403` error message. " }, { "info": { "name": "BigCommerce Delete a Channel Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of a channel." }, { "name": "metafield_id", "value": "", "type": "path" } ] }, "docs": "Deletes a single channel metafield." }, { "info": { "name": "BigCommerce Get Order Metafields", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/:order_id/metafields", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the `Order` to which the transactions belong.\n" }, { "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": "namespace", "value": "", "type": "query", "description": "Filter based on a metafieldʼs key.\n" }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" } ] }, "docs": "Gets a `Metafield` object list, by `order_id`.\n\nThe maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID.\n" }, { "info": { "name": "BigCommerce Create Metafields", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/:order_id/metafields", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the `Order` to which the transactions belong.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an order `Metafield`.\n\nThe maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID." }, { "info": { "name": "BigCommerce Get a Metafield", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/:order_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the `Order` to which the transactions belong.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Gets a `Metafield`, by `order_id`.\n" }, { "info": { "name": "BigCommerce Update a Metafield", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/:order_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the `Order` to which the transactions belong.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a `Metafield` object.\n\nThe maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID." }, { "info": { "name": "BigCommerce Delete a Metafield", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/orders/:order_id/metafields/:metafield_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the `Order` to which the transactions belong.\n" }, { "name": "metafield_id", "value": "", "type": "path", "description": "The ID of the `Metafield`.\n" } ] }, "docs": "Deletes a `Metafield`.\n" } ] } ], "bundled": true }