Update a secondary metafield (To be deprecated)

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

Update a metafield.

DEPRECATED

This API is deprecated from API version v20250601. Use the Update 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
id string required

Metafield's id

Example: 398100698691

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 required

metafield
description string

Description
Example: test
id long required

Metafield's id
Example: 398100698691
type string required

Value type , like single_line_text_field
Example: single_line_text_field
value object required

Value , type relies on type , default each application dispenses 100 m storage space，the maximum input length for a single metafield is 500,000 characters.
Example: {}

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
description string

Description
Example: update
key string

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

resource id
Example: 1802351351232521351351
updated_at string

update time
Example: 2022-12-28T09:48:09+00:00
value object

The data stored in the metafield.
created_at string

Created time
Example: 2022-12-28T09:48:09+00:00
id long

Metafield's id
Example: 398100698691
namespace string

namespace
Example: namespace_123
owner_resource string

resources
Example: products
type string

Type
Example: single_line_text_field

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

id — path required

Authorization — header required

Body

Body required

{
  "metafield": {
    "description": "test",
    "id": 398100698691,
    "type": "single_line_text_field",
    "value": {}
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301/p_resource/p_owner_id/resource/owner_id/metafields/id.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