Docs
Management API
Customers V3
Metafields

Metafields

Get Customer Metafields

GET /customers/{customerId}/metafields

Request

Gets customer metafields by passing the customerId in the query parameters.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required
    The ID of the customer.

example

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

Response

Response payload for the BigCommerce API.

Body

object | application/json

  • items    object

example

{
"items": {
"key": "Staff Name",
"value": "Ronaldo",
"namespace": "Sales Department",
"permission_set": "app_only",
"resource_type": "cart",
"description": "order",
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
}

Create Customer Metafields

POST /customers/{customerId}/metafields

Request

Creates Customer metafields by passing the customerId in the query parameters.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required
    The ID of the customer.

Body

object | application/json

Common Metafield properties.

  • 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

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

    Data about the response, including pagination and collection totals.

example

{
"data": [
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "order",
"resource_type": "cart",
"id": 0,
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
],
"errors": [],
"meta": {
"pagination": {
"total": 36,
"count": 36,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {
"previous": "string",
"current": "?page=1&limit=50",
"next": "string"
}
}
}

Get a Customer Metafield

GET /customers/{customerId}/metafields/{metafieldId}

Request

Lists available metafields for a customer. To retrieve the list, use customerId and metafieldId in the query parameters.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required
    The ID that belongs to the customer.
  • metafieldId in path - integer
    required
    The ID that is generated for a metafield when created.

example

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

Response

Response payload for the BigCommerce API.

Body

object | application/json

  • items    object

example

{
"items": {
"key": "Staff Name",
"value": "Ronaldo",
"namespace": "Sales Department",
"permission_set": "app_only",
"resource_type": "cart",
"description": "order",
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
}

Update a Metafield

PUT /customers/{customerId}/metafields/{metafieldId}

Request

Updates customer metafields. To update the customer metafields, use 'customerId' and 'metafield' in the query parameters.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • metafieldId in path - integer
    required
    The ID of the metafield belonging to the customer. The metafieldId is a generated response when sending a POST query to the Create a Customer Metafields endpoint.
  • customerId in path - integer
    required
    The ID of the customer.

Body

object | application/json

Common Metafield properties.

  • permission_set    string

    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

    Namespace for the metafield, for organizational purposes.

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

  • key    string

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

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

  • value    string

    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

    Data about the response, including pagination and collection totals.

example

{
"data": [
{
"permission_set": "app_only",
"namespace": "Sales Department",
"key": "Staff Name",
"value": "Ronaldo",
"description": "order",
"resource_type": "cart",
"id": 0,
"date_created": "2022-06-16T18:39:00+00:00",
"date_modified": "2022-06-16T18:39:00+00:00"
}
],
"errors": [],
"meta": {
"pagination": {
"total": 36,
"count": 36,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {
"previous": "string",
"current": "?page=1&limit=50",
"next": "string"
}
}
}

Delete a Customer Metafield

DELETE /customers/{customerId}/metafields/{metafieldId}

Request

Deletes a customer metafield. To delete a customer metafield, use 'customerId' and 'metafieldId' in the query parameters.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required
    The ID of the customer.
  • metafieldId in path - integer
    required
    The ID of the metafield belonging to the customer. The metafieldId is a generated response when sending a POST query to the Create a Customer Metafields endpoint.

example

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

Response

Response object for customer metafields deletion with success.

Did you find what you were looking for?
Update Customer SettingsGet Customer Metafields