Add a secondary metafield(To be deprecated)

POST https://{handle}.myshopline.com/admin/openapi/v20270301/:p_resource/:p_owner_id/:resource/:owner_id/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 .

Create a metafield.

DEPRECATED

This API is deprecated from API version v20250601. Use the Create a metafield for a resource API instead.

Path Parameters

owner_id string required

Secondary resource id

Example: 1802351351232521351351
p_owner_id string required

First class resource id

Example: 16024213413413412341234
p_resource string required

First class resources , like products

Example: products
resource string required

Secondary resources such as variants

Example: variants

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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

metafieldobject

metafield
description string

Description
Example: My description
key string

A unique identifier for a metafield within its namespace.
Example: key_123
namespace string

Namespace , 2-50 characters
Example: namespace_123
type string

The type of value, such as single_line_text_field, multi_line_text_field, boolean, url, variant_reference, product_reference, page_reference, rating, number_decimal, number_integer, dimension, volume, weight, json, file_reference, date_time, date, color
Example: single_line_text_field
value object

The data stored in the metafield.

Status Codes

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

Response Headers

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

metafieldobject

metafield
value object

The data stored in the metafield.
created_at string

Creation time
Example: 2022-12-28T09:39:35+00:00
id long

Metafield's id
Example: 124213413421342130
namespace string

Namespace
Example: namespace_123
owner_resource string

Resources
Example: variants
type string

Type
Example: single_line_text_field
updated_at string

Update time
Example: 2022-12-28T09:39:35+00:00
description string

Description
Example: My description
key string

A unique identifier for a metafield within its namespace.
Example: key_123
owner_id string

Resource id
Example: 18024213413413412341234

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

owner_id — path required

p_owner_id — path required

p_resource — path required

resource — path required

Authorization — header required

Body

Body required

{
  "metafield": {
    "description": "My description",
    "key": "key_123",
    "namespace": "namespace_123",
    "type": "single_line_text_field",
    "value": null
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301/p_resource/p_owner_id/resource/owner_id/metafields.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal