Query single product

Requires read_products access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/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
[]
Unique product identifier. Maximum limit：64
[]
Example: 16049619743346320200470282

Query Parameters

fields string
[]
Return fields , 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
[]
Product description.
Maxmum size：512 k
[]
Example: This is a description
created_at string
[]
Create time of the product. The time format follows the ISO 8601 international standard.
[]
Example: 2021-09-02T14:11:54+00:00
handle string
[]
The collection handle, a unique identifier automatically generated based on the collection title. Changing the collection title will not update the handle.
[]
Example: product-handle
id string
[]
Product ID
[]
Example: 16049619743346320200470282
imageobject
[]
Product first image
alt string
[]
Image alt
[]
Example: This is a image alt
id string
[]
Image id
[]
Example: 5785060242207917075
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
imagesobject[]
[]
Images
alt string
[]
Image alt
[]
Example: alt
id string
[]
Image id
[]
Example: 5785060242207917075
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
optionsobject[]
[]
List of option
id string
[]
Option id
[]
Example: 16158068291703878544960282
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]
path string
[]
The relative path of the product URL in the online store, max 512 characters.
[]
Example: /my_product
product_behavior string
[]
Product behavior
[]
Example: RISK,HIDDEN
product_category string
[]
Product type
[]
Example: Electronic
product_type string
[]
Product type: NORMAL, POD_TEMPORARY, TEMPORARY
[]
Example: NORMAL
published_at string
[]
Time to post to online stores. The time format follows the ISO 8601 international standard.
[]
Example: 2021-09-02T14:11:54+00: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
[]
subtitle
[]
Example: This is a subtitle
tags string
[]
Tag
[]
Example: tag1, tag2
template_path string
[]
Theme template
[]
Example: templates/products/detail.json
title string
[]
title
[]
Example: This is a title
updated_at string
[]
Update time of the product. The time format follows the ISO 8601 international standard.
[]
Example: 2021-09-02T14:11:54+00:00
variantsobject[]
[]
Variant list
barcode string
[]
Barcode
[]
Example: T00000001
compare_at_price string
[]
Original price. The price value is rounded to two decimal places.
[]
Example: 99
id string
[]
Variant id
[]
Example: 18057039439794751459380282
imageobject
[]
Variant image
alt string
[]
Image alt
[]
Example: alt
id string
[]
Image id
[]
Example: 5785060242207917075
src string
[]
Image src
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
inventory_item_id string
[]
Inventory item id
[]
Example: 59854602422372317075
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: 99
inventory_tracker boolean
[]
Track the inventory or not.

true：Tracking enabled

false：Tracking disabled

Default value
.
[]
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. The price value is rounded to two decimal places.
[]
Example: 90
product_id string
[]
Product ID
[]
Example: 16057039432335097907370282
require_shipping boolean
[]
Shipping or not.

true：Requires shipping

false：Does not require shipping

Default value
.
[]
Example: true
sku string
[]
SKU code
[]
Example: S00000001
taxable boolean
[]
Tax collection or not required.

true：Required

false：Not required

Default value
.
[]
Example: true
title string
[]
Variant title
[]
Example: Red/L
weight string
[]
Weight
[]
Example: 0.2
weight_unit string
[]
Weight units : g , kg , lb , oz , zh_kg
[]
Example: kg
vendor string
[]
Product vendor
[]
Example: Shopline

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

product_id — path required

Authorization — header required

fields — query

Language

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

Examples

Query all

Response

{
  "product": {
    "body_html": "<p>Thisisadesription</p>",
    "created_at": "2023-08-29T14:59:58+08:00",
    "handle": "my-product-23-1",
    "id": "16060895302856191591063144",
    "image": {
      "alt": "Thisisaimagealt",
      "id": "6089530275430875206",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
    },
    "images": [
      {
        "alt": "Thisisaimagealt",
        "id": "6089530275430875206",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
      },
      {
        "alt": "This is a image alt",
        "id": "6089563432963689533",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
      }
    ],
    "options": [
      {
        "id": "16160895302863070249763144",
        "name": "Size",
        "product_id": "16060895302856191591063144",
        "values": [
          "L",
          "S",
          "XL",
          "XXL"
        ],
        "values_images": {}
      },
      {
        "id": "16160895302863070249793144",
        "name": "Color",
        "product_id": "16060895302856191591063144",
        "values": [
          "White"
        ],
        "values_images": {}
      }
    ],
    "product_behavior": "",
    "product_category": "Clothes",
    "product_type": "NORMAL",
    "published_at": "2023-08-29T14:59:58+08:00",
    "published_scope": "web",
    "spu": "S000000001",
    "status": "active",
    "subtitle": "Thisisasubtitle",
    "tags": "Spring,Tshirt",
    "title": "MyProduct25",
    "updated_at": "2023-08-29T14:59:59+08:00",
    "variants": [
      {
        "barcode": "T0000001",
        "compare_at_price": "99.00",
        "id": "18060895302863070249743144",
        "image": {
          "alt": "my image alt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379429",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "L",
        "option2": "White",
        "price": "90.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S0000001",
        "taxable": true,
        "title": "L · White",
        "weight": "0.20",
        "weight_unit": "kg"
      },
      {
        "barcode": "T0000001",
        "compare_at_price": "99.00",
        "id": "18060895634402500988513144",
        "image": {
          "alt": "This is a image alt",
          "id": "6089563432963689533",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089563439612587791",
        "inventory_policy": "continue",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "S",
        "option2": "White",
        "price": "90.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S0000001",
        "taxable": true,
        "title": "S · White",
        "weight": "0.50",
        "weight_unit": "kg"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060895302863070249833144",
        "image": {
          "alt": "Thisisaimagealt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379430",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "XL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S00000000102",
        "taxable": true,
        "title": "XL · White",
        "weight": "50.00",
        "weight_unit": "g"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060895302863070249893144",
        "image": {
          "alt": "Thisisaimagealt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379428",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "XXL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S00000000103",
        "taxable": true,
        "title": "XXL · White",
        "weight": "50.00",
        "weight_unit": "g"
      }
    ],
    "vendor": "Shopline"
  }
}

Was this article helpful to you?

SHOPLINE

Legal