List Metafields

GET

https://api.bigcommerce.com/stores/:store_hash/v3/inventory/locations/metafields

GET

/stores/:store_hash/v3/inventory/locations/metafields

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

200Batch metafields_getLocationsMetafields_example

{
  "data": [
    {
      "id": 1024,
      "key": "store_hours",
      "value": "Mon-Fri 9am-9pm, Sat-Sun 10am-6pm",
      "namespace": "store_info",
      "permission_set": "read",
      "description": "Regular operating hours for the downtown location",
      "resource_type": "location",
      "resource_id": 15,
      "date_created": "2023-11-01T08:30:00+00:00",
      "date_modified": "2024-05-20T16:45:00+00:00",
      "owner_client_id": "a1b2c3d4e5f6g7h8i9j0klmnopqrstuv"
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "current": "?page=1&limit=50"
      }
    }
  }
}

Get all location metafields.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Inventory	read-only	`store_inventory_read_only`
Store Inventory	modify	`store_inventory`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

pageintegerOptional

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

limitintegerOptional

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

keystringOptional

Filter based on a metafieldʼs key.

key:inlist of stringsOptional

Filter based on comma-separated metafieldʼs keys. Could be used with vanilla ‘key’ query parameter.

namespacestringOptional

Filter based on a metafieldʼs namespaces.

namespace:inlist of stringsOptional

Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla ‘namespace’ query parameter.

directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

include_fieldslist of enumsOptional

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

date_modified:minstringOptional

‘Query parameter that lets you filter by the minimum date modified, for example, 2024-05-14T09:34:00, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields modified after this date.’

date_modified:maxstringOptional

‘Query parameter that lets you filter by the maximum date modified, for example, 2024-05-14T09:34:00, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields modified before this date.’

date_created:minstringOptional

‘Query parameter that lets you filter by the minimum date created, for example, 2024-05-14T09:34:00, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields created after this date.’

date_created:maxstringOptional

‘Query parameter that lets you filter by the maximum date created, for example, 2024-05-14T09:34:00, 2024-05-14T09:34:00 or 2024-05-14. Returns metafields created before this date.’

Response

List of Metafield objects.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.