Query specify Product for sales channels

Requires read_product_listings access scope.

For more info, refer to:

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

Path Parameters

product_listing_id string required

Product ID

Example: 16057039432335097907370282

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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

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

product_listingobject

Product list
vendor string

vendor
Example: Shopline
spu string

SPU code
Example: S00000001
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: {}
tags string

Product tag
Example: tag1,tag2
template_path string

Template path
Example: templates/products/detail.json
created_at string

Creation time
Example: 2022-12-06T15:13:50+08:00
imagesobject[]

Product main image listing
alt string

Image alt
Example: this is alt
src string

Image src
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
subtitle string

Product summary
Example: This is a subtitle
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
updated_at string

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

product description
Example: This is the product description
status string

Product status ; activated- on shelves , deactivated- off shelves , archived- filing
Example: active
variantsobject[]

Variant list
sku string

SKU code
Example: T00000001
inventory_quantity integer

Inventory summary for all locations
Example: 100
id string

Variant id
Example: 18057039432358082693350282
title string

Variant title
Example: Red/L
barcode string

Barcode
Example: B00000001
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
required_shipping boolean

Shipping or not
Example: true
option2 string

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

Product ID
Example: 16057039432335097907370282
option4 string

The variant corresponds to the value of the option4
option1 string

The variant corresponds to the value of the option1
Example: Red
taxable boolean

Tax collection or not required
Example: true
weight string

Weight
Example: 0.5
weight_unit string

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

Original price
Example: 100
inventory_item_id string

Inventory item ID
Example: 5703943240925324252
option5 string

The variant corresponds to the value of the option5
inventory_policy string

Oversold strategy: deny - Oversold is not allowed, continue - Oversold is allowed
Example: deny
inventory_tracker boolean

Track inventory or not
Example: true
option3 string

The variant corresponds to the value of the option3
price string

Selling price
Example: 90
handle string

Globally unique commodity handle
Example: product-handle
title string

Product title
Example: This is a title
product_id string

Product ID
Example: 16057039432335097907370282

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

product_listing_id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/product_listings/product_listing_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

Specify Product

Response

{
  "product_listing": {
    "status": "active",
    "handle": "my-product-15",
    "updated_at": "2023-08-28T19:19:05+08:00",
    "created_at": "2023-08-28T11:45:53+08:00",
    "template_path": "templates/products/detail.html",
    "body_html": "<p>This is a desription</p>",
    "product_id": "16060878853599197112313144",
    "options": [
      {
        "name": "Size",
        "product_id": "16060878853599197112313144",
        "values": [
          "L",
          "XL",
          "XXL"
        ],
        "values_images": {},
        "id": "16160878853605069127763144"
      },
      {
        "name": "Color",
        "product_id": "16060878853599197112313144",
        "values": [
          "White"
        ],
        "values_images": {},
        "id": "16160878853605069127793144"
      }
    ],
    "published_at": "2023-08-28T11:45:53+08:00",
    "spu": "S000000001",
    "vendor": "Shopline",
    "published_scope": "web",
    "subtitle": "This is a subtitle",
    "variants": [
      {
        "product_id": "16060878853599197112313144",
        "barcode": "T00000001",
        "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",
        "taxable": true,
        "weight_unit": "g",
        "inventory_tracker": true,
        "inventory_policy": "continue",
        "title": "L · White",
        "compare_at_price": "120.00",
        "required_shipping": true,
        "sku": "S00000000101",
        "inventory_item_id": "6087885361949712083",
        "inventory_quantity": 580,
        "option1": "L",
        "id": "18060878853605069127743144",
        "option2": "White",
        "weight": "10.00"
      },
      {
        "price": "100.00",
        "title": "XL · White",
        "weight_unit": "g",
        "id": "18060878853605069127833144",
        "option1": "XL",
        "option2": "White",
        "inventory_policy": "deny",
        "sku": "S00000000102",
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "taxable": true,
        "inventory_quantity": 100,
        "product_id": "16060878853599197112313144",
        "weight": "50.00",
        "image": {
          "alt": "My Product-10",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        },
        "required_shipping": true,
        "inventory_item_id": "6087885361949712081",
        "inventory_tracker": true
      },
      {
        "compare_at_price": "120.00",
        "id": "18060878853605069127893144",
        "required_shipping": true,
        "inventory_item_id": "6087885361949712082",
        "title": "XXL · White",
        "option2": "White",
        "weight_unit": "g",
        "barcode": "B0000000001",
        "image": {
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024",
          "alt": "My Product-10"
        },
        "weight": "50.00",
        "inventory_policy": "deny",
        "price": "100.00",
        "taxable": true,
        "inventory_quantity": 170,
        "inventory_tracker": true,
        "option1": "XXL",
        "product_id": "16060878853599197112313144",
        "sku": "S00000000103"
      }
    ],
    "images": [
      {
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024",
        "alt": "This is a alt"
      }
    ],
    "tags": "Spring,T shirt",
    "title": "My Product 15"
  }
}

Was this article helpful to you?

SHOPLINE

Legal