Query single product

Requires read_products access scope.

For more info , refer to:

[]

access permission

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

[]

Get Product details

Path Parameters

product_id string required
[]
Product ID

Query Parameters

fields string
[]
Fields to be returned, separated by ","

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

traceId
[]
traceId

Response Body

productobject
[]
Product details
body_html string
[]
Description
brand string
[]
brand
created_at string
[]
Creation time
handle string
[]
Product handle
[]
Example: hello-world-96841-65975
id string
[]
Product ID
[]
Example: 16049619743346320200470282
imageobject
[]
Product main image
alt string
[]
alt
src string
[]
url
imagesobject[]
[]
Images
alt string
[]
alt
src string
[]
url
optionsobject[]
[]
Specification
id string
[]
Product id for attributes
name string
[]
Attribute name
product_id string
[]
Duiying id corresponding
values array
[]
Attribute values, listed in order from left to right on the B-end
[]
Example: ``
values_images map
[]
Attribute value chart , e . g . : { " red " : " src " }
[]
Example: [object Object]
product_behavior string
[]
Product behavior
product_category string
[]
Product type
product_type string
[]
Product type : NORMAL- normal Product , POD_TEMPORARY-POD temporary Product , TEMPORARY- temporary products
published_at string
[]
Post time
published_scope string
[]
Set the launch range , when the value is " web " , it means online stores
status string
[]
Upper and lower racks active : on shelf draft : off shelf
subtitle string
[]
Summary
tags string
[]
Tag
template_path string
[]
Theme template
title string
[]
Headline
updated_at string
[]
Update time
variantsobject[]
[]
Sku data
barcode string
[]
Sku bar code
compare_at_price string
[]
Original price
id string
[]
Product id for attributes
imageobject
[]
Images
alt string
[]
alt
src string
[]
url
inventory_item_id string
[]
Stock object id
inventory_policy string
[]
Allows oversold continue or not : allows deny : not allowed
inventory_quantity integer
[]
Inventory quantity
inventory_tracker boolean
[]
Whether to track inventory? T: Track F: Do not track
option1 string
[]
Attribute value
option2 string
[]
Attribute value
option3 string
[]
Attribute value
option4 string
[]
Attribute value
option5 string
[]
Attribute value
price string
[]
Selling price
product_id string
[]
Duiying id corresponding
require_shipping boolean
[]
Shipping or not
sku string
[]
Item no .
taxable boolean
[]
Tax collection or not required
title string
[]
SKU title
weight string
[]
Weight
weight_unit string
[]
Unit of weight, g: grams kg: kilograms lb: pounds oz: ounces zh_kg: kilograms

API Explorer

Debugger

Base URL

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

ParamOptions

product_id — path required

Authorization — header required

fields — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20220901/products/product_id.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

Error loading component.