Create Metafields

POST

https://api.bigcommerce.com/stores/:store_hash/v3/orders/:order_id/metafields

POST

/stores/:store_hash/v3/orders/:order_id/metafields

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "permission_set": "app_only",
  "namespace": "Sales Department",
  "key": "Staff Name",
  "value": "Sam",
  "description": "Name of staff member"
}'

{
  "data": {
    "permission_set": "app_only",
    "date_created": "2022-06-16T18:39:00+00:00",
    "date_modified": "2022-06-16T18:39:00+00:00",
    "description": "order",
    "id": 1,
    "key": "Staff Name",
    "namespace": "Sales Department",
    "owner_client_id": "asdfasdfasdfasdfasdfasdfasdf",
    "resource_id": 0,
    "resource_type": "order",
    "value": "Ronaldo"
  },
  "meta": {}
}

Creates an order Metafield.

The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Transactions	read and modify `transactions` and `payment_methods`	`store_v2_transactions`
Order Transactions	read `transactions` and `payment_methods`	`store_v2_transactions_read_only`
Orders	read and modify `payment_methods`	`store_v2_orders`
Orders	read `payment_methods`	`store_v2_orders_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

order_idintegerRequired

The ID of the Order to which the transactions belong.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

A Metafield object.

permission_setenumRequired

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 API consumers
`write`	Open for reading and writing by other API consumers
`read_and_sf_access`	Visible to other API consumers, including on storefront
`write_and_sf_access`	Open for reading and writing by other API consumers, including on storefront

Allowed values:

namespacestringRequired1-64 characters

Namespace for the metafield, for organizational purposes.

keystringRequired1-64 characters

The name of the field, for example: location_id, color.

valuestringRequired1-65535 characters

The value of the field, for example: 1, blue.

descriptionstringOptional0-255 characters

Description for the metafields.

Response

A Metafield object.

dataobjectOptional

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

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

409

Conflict Error

422

Unprocessable Entity Error