For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
        • Checkouts
        • Currencies
        • Customer Segmentation
        • Geography
        • Infrastructure Hosting
        • Inventory
              • POSTCreate Locations
              • GETList Locations
              • PUTUpdate Locations
              • DELDelete Locations
                • GETList Metafields
                • POSTCreate Metafield
                • GETGet Metafield
                • PUTUpdate Metafield
                • DELDelete Metafield
        • Orders
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminManagementInventoryLocationsMetafields

Get Metafield

GET
https://api.bigcommerce.com/stores/:store_hash/v3/inventory/locations/:location_id/metafields/:metafield_id
GET
/stores/:store_hash/v3/inventory/locations/:location_id/metafields/:metafield_id
$curl https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations/1/metafields/1 \
>     -H "Accept: application/json" \
>     -H "X-Auth-Token: <apiKey>"
1{
2  "data": {
3    "id": 1,
4    "key": "status",
5    "value": "upcoming",
6    "namespace": "headquarters",
7    "permission_set": "app_only",
8    "description": "string",
9    "resource_type": "location",
10    "resource_id": 1,
11    "date_created": "2022-04-14T23:06:45+00:00",
12    "date_modified": "2022-09-08T04:18:55+00:00",
13    "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf"
14  },
15  "meta": {}
16}
Get a metafield by location.
Was this page helpful?
Previous

Create Metafield

Next

Update Metafield

Built with

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Store Inventoryread-onlystore_inventory_read_only
Store Inventorymodifystore_inventory

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see API Accounts and OAuth Scopes.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.

For a list of API status codes, see API Status Codes.

Path parameters

location_idintegerRequired
Unique identifier for a location.
metafield_idintegerRequired
Unique identifier for a metafield.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Response

The request has been successfully processed.
dataobject
Allows app partners to write custom data to various resources in the API.
metaobject

Errors

404
Not Found Error

The MIME type of the response body.