BigCommerce · Schema
MetafieldBase_Put
Common Metafield properties.
E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service
Properties
| Name | Type | Description |
|---|---|---|
| permission_set | string | Determines the visibility and writeability of the field by other API consumers. | Value | Description | | : | : | | `app_only` | Private to the app that owns the field. | | `read` | Visible to other A |
| namespace | string | Namespace for the metafield, for organizational purposes. |
| key | string | The name of the field, for example: `location_id`, `color`. |
| value | string | The value of the field, for example: `1`, `blue`. |
| description | string | Description for the metafields. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MetafieldBase_Put",
"title": "MetafieldBase_Put",
"type": "object",
"description": "Common Metafield properties.\n",
"x-internal": false,
"properties": {
"permission_set": {
"type": "string",
"description": "Determines the visibility and writeability of the field by other API consumers.\n| Value | Description |\n| : | : |\n| `app_only` | Private to the app that owns the field. |\n| `read` | Visible to other API consumers. |\n| `write` | Open for reading and writing by other API consumers. |\n| `read_and_sf_access` | Visible to other API consumers, including on the storefront. |\n| `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. |\n",
"enum": [
"app_only",
"read",
"write",
"read_and_sf_access",
"write_and_sf_access"
]
},
"namespace": {
"type": "string",
"description": "Namespace for the metafield, for organizational purposes.\n",
"example": "Sales Department",
"minLength": 1,
"maxLength": 64
},
"key": {
"type": "string",
"description": "The name of the field, for example: `location_id`, `color`.\n",
"minLength": 1,
"maxLength": 64,
"example": "Staff Name"
},
"value": {
"type": "string",
"description": "The value of the field, for example: `1`, `blue`.\n",
"minLength": 1,
"maxLength": 65535,
"example": "Ronaldo"
},
"description": {
"type": "string",
"description": "Description for the metafields.\n",
"minLength": 0,
"maxLength": 255,
"example": "Name of Staff Member"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bigcommerce-metafieldbase-put"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.