BigCommerce

BigCommerce Batch Metafields API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.bigcommerce.com/
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/abandoned-carts
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/carts
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/brands
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/categories
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/category-trees
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/product-modifiers
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/product-variant-options
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/product-variants
📖
APIReference
https://developer.bigcommerce.com/docs/rest-catalog/products
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/channels
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/checkouts
📖
APIReference
https://developer.bigcommerce.com/docs/rest-content/store-content
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/currencies
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/customers
📖
APIReference
https://developer.bigcommerce.com/docs/rest-content/email-templates
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/geography
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/orders
📖
APIReference
https://developer.bigcommerce.com/docs/rest-content/pages
📖
APIReference
https://developer.bigcommerce.com/docs/rest-payments/tokens
📖
APIReference
https://developer.bigcommerce.com/docs/rest-payments/methods-deprecated
📖
APIReference
https://developer.bigcommerce.com/docs/rest-payments/processing
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/settings
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/shipping-v2
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/channels/site
📖
APIReference
https://developer.bigcommerce.com/docs/rest-management/store-information
📖
APIReference
https://developer.bigcommerce.com/docs/rest-storefront/carts
📖
APIReference
https://developer.bigcommerce.com/docs/rest-storefront/checkouts
📖
APIReference
https://developer.bigcommerce.com/docs/rest-storefront/customers
📖
APIReference
https://developer.bigcommerce.com/docs/rest-storefront/orders
📖
APIReference
https://developer.bigcommerce.com/docs/rest-storefront/subscriptions
📖
APIReference
https://developer.bigcommerce.com/docs/integrations/webhooks
📖
APIReference
https://developer.bigcommerce.com/docs/rest-content/widgets

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/bigcommerce-batch-metafields-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/asyncapi/bigcommerce-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/graphql/bigcommerce-graphql.md

OpenAPI Specification

bigcommerce-batch-metafields-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: BigCommerce Abandoned Cart Emails Batch Metafields API
  version: 3.0.0
  termsOfService: https://www.bigcommerce.com/terms
  description: Abandoned Cart Emails V3 API managing Handlebars-based emails.
  contact:
    name: BigCommerce
    url: https://www.bigcommerce.com
    email: support@bigcommerce.com
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v3
  variables:
    store_hash:
      default: store_hash
      description: Permanent ID of the BigCommerce store.
  description: BigCommerce API Gateway
security:
- X-Auth-Token: []
tags:
- name: Batch Metafields
paths:
  /carts/metafields:
    get:
      summary: BigCommerce Get All Cart Metafields
      tags:
      - Batch Metafields
      description: Get all cart metafields.
      operationId: getCartsMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createCartsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    resource_id:
                      type: string
                      example: '42'
                      description: 'The ID for the cart with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: 'List of created `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch_POST_PUT'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: updateCartsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    id:
                      type: string
                      example: '42'
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_Batch_POST_PUT'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all cart metafields.
      operationId: deleteCartsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield `id`s.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /catalog/brands/metafields:
    get:
      summary: BigCommerce Get All Brand Metafields
      tags:
      - Batch Metafields
      description: Get all brand metafields.
      operationId: getBrandsMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_2'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createBrandsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    resource_id:
                      type: integer
                      example: 42
                      description: 'The ID for the brand with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: 'List of created `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: updateBrandsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Put'
                - type: object
                  properties:
                    id:
                      type: integer
                      example: 42
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all brand metafields.
      operationId: deleteBrandsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /catalog/categories/metafields:
    get:
      summary: BigCommerce Get All Category Metafields
      tags:
      - Batch Metafields
      description: Get all category metafields.
      operationId: getCategoriesMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_2'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_3'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createCategoriesMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    resource_id:
                      type: integer
                      example: 42
                      description: 'The ID for the category with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: "List of created `Metafield` objects.  \n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_2'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: updateCategoriesMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Put'
                - type: object
                  properties:
                    id:
                      type: integer
                      example: 42
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_2'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all category metafields.
      operationId: deleteCategoriesMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /catalog/variants/metafields:
    get:
      summary: BigCommerce Get All Product Variant Metafields
      tags:
      - Batch Metafields
      description: Get all variant metafields.
      operationId: getVariantsMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_3'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_4'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createVariantsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    resource_id:
                      type: integer
                      example: 42
                      description: 'The ID for the product variant with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: 'List of created `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_3'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: updateVariantsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Put'
                - type: object
                  properties:
                    id:
                      type: integer
                      example: 42
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_3'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all variant metafields.
      operationId: deleteVariantsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /catalog/products/metafields:
    get:
      summary: BigCommerce Get All Product Metafields
      tags:
      - Batch Metafields
      description: Get all product metafields.
      operationId: getProductsMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_4'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_5'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createProductsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post'
                - type: object
                  properties:
                    resource_id:
                      type: integer
                      example: 42
                      description: 'The ID for the product with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: "List of created `Metafield` objects.  \n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_4'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Update multiple metafields.
      operationId: updateProductsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Put'
                - type: object
                  properties:
                    id:
                      type: integer
                      example: 42
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_4'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all product metafields.
      operationId: deleteProductsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /channels/metafields:
    get:
      summary: BigCommerce Get All Channel Metafields
      tags:
      - Batch Metafields
      description: Get all channel metafields.
      operationId: getChannelsMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_5'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam_2'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam_2'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_6'
      - $ref: '#/components/parameters/DirectionParam_2'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createChannelsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MetafieldPost'
        description: ''
      responses:
        '200':
          description: "List of created `Metafield` objects.  \n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_5'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Update multiple metafields.
      operationId: updateChannelsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MetafieldPut'
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_5'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all channel metafields.
      operationId: deleteChannelsMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
  /orders/metafields:
    get:
      summary: BigCommerce Get All Order Metafields
      tags:
      - Batch Metafields
      description: Get all order metafields.
      operationId: getOrdersMetafields
      responses:
        '200':
          description: 'List of `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_6'
        '500':
          description: Internal Server Error
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/MetafieldKeyParam_3'
      - $ref: '#/components/parameters/MetafieldKeyInParam'
      - $ref: '#/components/parameters/MetafieldNamespaceParam_3'
      - $ref: '#/components/parameters/MetafieldNamespaceInParam_7'
      - $ref: '#/components/parameters/DirectionParam'
    post:
      summary: BigCommerce Create multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: createOrdersMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post_2'
                - type: object
                  properties:
                    resource_id:
                      type: integer
                      example: 42
                      description: 'The ID for the order with which the metafield is associated.

                        '
                  required:
                  - resource_id
        description: ''
      responses:
        '200':
          description: 'List of created `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_6'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    put:
      summary: BigCommerce Update multiple Metafields
      tags:
      - Batch Metafields
      description: Create multiple metafields.
      operationId: updateOrdersMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MetafieldBase_Post_2'
                - type: object
                  properties:
                    id:
                      type: integer
                      example: 42
                      description: 'The ID of metafield to update.

                        '
                  required:
                  - id
        description: ''
      responses:
        '200':
          description: 'List of updated `Metafield` objects.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponse_POST_PUT_6'
        '422':
          description: 'Response object for metafields creation with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_POST_PUT'
        '500':
          description: Internal Server Error
    delete:
      summary: BigCommerce Delete All Metafields
      tags:
      - Batch Metafields
      description: Delete all order metafields.
      operationId: deleteOrdersMetafields
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
        description: List of metafield IDs.
      responses:
        '200':
          description: 'Response object for metafields deletion with success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionDeleteResponseSuccess'
        '422':
          description: 'Response object for metafields deletion with partial success.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
components:
  parameters:
    MetafieldNamespaceParam_2:
      name: namespace
      in: query
      description: Filter based on a metafieldʼs namespace.
      required: false
      schema:
        type: string
    MetafieldNamespaceParam_3:
      name: namespace
      in: query
      description: 'Filter based on a metafieldʼs key.

        '
      required: false
      schema:
        type: string
    MetafieldNames

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/bigcommerce-batch-metafields-api-openapi.yml