Batch query meiafield definition

Requires read_metafileds access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/metafield_definitions.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 .

Query Parameters

access_admin string
[]
Per the definition of the field of acess permissions filtering . ( default definition of the field of the field of the PRIVATE corresponding to MERCHANT_READ_WRITE、MERCHANT_READ、PUBLIC_READ、null、 and the app . )
[]
Example: MERCHANT_READ
created_at_max string
[]
Show definition of the field of yuan before date Example : 2021-04-25T16 : 16 : 47-04 : 00
[]
Example: 2021-04-25T16:16:47-04:00
created_at_min string
[]
Show definition of the field after the date Example : 2021-04-25T16 : 16 : 47-04 : 00
[]
Example: 2021-04-25T16:16:47-04:00
definition_state string
[]
Definition status : CREATED , all , default CREATED
[]
Example: CREATED
key string
[]
Define the field Example : key_123 by secret key filtering
[]
Example: key_123
limit integer
[]
Query quantity limited to , default 50 , can not exceed 1000 Example : 10
[]
Example: 50
namespace string
[]
Definition of Example : n_123 by name space filtering field
[]
Example: n_123
owner_resource string required
[]
Filter meta field definitions by specific owner types Example: products, customers, orders, pages, variants, collections articles, blogs, draft_orders, smart_collections locations, images, shop
[]
Example: products
page_info string
[]
Paging parameters
since_id long
[]
After specify id Example : 1
[]
Example: 1
type string
[]
Define Example : single_line_text_field by data type filtering field
[]
Example: single_line_text_field
updated_at_max string
[]
Show update before date field definition Example : 2021-04-25T16 : 16 : 47-04 : 00
[]
Example: 2021-04-25T16:16:47-04:00
updated_at_min string
[]
Show update before date field definition Example : 2021-04-25T16 : 16 : 47-04 : 00
[]
Example: 2021-04-25T16:16:47-04:00

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
Query jump page
traceId
[]
traceId

Response Body

dataobject
[]
data
metafield_definitionsobject[]
[]
Metafield defines the paging list
accessobject
[]
Return permissions defined in the field of the yuan .
admin string
[]
Return permissions defined in the field of the yuan .
[]
Example: MERCHANT_READ
created_at string
[]
Return created time for the field definition .
[]
Example: 2021-04-25T16:16:47-04:00
description string
[]
Return description of the field definition .
[]
Example: A list of ingredients used to make the product.
id long
[]
Return the metafieldsDefinitions ID defined in the field of life , global unique identifier
[]
Example: 33646782314
key string
[]
Return secret key defined in the field of the yuan .
[]
Example: key123
name string
[]
Return this field defines the name .
[]
Example: Subtitle
namespace string
[]
Return name space defined in the field of the yuan .
[]
Example: n_123
owner_resource string
[]
Return owner resources object name defined in the field of the yuan .
[]
Example: products
type string
[]
Return the data type that will be stored is defined in the field of the yuan .
[]
Example: single_line_text_field
updated_at string
[]
Return update time defined in the field .
[]
Example: 2021-04-30T16:16:47-04:00

API Explorer

Debugger

Base URL

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

ParamOptions

owner_resource — query required

Authorization — header required

access_admin — query

created_at_max — query

created_at_min — query

definition_state — query

key — query

limit — query

namespace — query

page_info — query

since_id — query

type — query

updated_at_max — query

updated_at_min — query

Language

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

Was this article helpful to you?

SHOPLINE

Legal