Query Product of sales channels

Requires read_product_listings access scope.

For more info , refer to:

[]

access permission

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

collection_id string
[]
Use classified id screening
handle string
[]
Filter using Product handle
limit integer
[]
Query of query quantity , default 50 , can not exceed 1000
product_ids string
[]
Filter according to incoming Product id list , up to 1000 items are screened by the last updated list after a certain date and time
updated_at_min string
[]
Filter on the last updated product list after the date and time

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

product_listingsobject[]
[]
Product list
body_html string
[]
Product description
brand string
[]
Product brand
created_at string
[]
Product create time
handle string
[]
Global unique Product handle
imagesobject[]
[]
Product main image listing
alt string
[]
Picture alt
src string
[]
Image URL
optionsobject[]
[]
Product attributes , up to 5
id string
[]
Product attribute id
name string
[]
Product attribute name
product_id string
[]
Product ID
values array
[]
Product attribute value , listed in order to from left to right on the end of the b
[]
Example: ``
values_images map
[]
Example: [object Object]
product_id string
[]
Product ID
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
[]
Product summary
tags string
[]
Product tag
template_path string
title string
[]
Product title
updated_at string
[]
Product update time
variantsobject[]
[]
Specification list , up to 500
barcode string
[]
Bar code
compare_at_price string
[]
Original price
id string
[]
Product skuId
imageobject
[]
Specification picture
alt string
[]
Picture alt
src string
[]
Image URL
inventory_item_id string
[]
Stock object id
inventory_policy string
[]
Allows oversold continue or not : allows deny : not allowed
inventory_quantity integer
[]
Inventory value
inventory_tracker boolean
[]
Whether to track inventory? T: Track F: Do not track
option1 string
[]
Specs 1
option2 string
[]
Gauge value 2
option3 string
[]
Specs value 3
option4 string
[]
Gauge value 4
option5 string
[]
Gauge value 5
price string
[]
Selling price
product_id string
[]
Product ID
sku string
[]
Sku code , ready-to-ship
title string
[]
Specification title
weight string
[]
Weight
weight_unit string
[]
Weight unit , g : g , kg : kg , lb : lb , oz : oz

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

collection_id — query

handle — query

limit — query

product_ids — query

updated_at_min — query

Language

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