BigCommerce · Schema

Metafield

Allows app partners to write custom data to various resources in the API.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
View JSON Schema on GitHub

JSON Schema

bigcommerce-metafield-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Metafield",
  "title": "Metafield",
  "description": "Allows app partners to write custom data to various resources in the API.\n",
  "allOf": [
    {
      "$ref": "#/components/schemas/MetafieldBase"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the metafield."
        },
        "date_created": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of the metafield\u02bcs creation.",
          "example": "2022-06-16T18:39:00+00:00"
        },
        "date_modified": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time when the metafield was last updated.",
          "example": "2022-06-16T18:39:00+00:00"
        },
        "owner_client_id": {
          "type": "string",
          "description": "Client ID for the metafield\u02bcs creator.",
          "example": "asdfasdfasdfasdfasdfasdfasdf",
          "readOnly": true
        }
      }
    }
  ],
  "x-internal": false
}