Docs
Management API
Store information
Batch Metafields

Batch metafields

Get All Store Metafields

GET /store/metafields

Request

Gets all store metafields.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list of products.

  • key in query - string
    Filter based on a metafieldʼs key.
  • key:in in query - array
    Filter based on comma-separated metafieldʼs keys. Could be used with vanilla key query parameter.
    Type: array[string]
  • namespace in query - string
    Filter based on a metafieldʼs namespaces.
  • namespace:in in query - array
    Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla namespace query parameter
    Type: array[string]
  • direction in query - string

    Sort direction. Acceptable values are: asc, desc.

    Allowed: asc | desc

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/store/metafields' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

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.

response

{
"data": [
{
"id": "69",
"key": "key2",
"value": "value",
"namespace": "test2",
"permission_set": "write_and_sf_access",
"resource_type": "store",
"resource_id": "1001197568",
"description": "",
"date_created": "2024-08-27T18:58:43+00:00",
"date_modified": "2024-08-27T18:58:43+00:00",
"owner_client_id": "k8l7zz0ynkd1bfbxx02p2k7pnk3n8ov"
}
],
"meta": {
"pagination": {
"total": 4,
"count": 4,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {
"current": "?limit=50&page=1"
}
}
}

Create multiple Metafields

POST /store/metafields

Request

Create multiple metafields.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
A metafield object.

Body

array | application/json

  • permission_set    string
    required

    Determines the visibility and writeability of the field by other API consumers.

    ValueDescription
    app_onlyPrivate to the app that owns the field.
    readVisible to other API consumers.
    writeOpen for reading and writing by other API consumers.
    read_and_sf_accessVisible to other API consumers, including on the storefront.
    write_and_sf_accessOpen for reading and writing by other API consumers, including on the storefront.

    Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

  • namespace    string
    required

    Namespace for the metafield, for organizational purposes.

    >= 1 characters<= 64 characters
    Example: Sales Department

  • key    string
    required

    The name of the field, for example: location_id, color.

    >= 1 characters<= 64 characters
    Example: Staff Name

  • value    string
    required

    The value of the field, for example: 1, blue.

    >= 1 characters<= 65535 characters
    Example: Ronaldo

  • description    string

    Description for the metafields.

    >= 0 characters<= 255 characters
    Example: Name of Staff Member

example

[
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "Name of Staff Member"
}
]

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

    Additional data about the response.

example

{
"data": [
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "order",
"resource_type": "store",
"id": "string",
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
],
"errors": [],
"meta": {
"total": 3,
"success": 3,
"failed": 0
}
}

Update multiple metafields

PUT /store/metafields

Request

Update multiple metafields.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string

Body

array | application/json

  • permission_set    string
    required

    Determines the visibility and writeability of the field by other API consumers.

    ValueDescription
    app_onlyPrivate to the app that owns the field.
    readVisible to other API consumers.
    writeOpen for reading and writing by other API consumers.
    read_and_sf_accessVisible to other API consumers, including on the storefront.
    write_and_sf_accessOpen for reading and writing by other API consumers, including on the storefront.

    Allowed: app_only | read | write | read_and_sf_access | write_and_sf_access

  • namespace    string
    required

    Namespace for the metafield, for organizational purposes.

    >= 1 characters<= 64 characters
    Example: Sales Department

  • key    string
    required

    The name of the field, for example: location_id, color.

    >= 1 characters<= 64 characters
    Example: Staff Name

  • value    string
    required

    The value of the field, for example: 1, blue.

    >= 1 characters<= 65535 characters
    Example: Ronaldo

  • description    string

    Description for the metafields.

    >= 0 characters<= 255 characters
    Example: Name of Staff Member

  • id    integer
    required

    The ID of metafield to update.

    Example: 42

example

[
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "Name of Staff Member",
"id": 42
}
]

Response

Response payload for the BigCommerce API.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • errors    array[]

    Empty for 200 responses.
    Example: []

  • meta    object

    Additional data about the response.

example

{
"data": [
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "order",
"resource_type": "store",
"id": "string",
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
],
"errors": [],
"meta": {
"total": 3,
"success": 3,
"failed": 0
}
}

Delete multiple metafields

DELETE /store/metafields

Request

Delete all store metafields.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
Metafields ID list.

Body

array | application/json

    example

    curl --request DELETE \
    --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/store/metafields' \
    --header 'Content-Type: application/json' \
    --header 'X-Auth-Token: {{token}}'

    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

    {
    "data": [
    123,
    124,
    125
    ],
    "errors": [],
    "meta": {
    "total": 3,
    "success": 3,
    "failed": 0
    }
    }
    Did you find what you were looking for?
    Get System TimestampGet All Store Metafields