BigCommerce Metafields API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Metafields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
35 operations
across 14 paths,
and defines 31 schemas.
It is described by OpenAPI 3.0.0, at version 3.0.0.
Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.
35 operations14 paths31 schemas7 DELETE14 GET7 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
BigCommerce Metafields API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Auth-Token (X-Auth-Token).
By default, every request must be authenticated.
X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…
Paths & Operations 35
Across 14 paths, the API surfaces 35 operations — 7 DELETE, 14 GET, 7 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are MetafieldBase_2 (7 properties), MetafieldBase (7 properties), pagination_Full (6 properties), MetafieldBase_Post_2 (5 properties). Each schema is shown below with its type and property counts.
metaEmpty_Full
object
Response metadata.
CollectionMeta_2
object
Data about the response, including pagination and collection totals.
1 property
Meta
object
1 property
ErrorResponse
object
5 properties
MetaFieldCollectionResponse_2
object
Response payload for the BigCommerce API.
2 properties
metafield_Post
object
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand is 250. For more in…
5 properties4 required
pagination_Full
object
Data about the response, including pagination and collection totals.
6 properties
Metafield
Allows app partners to write custom data to various resources in the API.
MetafieldBase_Put
object
Common Metafield properties.
5 properties
metaCollection_Full
object
Data about the response, including pagination and collection totals.
1 property
ErrorResponse_2
MetafieldBase_2
object
Common Metafield properties.
7 properties1 required
MetafieldBase
object
Common Metafield properties.
7 properties1 required
metafield_Put
object
Metafield for products, categories, variants, and brands. The max number of metafields allowed on each product, category, variant, or brand 250. For more infor…
5 properties
CollectionMeta
object
Data about the response, including pagination and collection totals.
1 property
metafield_Base_3
object
Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits](https…
5 properties4 required
Metafield_2
Allows app partners to write custom data to various resources in the API.
categoriesTreeNode_Full
object
Used to reflect parent < child category relationships. Used by Category Tree.
5 properties
metafield_Base_4
object
Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 250. For more information, see [Platform Limits](http…
5 properties4 required
MetafieldBase_Post
object
Common Metafield properties.
5 properties4 required
metafield_Full
MetafieldResponse_2
Response payload for the BigCommerce API.
metafield_Base_2
object
Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits (Help…
5 properties4 required
categoriesTree_Resp
object
Returns the categories tree, a nested lineage of the categories with parent-child relationship. The Category objects returned are simplified versions of the ca…
2 properties
MetafieldPut
The model for a PUT to update metafield.
MetafieldBase_Post_2
object
Common Metafield properties.
5 properties4 required
NotFound
object
Error payload for the BigCommerce API.
4 properties
MetafieldResponse
Response payload for the BigCommerce API.
error_Base
object
Error payload for the BigCommerce API.
3 properties
metafield_Base
object
Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 50. For more information, see [Platform Limits](https…
5 properties4 required
MetaFieldCollectionResponse
object
Response payload for the BigCommerce API.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of BigCommerce Metafields API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
