Get store metafields

GET https://{handle}.myshopline.com/admin/openapi/v20260301/metafields.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Get a list of metafields of the store.

Query Parameters

fields string

Specify the fields to be returned, with multiple fields separated by ,. Available fields include id, key, namespace, owner_id, created_at and updated_at.

Example: id,key
key string

A unique identifier for a metafield within its namespace. Only letters, numbers, hyphens, and underscores are supported.
Minimum length: 3
Maximum length: 30

Example: key_123
limit string

The maximum number of metafields to return.
Value range: 1-250
Default value: 50
namespace string

The namespace of the metafield. A metafield can be uniquely identified by its key and namespace. Only letters, numbers, hyphens, and underscores are supported.
Minimum length: 2
Maximum length: 50

Example: namespace_123
page_info string

The unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/metafields.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .

For more information on how to use pagination, refer to Paging Mechanism.
updated_at_max string

Specify the cutoff update date for metafields to query. Metafields updated on and before this time are returned. Format: ISO 8601.

Example: 2024-04-25T16:16:47-04:00
created_at_max string

Specify the cutoff creation date and time for metafields to query. Metafields created on and before this time are returned. Format: ISO 8601.

Example: 2024-04-25T16:16:47-04:00
created_at_min string

Specify the initial creation date and time for metafields to query. Metafields created on and after this time are returned. Format: ISO 8601.

Example: 2024-04-25T16:15:47-04:00
since_id string

The ID of a specific metafield. Start querying metafields from this specified ID.

Example: 1
type string
The data type for the metafield. Valid values are:
- single_line_text_field: A single-line text field
- list.single_line_text_field: Multiple single-line text fields
- multi_line_text_field: Multi-line text field
- color: A single color
- list.color: Multiple colors
- date: A single date
- list.date: Multiple dates
- date_time: A single date and time. Format: ISO 8601.
- list.date_time: Multiple dates and times. Format: ISO 8601.
- url: A single URL
- list.url: Multiple URLs
- file_reference: A single file. Support a PDF or image file within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
- list.file_reference: Multiple files. Support PDF or image files and each file must be within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.
- json: JSON
- weight: A single weight with a unit
- list.weight: Multiple weights with units
- volume: A single volume with a unit
- list.volume: Multiple volumes with units
- dimension: A single size with a unit
- list.dimension: Multiple sizes with units
- number_integer: A single integer
- list.number_integer: Multiple integers
- number_decimal: A single decimal
- list.number_decimal: Multiple decimals
- rating: A single rating
- list.rating: Multiple ratings
- page_reference: A single page
- list.page_reference: Multiple pages
- product_reference: A single product
- list.product_reference: Multiple products
- variant_reference: A single product variant
- list.variant_reference: Multiple product variants
- collection_reference: A single product collection
- list.collection_reference: Multiple product collections
- customer_reference: A single customer
- list.customer_reference: Multiple customers
- order_reference: A single order
- list.order_reference: Multiple orders
- boolean: Boolean type. Valid values are true and false.
- money: Amount with a currency
For more information about metafields, refer to Guide to Using Metafields Feature.
Example: single_line_text_field
updated_at_min string

Specify the initial update date for metafields to query. Metafields updated on and after this time are returned. Format: ISO 8601.

Example: 2024-04-25T16:15:47-04:00

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

link

The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page.

For more information on how to use pagination, refer to Paging Mechanism.
traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

metafieldsobject[]

List of metafields.
created_at string

The date and time when the metafield was created. Format: ISO 8601.
description string

The description of the metafield.
id long

The ID of the metafield.
key string

A unique identifier for a metafield definition within its namespace.
namespace string

The namespace of the metafield.
owner_id string

The store ID to which the metafield belongs.
owner_resource string

The type of the resource to which the metafield belongs. The value of this field is fixed to shop, indicating a store metafield.
type string

The data type for the metafield. Valid values are:

single_line_text_field: A single-line text field

list.single_line_text_field: Multiple single-line text fields

multi_line_text_field: Multi-line text field

color: A single color

list.color: Multiple colors

date: A single date

list.date: Multiple dates

date_time: A single date and time. Format: ISO 8601.

list.date_time: Multiple dates and times. Format: ISO 8601.

url: A single URL

list.url: Multiple URLs

file_reference: A single file. Support a PDF or image file within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.

list.file_reference: Multiple files. Support PDF or image files and each file must be within 10 MB. Supported image formats: JPG, JPEG, PNG, and GIF.

json: JSON

weight: A single weight with a unit

list.weight: Multiple weights with units

volume: A single volume with a unit

list.volume: Multiple volumes with units

dimension: A single size with a unit

list.dimension: Multiple sizes with units

number_integer: A single integer

list.number_integer: Multiple integers

number_decimal: A single decimal

list.number_decimal: Multiple decimals

rating: A single rating

list.rating: Multiple ratings

page_reference: A single page

list.page_reference: Multiple pages

product_reference: A single product

list.product_reference: Multiple products

variant_reference: A single product variant

list.variant_reference: Multiple product variants

collection_reference: A single product collection

list.collection_reference: Multiple product collections

customer_reference: A single customer

list.customer_reference: Multiple customers

order_reference: A single order

list.order_reference: Multiple orders

boolean: Boolean type. Valid values are true and false.

money: Amount with a currency

For more information about metafields, refer to Guide to Using Metafields Feature.
updated_at string

The date and time when the metafield was updated. Format: ISO 8601.
value object

The data stored in the metafield.

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

fields — query

key — query

limit — query

namespace — query

page_info — query

updated_at_max — query

created_at_max — query

created_at_min — query

since_id — query

type — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/metafields.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

Get store metafields

Response

{
  "metafields": [
    {
      "created_at": "2022-07-28T07:21:39+00:00",
      "description": "omnisend data id",
      "id": 232182358691,
      "key": "Omnisned_snippet",
      "namespace": "Omnisned_Code",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-07-28T07:21:49+00:00",
      "value": "62e238c246ae0adf7c70f96b"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236568508691,
      "key": "enable",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "boolean",
      "updated_at": "2022-08-03T08:44:17+00:00",
      "value": true
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236568518691,
      "key": "inquiry_config",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:28+00:00",
      "value": "{\"hideBuy\":true,\"hidePrice\":true,\"openQuote\":false,\"suspendedEnable\":true,\"suspendedPage\":[\"Home\",\"ProductsDetail\",\"Products\",\"Page\"]}"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236590778691,
      "key": "inquiry_form_list",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:28+00:00",
      "value": "[{\"id\":\"5522860666308532608\",\"title\":\"Contact us\",\"formName\":\"Default Form\",\"submitContent\":\"Submit\",\"content\":[{\"txt\":\"Name\",\"required\":true,\"textLimit\":255,\"id\":\"5522860666308532609\",\"type\":\"singleLine\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Email\",\"required\":true,\"textLimit\":255,\"id\":\"5522860666308532610\",\"type\":\"email\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Message\",\"required\":false,\"textLimit\":1024,\"id\":\"5522860666308532611\",\"type\":\"multiline\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Files\",\"required\":false,\"textLimit\":5120,\"id\":\"5522860666308532612\",\"type\":\"upload\",\"ext\":\"{\\\"fileNameLengthLimit\\\":255,\\\"suffix\\\":[\\\"pdf\\\",\\\"jpeg\\\",\\\"jpg\\\",\\\"png\\\",\\\"gif\\\"]}\"}],\"createTime\":1659516257206}]"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236590788691,
      "key": "customer_form_components",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:40+00:00",
      "value": "{\"title\":\"Wholesale Registration\",\"submitContent\":\"Submit\",\"content\":[{\"id\":\"5522860667667487110\",\"type\":\"subtitle\",\"textContent\":\"Customer Information\"},{\"required\":true,\"textLimit\":255,\"id\":\"5522860667667487111\",\"type\":\"name\"},{\"required\":true,\"textLimit\":255,\"id\":\"5522860667684264328\",\"type\":\"email\"},{\"txt\":\"Company\",\"required\":false,\"placeholder\":\"Company name\",\"id\":\"5522860667684264329\",\"type\":\"singleLine\"},{\"txt\":\"Tax ID, ABN, or VAT Number\",\"required\":false,\"placeholder\":\"Tax ID, ABN, or VAT Number\",\"id\":\"5522860667684264330\",\"type\":\"singleLine\"},{\"required\":false,\"id\":\"5522860667684264331\",\"type\":\"phoneNumber\"},{\"txt\":\"Website\",\"required\":false,\"placeholder\":\"Website\",\"id\":\"5522860667684264332\",\"type\":\"singleLine\"},{\"txt\":\"Note\",\"required\":false,\"textLimit\":1024,\"placeholder\":\"Tell us a little about yourself so that we can verify your business identity.\",\"id\":\"5522860667684264333\",\"type\":\"multiline\"},{\"id\":\"5522860667684264334\",\"type\":\"subtitle\",\"textContent\":\"Shipping Address\"},{\"required\":false,\"id\":\"5522860667684264335\",\"type\":\"address\"}]}"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236594678691,
      "key": "inquiry_form_apply",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:39+00:00",
      "value": "{\"ProductsDetail\":{\"id\":\"5522860666308532608\"},\"Suspended\":{\"id\":\"5522860666308532608\"},\"InquiryCar\":{\"id\":\"5522860666308532608\"}}"
    },
    {
      "created_at": "2022-08-03T11:54:24+00:00",
      "id": 236734448691,
      "key": "5523052043743008876",
      "namespace": "b2b_moq_plan",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T12:01:37+00:00",
      "value": "{\"weight\":1,\"moq\":2,\"applyType\":2,\"batchBuy\":true,\"multipleBuy\":true}"
    },
    {
      "created_at": "2022-08-04T06:37:02+00:00",
      "id": 237442018691,
      "key": "5524182034371322163",
      "namespace": "b2b_step_price_plan",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-04T06:37:06+00:00",
      "value": "{\"type\":2,\"productRelationType\":2,\"weight\":1,\"rules\":[{\"quantity\":1,\"tiered\":2000}]}"
    },
    {
      "created_at": "2022-08-05T07:06:26+00:00",
      "description": "google-site-verification",
      "id": 237987768691,
      "key": "meta_name",
      "namespace": "seo_tool",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-05T07:06:27+00:00",
      "value": ""
    },
    {
      "created_at": "2022-08-05T07:06:27+00:00",
      "description": "Whether breadcrumbs are turned on",
      "id": 237995758691,
      "key": "bread_crumbs",
      "namespace": "seo_tool",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-05T07:06:27+00:00",
      "value": "0"
    },
    {
      "created_at": "2022-08-08T03:03:40+00:00",
      "id": 239514908691,
      "key": "member_switch_config_list",
      "namespace": "member",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "json",
      "updated_at": "2022-08-08T03:03:54+00:00",
      "value": "{\"switchConfigs\":[{\"storeId\":\"1656987608691\",\"type\":1,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":2,\"status\":0},{\"storeId\":\"1656987608691\",\"type\":3,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":4,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":5,\"status\":0},{\"storeId\":\"1656987608691\",\"type\":100,\"status\":1}]}"
    },
    {
      "created_at": "2022-08-08T03:10:36+00:00",
      "id": 239565968691,
      "key": "member_step_benefit_list",
      "namespace": "member",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "json",
      "updated_at": "2022-08-08T03:12:18+00:00",
      "value": "{\"levelList\":[{\"levelCode\":\"MLC5529772421483860051\",\"levelName\":\"1级会员\",\"weight\":\"1\",\"icon\":\"LEVEL_1\",\"benefitName\":\"$1 off coupon\",\"levelPrivilege\":\"[{\\\"privilegeName\\\":\\\"特权1\\\"}]\",\"levelThreshold\":\"Spend $0\"},{\"levelCode\":\"MLC5529772756524865927\",\"levelName\":\"二级会员\",\"weight\":\"2\",\"icon\":\"LEVEL_2\",\"benefitName\":\"\",\"levelThreshold\":\"Spend $100\"}]}"
    },
    {
      "created_at": "2022-10-13T06:57:41+00:00",
      "id": 306011468691,
      "key": "attachment_enable",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "boolean",
      "updated_at": "2022-10-13T06:57:41+00:00",
      "value": true
    },
    {
      "created_at": "2022-12-28T09:29:35+00:00",
      "description": "update",
      "id": 397424508691,
      "key": "key_123",
      "namespace": "shopline",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-12-28T09:56:08+00:00",
      "value": "update_value"
    }
  ]
}

Was this article helpful to you?

SHOPLINE

Legal