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 Customer Batch Metafields API

The Customer Batch Metafields API from BigCommerce — 1 operation(s) for customer batch metafields.

BigCommerce Customer 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 Customer 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 4 operations across 1 path, and defines 13 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.

4 operations 1 paths 13 schemas 1 DELETE1 GET1 POST1 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 Customer 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 4

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

Customer Batch Metafields 4
GET
/customers/metafields
BigCommerce Get All Customer Metafields
getallCustomersMetafields 7 params → 200500
POST
/customers/metafields
BigCommerce Create Multiple Metafields
createCustomersMetafields body → 200422500
PUT
/customers/metafields
BigCommerce Update Multiple Metafields
updateCustomersMetafields body → 200422500
DELETE
/customers/metafields
BigCommerce Delete All Metafields
deleteCustomersMetafields body → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Metafield (11 properties), MetafieldBase_Post (5 properties), MetafieldBase_Put (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
Error detail response payload for the BigCommerce API.
Error
object
Error response payload for the BigCommerce API.
4 properties
Metafield
object
Common metafield properties.
11 properties 10 required
MetafieldBase_Put
object
Common Metafield properties.
5 properties
MetaFieldCollectionResponsePartialSuccess_POST_PUT
object
Response payload for the BigCommerce API.
3 properties
WriteCollectionPartialSuccessMeta
object
Additional data about the response.
3 properties
MetafieldBase_Post
object
Common Metafield properties.
5 properties 4 required
CollectionMeta
object
Data about the response, including pagination and collection totals.
1 property
MetaFieldCollectionResponsePartialSuccess_DELETE
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionPostPutResponses
object
Response payload for the BigCommerce API.
3 properties
WriteCollectionSuccessMeta
object
Additional data about the response.
3 properties
MetaFieldCollectionDeleteResponseSuccess
object
Response payload for the BigCommerce API.
3 properties
MetaFieldCollectionResponse
object
Response payload for the BigCommerce API.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-customer-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 Customer 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.