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/v20250601/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 collection id screening
[]
Example: 12250433045062532239420282
handle string
[]
Global unique product handle
[]
Example: This is Product Handle
limit integer
[]
Limit of query , default 50 , can not exceed 1000
[]
Example: 50
page_info string
[]
The call party does not require use and attention to this field , automatically encapsulated by Shopline
[]
Example: eyJzaW5jZUlkIjoiMTYwNTc0NzY4NjQyMTI3MzUxNTQxNjAyODIiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjV9
product_ids string
[]
Selected according to the incoming product id list , up to 1000, separated by ','
[]
Example: 16057039432335097907370282
updated_at_min string
[]
Filter on the last updated product list after the date and time
[]
Example: 2022-12-06T15:13:50+08: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
[]
System automatic generated page turning links
traceId
[]
traceId

Response Body

product_listingsobject[]
[]
Product list
body_html string
[]
product description
[]
Example: This is a description
created_at string
[]
Product create time
[]
Example: 2022-12-06T15:13:50+08:00
handle string
[]
Global unique Product handle
[]
Example: product-handle
imagesobject[]
[]
Product main image listing
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
optionsobject[]
[]
List of option
id string
[]
Option id
[]
Example: 16157850264851626133440282
name string
[]
Option name
[]
Example: Color
product_id string
[]
Product ID
[]
Example: 16057039432335097907370282
values array
[]
List of option value
[]
Example: ["Red", "Green", "White”]
values_images map
[]
The image of option value
[]
Example: [object Object]
product_id string
[]
Product ID
[]
Example: 16057039432335097907370282
published_at string
[]
Time to post to the online store
[]
Example: 2022-12-06T15:13:50+08:00
published_scope string
[]
Set the sales channel , when the value is " web " , it means online stores
[]
Example: web
spu string
[]
SPU code
[]
Example: S00000001
status string
[]
Product status ; activated- on shelves , deactivated- off shelves , archived- filing
[]
Example: active
subtitle string
[]
product summary
[]
Example: This is a subtitle
tags string
[]
Product tag
[]
Example: tag1, tag2
template_path string
[]
Template path
[]
Example: templates/products/detail.json
title string
[]
Product title
[]
Example: This is a Product headline
updated_at string
[]
update time
[]
Example: 2022-12-06T15:13:50+08:00
variantsobject[]
[]
Variant list
barcode string
[]
Barcode
[]
Example: B00000001
compare_at_price string
[]
Original price
[]
Example: 100
id string
[]
Variant id
[]
Example: 18057039432358082693350282
imageobject
[]
Variant image
alt string
[]
Image alt
[]
Example: This is a image alt
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
inventory_item_id string
[]
Inventory Object ID
[]
Example: 5703943240925324252
inventory_policy string
[]
Oversold strategy: deny - Oversold is not allowed, continue - Oversold is allowed
[]
Example: deny
inventory_quantity integer
[]
Inventory summary for all locations
[]
Example: 100
inventory_tracker boolean
[]
Track inventory , true : tracking , false : not tracking
[]
Example: true
option1 string
[]
The variant corresponds to the value of the option1
[]
Example: Red
option2 string
[]
The variant corresponds to the value of the option2
[]
Example: L
option3 string
[]
The variant corresponds to the value of the option3
option4 string
[]
The variant corresponds to the value of the option4
option5 string
[]
The variant corresponds to the value of the option5
price string
[]
selling price
[]
Example: 90
product_id string
[]
Product ID
[]
Example: 16057039432335097907370282
required_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
SKU code
[]
Example: T00000001
taxable boolean
[]
Tax collection or not required
[]
Example: true
title string
[]
Variant title
[]
Example: Red / L
weight string
[]
Weight
[]
Example: 0.5
weight_unit string
[]
Weight units : g , kg , lb , oz , zh_kg
[]
Example: g
vendor string
[]
Product vendor
[]
Example: Shopline

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

collection_id — query

handle — query

limit — query

page_info — query

product_ids — query

updated_at_min — query

Language

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