How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Batch Metafields API

The Batch Metafields API from BigCommerce — 7 operation(s) for batch metafields.

BigCommerce Batch 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 Batch Metafields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 28 operations across 7 paths, and defines 37 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.

28 operations 7 paths 37 schemas 7 DELETE7 GET7 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Batch 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 28

Across 7 paths, the API surfaces 28 operations — 7 DELETE, 7 GET, 7 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Batch Metafields 28
GET
/carts/metafields
BigCommerce Get All Cart Metafields
getCartsMetafields 7 params → 200500
POST
/carts/metafields
BigCommerce Create multiple Metafields
createCartsMetafields body → 200422500
PUT
/carts/metafields
BigCommerce Update multiple Metafields
updateCartsMetafields body → 200422500
DELETE
/carts/metafields
BigCommerce Delete All Metafields
deleteCartsMetafields body → 200422
GET
/catalog/brands/metafields
BigCommerce Get All Brand Metafields
getBrandsMetafields 7 params → 200500
POST
/catalog/brands/metafields
BigCommerce Create multiple Metafields
createBrandsMetafields body → 200422500
PUT
/catalog/brands/metafields
BigCommerce Update multiple Metafields
updateBrandsMetafields body → 200422500
DELETE
/catalog/brands/metafields
BigCommerce Delete All Metafields
deleteBrandsMetafields body → 200422
GET
/catalog/categories/metafields
BigCommerce Get All Category Metafields
getCategoriesMetafields 7 params → 200500
POST
/catalog/categories/metafields
BigCommerce Create multiple Metafields
createCategoriesMetafields body → 200422500
PUT
/catalog/categories/metafields
BigCommerce Update multiple Metafields
updateCategoriesMetafields body → 200422500
DELETE
/catalog/categories/metafields
BigCommerce Delete All Metafields
deleteCategoriesMetafields body → 200422
GET
/catalog/variants/metafields
BigCommerce Get All Product Variant Metafields
getVariantsMetafields 7 params → 200500
POST
/catalog/variants/metafields
BigCommerce Create multiple Metafields
createVariantsMetafields body → 200422500
PUT
/catalog/variants/metafields
BigCommerce Update multiple Metafields
updateVariantsMetafields body → 200422500
DELETE
/catalog/variants/metafields
BigCommerce Delete All Metafields
deleteVariantsMetafields body → 200422
GET
/catalog/products/metafields
BigCommerce Get All Product Metafields
getProductsMetafields 7 params → 200500
POST
/catalog/products/metafields
BigCommerce Create multiple Metafields
createProductsMetafields body → 200422500
PUT
/catalog/products/metafields
BigCommerce Update multiple Metafields
updateProductsMetafields body → 200422500
DELETE
/catalog/products/metafields
BigCommerce Delete All Metafields
deleteProductsMetafields body → 200422
GET
/channels/metafields
BigCommerce Get All Channel Metafields
getChannelsMetafields 7 params → 200500
POST
/channels/metafields
BigCommerce Create multiple Metafields
createChannelsMetafields body → 200422500
PUT
/channels/metafields
BigCommerce Update multiple Metafields
updateChannelsMetafields body → 200422500
DELETE
/channels/metafields
BigCommerce Delete All Metafields
deleteChannelsMetafields body → 200422
GET
/orders/metafields
BigCommerce Get All Order Metafields
getOrdersMetafields 7 params → 200500
POST
/orders/metafields
BigCommerce Create multiple Metafields
createOrdersMetafields body → 200422500
PUT
/orders/metafields
BigCommerce Update multiple Metafields
updateOrdersMetafields body → 200422500
DELETE
/orders/metafields
BigCommerce Delete All Metafields
deleteOrdersMetafields body → 200422

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Metafield_4 (11 properties), Metafield_6 (11 properties), Metafield_3 (11 properties), Metafield_2 (11 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
Error detail response payload for the BigCommerce API.
CollectionMeta_2
object
Data about the response, including pagination and collection totals.
1 property
Error
object
Error response payload for the BigCommerce API.
4 properties
MetaFieldCollectionResponse_POST_PUT_3
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse_POST_PUT_6
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse_2
object
Response payload for the BigCommerce API.
2 properties
MetafieldPost
The model for a POST to create metafield.
Metafield
Allows app partners to write custom data to various resources in the API.
MetafieldBase_Put
object
Common Metafield properties.
5 properties
Metafield_7
Allows app partners to write custom data to various resources in the API.
MetaFieldCollectionResponse_POST_PUT_5
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse_POST_PUT_4
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse_POST_PUT_2
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponsePartialSuccess_POST_PUT
object
Response payload for the BigCommerce API.
3 properties
WriteCollectionPartialSuccessMeta
object
Additional data about the response.
3 properties
MetafieldBase_2
object
Common Metafield properties.
7 properties 1 required
MetafieldBase
object
Common Metafield properties.
7 properties 1 required
CollectionMeta
object
Data about the response, including pagination and collection totals.
1 property
MetafieldBase_Post
object
Common Metafield properties.
5 properties 4 required
Metafield_2
object
Common Metafield properties.
11 properties 10 required
MetaFieldCollectionResponse_Batch
object
Response payload for the BigCommerce API.
2 properties
Metafield_5
object
Common Metafield properties.
11 properties 10 required
MetaFieldCollectionResponsePartialSuccess_DELETE
object
Response payload for the BigCommerce API.
3 properties
Metafield_3
object
Common Metafield properties.
11 properties 10 required
WriteCollectionSuccessMeta
object
Additional data about the response.
3 properties
MetaFieldCollectionResponse_POST_PUT
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse_5
object
Response payload for the BigCommerce API.
2 properties
MetaFieldCollectionResponse_4
object
Response payload for the BigCommerce API.
2 properties
MetaFieldCollectionResponse_Batch_POST_PUT
object
Response payload for the BigCommerce API.
3 properties
Metafield_6
object
Common Metafield properties.
11 properties 10 required
MetaFieldCollectionResponse_3
object
Response payload for the BigCommerce API.
2 properties
MetafieldBase_Post_2
object
Common Metafield properties.
5 properties 4 required
MetafieldPut
The model for a PUT to create metafield.
MetaFieldCollectionResponse_6
object
Response payload for the BigCommerce API.
2 properties
MetaFieldCollectionDeleteResponseSuccess
object
Response payload for the BigCommerce API.
3 properties
Metafield_4
object
Common Metafield properties.
11 properties 10 required
MetaFieldCollectionResponse
object
Response payload for the BigCommerce API.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-batch-metafields-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Batch 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.