BigCommerce Docs

curl https://api.bigcommerce.com/stores/store_hash/v3/customers/1/metafields \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "app_only",
      "value": "4HG",
      "date_created": "2018-05-07T20:14:17+00:00",
      "date_modified": "2018-05-07T20:14:17+00:00",
      "description": "Location in the warehouse",
      "id": 6,
      "resource_id": 111,
      "resource_type": "customer"
    }
  ],
  "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"
      }
    }
  }
}

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

curl https://api.bigcommerce.com/stores/store_hash/v3/customers/1/metafields \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "app_only",
      "value": "4HG",
      "date_created": "2018-05-07T20:14:17+00:00",
      "date_modified": "2018-05-07T20:14:17+00:00",
      "description": "Location in the warehouse",
      "id": 6,
      "resource_id": 111,
      "resource_type": "customer"
    }
  ],
  "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"
      }
    }
  }
}

UI Name

Permission

Parameter

Customers

modify

store_v2_customers

Customers

read-only

store_v2_customers_read_only

Stored Payment Instruments

modify

store_stored_payment_instruments

Stored Payment Instruments

read-only

store_stored_payment_instruments_read_only

Header

Argument

Description

X-Auth-Token

access_token

For more about API accounts that generate access_tokens, see our Guide to API Accounts.

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

List Customer Metafields

List Customer Metafields

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Response

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Response

$	curl https://api.bigcommerce.com/stores/store_hash/v3/customers/1/metafields \
>	-H "X-Auth-Token: <apiKey>"

1	{
2	"data": [
3	{
4	"key": "Location",
5	"namespace": "Warehouse Locations",
6	"permission_set": "app_only",
7	"value": "4HG",
8	"date_created": "2018-05-07T20:14:17+00:00",
9	"date_modified": "2018-05-07T20:14:17+00:00",
10	"description": "Location in the warehouse",
11	"id": 6,
12	"resource_id": 111,
13	"resource_type": "customer"
14	}
15	],
16	"meta": {
17	"pagination": {
18	"total": 36,
19	"count": 36,
20	"per_page": 50,
21	"current_page": 1,
22	"total_pages": 1,
23	"links": {
24	"previous": "string",
25	"current": "?page=1&limit=50",
26	"next": "string"
27	}
28	}
29	}
30	}