Docs
Catalog API
Products
Batch Metafields

Batch metafields

Get All Product Metafields

GET /catalog/products/metafields

Request

Get all product metafields.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

List of Metafield objects.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create multiple Metafields

POST /catalog/products/metafields

Request

Create multiple metafields.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

array | application/json

example

Response

List of created Metafield objects.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • errors    array[]

    Empty for 200 responses.

    Example: []

  • meta    object

    Data about the response, including pagination and collection totals.

example

Update multiple Metafields

PUT /catalog/products/metafields

Request

Update multiple metafields.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

array | application/json

example

Response

List of updated Metafield objects.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • errors    array[]

    Empty for 200 responses.

    Example: []

  • meta    object

    Data about the response, including pagination and collection totals.

example

Delete Multiple Metafields

DELETE /catalog/products/metafields

Request

Delete all product metafields.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

List of metafield IDs.

Body

array | application/json

    example

    Response

    Response object for metafields deletion with success.

    Body

    object | application/json

    Response payload for the BigCommerce API.

    • data      array[integer]

      Type: array[integer]
      Example: [123,124,125]

    • errors      array[]

      Empty for 200 responses.

      Example: []

    • meta      object

      Additional data about the response.

    example

    Did you find what you were looking for?
    Delete a ProductGet All Product Metafields