> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # List Order Metafields GET https://api.bigcommerce.com/stores/{store_hash}/v3/orders/{order_id}/metafields 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. Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/order-operations/metafields/get-order-metafields ## Authentication - `X-Auth-Token` header (required) — ### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes). ## Request ### Path parameters - `order_id` (integer, required) — The ID of the `Order` to which the transactions belong. - `store_hash` (string, required) — Permanent ID of the BigCommerce store. ### Query parameters - `page` (integer, optional) — Specifies the page number in a limited (paginated) list of products. - `limit` (integer, optional) — Controls the number of items per page in a limited (paginated) list of products. - `key` (string, optional) — Filter based on a metafieldʼs key. - `namespace` (string, optional) — Filter based on a metafieldʼs key. - `direction` (enum, optional) — Sort direction. Acceptable values are: `asc`, `desc`. - Allowed values: `asc`, `desc` ### Headers - `Accept` (string, required, default: application/json) — The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. ## Response ### 200 An array of metafields and metadata. - `data` (list of Metafield, optional) - `meta` (CollectionMeta, optional) — Data about the response, including pagination and collection totals. ## Types ### Metafield Allows app partners to write custom data to various resources in the API. - `permission_set` (enum, required) — 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: `app_only`, `read`, `write`, `read_and_sf_access`, `write_and_sf_access` - `date_created` (datetime, optional) — Date and time of the metafieldʼs creation. - `date_modified` (datetime, optional) — Date and time when the metafield was last updated. - `description` (string, optional) — Description for the metafields. - `id` (integer, optional) — The unique identifier for the metafields. - `key` (string, optional) — The name of the field, for example: `location_id`, `color`. - `namespace` (string, optional) — Namespace for the metafield, for organizational purposes. - `owner_client_id` (string, optional) — Client ID for the metafieldʼs creator. - `resource_id` (integer, optional) — The unique identifier for the resource with which the metafield is associated. - `resource_type` (enum, optional) — The type of resource with which the metafield is associated. - Allowed values: `order`, `brand`, `product`, `variant`, `category` - `value` (string, optional) — The value of the field, for example: `1`, `blue`. ### CollectionMeta Data about the response, including pagination and collection totals. - `pagination` (CollectionMetaPagination, optional) — Data about the response, including pagination and collection totals. ### CollectionMetaPagination Data about the response, including pagination and collection totals. - `total` (integer, optional) — Total number of items in the result set. - `count` (integer, optional) — Total number of items in the collection response. - `per_page` (integer, optional) — The amount of items returned in the collection per page, controlled by the limit parameter. - `current_page` (integer, optional) — The page you are currently on within the collection. - `total_pages` (integer, optional) — The total number of pages in the collection. - `links` (CollectionMetaPaginationLinks, optional) — Pagination links for the previous and next parts of the whole collection. ### CollectionMetaPaginationLinks Pagination links for the previous and next parts of the whole collection. - `previous` (string, optional) — Link to the previous page returned in the response. - `current` (string, optional) — Link to the current page returned in the response. - `next` (string, optional) — Link to the next page returned in the response. ## Examples **Response** ```json { "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" } } } } ``` **SDK Code** ```python import requests url = "https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields" headers = { "Accept": "application/json", "X-Auth-Token": "" } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields'; const options = { method: 'GET', headers: {Accept: 'application/json', 'X-Auth-Token': ''} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Accept", "application/json") req.Header.Add("X-Auth-Token", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/json' request["X-Auth-Token"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields") .header("Accept", "application/json") .header("X-Auth-Token", "") .asString(); ``` ```php request('GET', 'https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields', [ 'headers' => [ 'Accept' => 'application/json', 'X-Auth-Token' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/json"); request.AddHeader("X-Auth-Token", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Accept": "application/json", "X-Auth-Token": "" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/orders/1/metafields")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```