Query Product of sales channels

Requires read_product_listings access scope.

For more info, refer to:

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

page_info string

The unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/product_listings.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .

For more information on how to use pagination, refer to Paging Mechanism.

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

Use collection id screening

Example: 12250433045062532239420282
handle string

Global unique product handle

Example: This is Product Handle
limit string

Limit of query , default 50 , can not exceed 1000

Example: 50

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

Status Codes

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

Response Headers

link

The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page.

For more information on how to use pagination, refer to Paging Mechanism.
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

product_listingsobject[]

Product list
handle string

Global unique Product handle
Example: product-handle
product_id string

Product ID
Example: 16057039432335097907370282
subtitle string

product summary
Example: This is a subtitle
vendor string

Product vendor
Example: Shopline
body_html string

product description
Example: This is a description
published_at string

Time to post to the online store
Example: 2022-12-06T15:13:50+08:00
updated_at string

update time
Example: 2022-12-06T15:13:50+08:00
title string

Product title
Example: This is a Product headline
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: {"Red":"https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"}
spu string

SPU code
Example: S00000001
status string

Product status ; activated- on shelves , deactivated- off shelves , archived- filing
Example: active
tags string

Product tag
Example: tag1, tag2
template_path string

Template path
Example: templates/products/detail.json
variantsobject[]

Variant list
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
option1 string

The variant corresponds to the value of the option1
Example: Red
option3 string

The variant corresponds to the value of the option3
option4 string

The variant corresponds to the value of the option4
required_shipping boolean

Shipping or not
Example: true
barcode string

Barcode
Example: B00000001
inventory_quantity integer

Inventory summary for all locations
Example: 100
sku string

SKU code
Example: T00000001
title string

Variant title
Example: Red / L
weight string

Weight
Example: 0.5
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_tracker boolean

Track inventory , true : tracking , false : not tracking
Example: true
option5 string

The variant corresponds to the value of the option5
price string

selling price
Example: 90
product_id string

Product ID
Example: 16057039432335097907370282
taxable boolean

Tax collection or not required
Example: true
weight_unit string

Weight units : g , kg , lb , oz , zh_kg
Example: g
compare_at_price string

Original price
Example: 100
id string

Variant id
Example: 18057039432358082693350282
option2 string

The variant corresponds to the value of the option2
Example: L
created_at string

Product create time
Example: 2022-12-06T15:13:50+08:00
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
published_scope string

Set the sales channel , when the value is " web " , it means online stores
Example: web

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

page_info — query

product_ids — query

updated_at_min — query

collection_id — query

handle — query

limit — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/product_listings.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

Query sales channel products by specified Product

Response

{
  "product_listings": [
    {
      "images": [
        {
          "alt": "This is a alt",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "variants": [
        {
          "weight": "10.00",
          "id": "18060878850550105771733144",
          "image": {
            "alt": "This is a alt",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "price": "100.00",
          "required_shipping": true,
          "sku": "S00000000101",
          "inventory_quantity": 580,
          "option1": "L",
          "taxable": true,
          "weight_unit": "g",
          "inventory_item_id": "6087885056453385358",
          "product_id": "16060878850545743695513144",
          "barcode": "T00000001",
          "compare_at_price": "120.00",
          "inventory_policy": "continue",
          "inventory_tracker": true,
          "option2": "White",
          "title": "L · White"
        },
        {
          "barcode": "B0000000001",
          "id": "18060878850550105771823144",
          "inventory_quantity": 100,
          "product_id": "16060878850545743695513144",
          "sku": "S00000000102",
          "weight": "50.00",
          "compare_at_price": "120.00",
          "option2": "White",
          "inventory_item_id": "6087885056453385359",
          "inventory_tracker": true,
          "taxable": true,
          "title": "XL · White",
          "weight_unit": "g",
          "image": {
            "alt": "My Product-10",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "inventory_policy": "deny",
          "option1": "XL",
          "price": "100.00",
          "required_shipping": true
        },
        {
          "inventory_item_id": "6087885056453385357",
          "inventory_tracker": true,
          "option1": "XXL",
          "price": "100.00",
          "required_shipping": true,
          "compare_at_price": "120.00",
          "id": "18060878850550105771883144",
          "option2": "White",
          "barcode": "B0000000001",
          "inventory_quantity": 170,
          "weight_unit": "g",
          "image": {
            "alt": "My Product-10",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "inventory_policy": "deny",
          "product_id": "16060878850545743695513144",
          "sku": "S00000000103",
          "taxable": true,
          "title": "XXL · White",
          "weight": "50.00"
        }
      ],
      "vendor": "Shopline",
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:45:35+08:00",
      "published_at": "2023-08-28T11:45:35+08:00",
      "status": "archived",
      "template_path": "templates/products/detail.html",
      "updated_at": "2023-08-28T19:23:04+08:00",
      "handle": "my-product-14",
      "published_scope": "web",
      "spu": "S000000001",
      "subtitle": "This is a subtitle",
      "tags": "Spring,T shirt",
      "title": "My Product 14",
      "options": [
        {
          "values": [
            "L",
            "XL",
            "XXL"
          ],
          "values_images": {},
          "id": "16160878850550105771753144",
          "name": "Size",
          "product_id": "16060878850545743695513144"
        },
        {
          "id": "16160878850550105771783144",
          "name": "Color",
          "product_id": "16060878850545743695513144",
          "values": [
            "White"
          ],
          "values_images": {}
        }
      ],
      "product_id": "16060878850545743695513144"
    },
    {
      "product_id": "16060878847266804612583144",
      "published_at": "2023-08-28T11:45:15+08:00",
      "published_scope": "web",
      "tags": "Spring,T shirt",
      "updated_at": "2023-08-28T19:32:57+08:00",
      "vendor": "Shopline",
      "spu": "S000000001",
      "status": "archived",
      "subtitle": "This is a subtitle",
      "title": "My Product 13",
      "variants": [
        {
          "product_id": "16060878847266804612583144",
          "compare_at_price": "120.00",
          "id": "18060878847269824511623144",
          "image": {
            "alt": "This is a alt",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "inventory_tracker": true,
          "weight": "10.00",
          "price": "100.00",
          "inventory_policy": "continue",
          "inventory_quantity": 580,
          "required_shipping": true,
          "sku": "S00000000101",
          "taxable": true,
          "title": "L · White",
          "weight_unit": "g",
          "barcode": "T00000001",
          "inventory_item_id": "6087884728240708834",
          "option1": "L",
          "option2": "White"
        },
        {
          "inventory_quantity": 100,
          "inventory_tracker": true,
          "required_shipping": true,
          "taxable": true,
          "inventory_item_id": "6087884728240708835",
          "inventory_policy": "deny",
          "option1": "XL",
          "price": "100.00",
          "image": {
            "alt": "My Product-10",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "option2": "White",
          "product_id": "16060878847266804612583144",
          "weight_unit": "g",
          "barcode": "B0000000001",
          "sku": "S00000000102",
          "title": "XL · White",
          "weight": "50.00",
          "compare_at_price": "120.00",
          "id": "18060878847269824511713144"
        },
        {
          "taxable": true,
          "price": "100.00",
          "sku": "S00000000103",
          "barcode": "B0000000001",
          "compare_at_price": "120.00",
          "id": "18060878847269824511773144",
          "inventory_policy": "deny",
          "inventory_tracker": true,
          "option1": "XXL",
          "image": {
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024",
            "alt": "My Product-10"
          },
          "inventory_quantity": 170,
          "option2": "White",
          "title": "XXL · White",
          "weight_unit": "g",
          "product_id": "16060878847266804612583144",
          "required_shipping": true,
          "inventory_item_id": "6087884728240708836",
          "weight": "50.00"
        }
      ],
      "body_html": "<p>This is a desription</p>",
      "handle": "my-product-13",
      "images": [
        {
          "alt": "This is a alt",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "template_path": "templates/products/detail.html",
      "created_at": "2023-08-28T11:45:15+08:00",
      "options": [
        {
          "product_id": "16060878847266804612583144",
          "values": [
            "L",
            "XL",
            "XXL"
          ],
          "values_images": {},
          "id": "16160878847269824511643144",
          "name": "Size"
        },
        {
          "values_images": {},
          "id": "16160878847269824511673144",
          "name": "Color",
          "product_id": "16060878847266804612583144",
          "values": [
            "White"
          ]
        }
      ]
    }
  ]
}

Was this article helpful to you?

SHOPLINE

Legal