List Order Metafields

GET

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

GET

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

curl https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "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": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Gets a Metafield object list, by order_id.

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.

Query parameters

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

keystringOptional

Filter based on a metafieldʼs key.

namespacestringOptional

Filter based on a metafieldʼs key.

directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

Response

An array of metafields and metadata.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.