Home
HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Product

Suggest Edits

GET /v1/products/:id

List of merchant's product sorted by creation time

Request Example

curl -X GET \
  '<<api_domain>>/v1/products/5d3594c276e7ec003b7021c0' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearar {access_token}' \
  -H 'User-Agent: shopline'

Request Parameters
id Required string Product id e.g. 5d3594c276e7ec003b7021c0
excludes[] String Could exclude certain parameters in the response
e.g. &excludes[]=field1&excludes[]=field2
includes[] integer Could only show certain parameters in the response
e.g. &includes[]=field1&includes[]=field2 - product_price_tiers to show product_price_tiers

Response Example

{
    "id": "60e67855ec0924001183dabe",
    "status": "active",
    "title_translations": {
        "en": "Scandinavian Vase"
    },
    "price": {
        "cents": 30000,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "HK$300.00",
        "dollars": 300.0
    },
    "price_sale": {
        "cents": 0,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "",
        "dollars": 0.0
    },
    "lowest_price": {
        "cents": 30000,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "HK$300.00",
        "dollars": 300.0
    },
    "lowest_price_sale": {
        "cents": 0,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "",
        "dollars": 0.0
    },
    "hide_price": false,
    "same_price": false,
    "cost": {
        "cents": 4000,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "HK$40.00",
        "dollars": 40.0
    },
    "member_price": {
        "cents": 29000,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "HK$290.00",
        "dollars": 290.0
    },
    "flash_price_sets": [],
    "is_preorder": false,
    "preorder_note_translations": {},
    "weight": 0.0,
    "quantity": 9,
    "unlimited_quantity": false,
    "medias": [
        {
            "images": {
                "favicon_small": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "favicon": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "favicon_large": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "transparent_thumb": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "transparent_large": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "transparent_xlarge": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "original": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "thumb": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                },
                "source": {
                    "width": 323.0,
                    "height": 430.0,
                    "url": "https://img.shoplineapp.com/media/image_clips/60e671361658610038056487/original.jpg?1625714998"
                }
            },
            "_id": "60e671361658610038056487",
            "alt_translations": {}
        }
    ],
    "detail_medias": [],
    "category_ids": [
        "60d2f2a0952ea6002ae1588c"
    ],
    "supplier": null,
    "sku": "sku0001",
    "barcode": null,
    "field_titles": [],
    "variations": [
      {
        "id": "61ea88da88f18d00332ca4aa",
        "fields_translations": {
        	"en": [
         	  "heavy",
          	"long"
        	],
        	"zh-hant": [
          	"重",
          	"長"
        	]
      	},
        "price": {
        	"cents": 99900,
          "currency_symbol": "HK$",
          "currency_iso": "HKD",
          "label": "HK$999.00",
          "dollars": 999.0
        },
        "price_sale": {
          "cents": 88800,
          "currency_symbol": "HK$",
          "currency_iso": "HKD",
          "label": "HK$888.00",
          "dollars": 888.0
        },
        "member_price": {
          "cents": 0,
          "currency_symbol": "HK$",
          "currency_iso": "HKD",
          "label": "",
          "dollars": 0.0
        },
        "cost": {
          "cents": 0,
          "currency_symbol": "HK$",
          "currency_iso": "HKD",
          "label": "",
          "dollars": 0.0
        },
        "quantity": 0,
        "unlimited_quantity": null,
        "media": {},
        "sku": "hl",
        "location_id": null,
        "variant_option_ids": [
          "61ea88dae3f5280039990e24",
          "61ea8842e3f528003c990e24"
        ],
        "barcode": null,
        "mpn": null,
        "gtin": "26849325",
        "barcode_type": "Code 128",
        "weight": 2.0
      }
    ],
    "variant_options": [
      {
        "id": "61ea88dae3f5280039990e24",
        "name_translations": {
          "zh-hant": "heavy",
          "en": ""
        },
        "type": "custom",
        "media": {},
        "index": 0
      },
      {
        "id": "61ea8842e3f528003c990e24",
        "name_translations": {
          "zh-hant": "long",
          "en": ""
        },
        "type": "custom",
        "media": {},
        "index": 1
      },
    ],
    "categories": [
        {
            "id": "60d2f2a0952ea6002ae1588c",
            "name_translations": {
                "en": "Featured Products",
                "zh-hant": "精選商品",
                "zh-hk": "精選商品",
                "zh-cn": "精选商品",
                "zh-tw": "精選商品",
                "vi": "Sản phẩm nổi bật",
                "ms": "Produk Terpilih",
                "ja": "おすすめ商品",
                "th": "สินค้าแนะนำ",
                "id": "Produk Unggulan",
                "de": "Empfohlene Produkte",
                "fr": "Produits à la une"
            },
            "seo_title_translations": {},
            "seo_description_translations": {},
            "seo_keywords": null,
            "key": "featured_products",
            "status": "active",
            "banner_medias": [],
            "parent_id": null,
            "priority": 1.0,
            "created_by": "admin"
        }
    ],
    "location_id": null,
    "summary_translations": {
        "en": "This is my Scandinavian Vase from taobao\nhttps://detail.tmall.com/item.htm?spm=a230r.1.14.79.637f174dSejiXN&id=602424427218&ns=1&abbucket=19&skuId=4402518762240"
    },
    "description_translations": {
        "en": "this is my product description",
        "zh-hant": ""
    },
    "seo_title_translations": {
        "en": "Scandinavian Vase"
    },
    "seo_description_translations": {
        "en": ""
    },
    "seo_keywords": null,
    "link": "/scandinavian-vase",
    "is_reminder_active": false,
    "show_custom_related_products": false,
    "related_product_ids": [
        "60ee6081fa71ba003ea3f0aa"
    ],
    "tags": [
        "northern-europe",
        "decoration"
    ],
    "blacklisted_delivery_option_ids": [],
    "blacklisted_payment_ids": [],
    "max_order_quantity": -1,
    "gender": "unisex",
    "age_group": "all_ages",
    "adult": "no",
    "condition": "new",
    "brand": null,
    "mpn": null,
    "gtin": null,
    "barcode_type": "Code 128",
    "blacklisted_feed_channels": [],
    "updated_at": "2021-08-09T05:09:58.661+00:00",
    "created_at": "2021-07-08T04:00:21.991+00:00",
    "available_start_time": null,
    "available_end_time": null,
    "schedule_publish_at": null,
    "created_by": "admin",
    "is_excluded_promotion": false,
    "taxable": false,
    "out_of_stock_orderable": false,
    "subscription_enabled": false,
    "subscription_period_duration": 30,
    "filter_tags": []
}
items Array of Product
{Product}.id String product id
{Product}.status String the status of the product
active: published
draft: unpublished
hidden: hidden, only can be found with specific link
{Product}.title_translations Translation Json Object with key is the language code and value is the translation string
{Product}.price Price Price of the product
{Product}.lowest_price Price Lowest price of the product considering all variation
{Product}.price_sale Price On sale price of the product
{Product}.lowest_price_sale Price Lowest on sale price of the product considering all variation
{Product}.hide_price Boolean hiding the price means product should only be allow to buy via communication with merchant, recommend to hide buy button on frontend
{Product}.same_price Boolean if all variants have the same price, the value would be true
{Product}.cost Price cost of the item
{Product}.member_price Price price of the item for member
{Product}.flash_price_sets[] Array price for flash campaign
限時促銷價
{Product}.flash_price_sets[].id String
{Product}.flash_price_sets[].start_at ISOString flash price start time in UTC
{Product}.flash_price_sets[].end_at ISOString flash price end time in UTC
{Product}.flash_price_sets[].price_set Object
{Product}.flash_price_sets[].price_set.type String enum flash_price or pos, but flash_price_set only contains flash_price
{Product}.flash_price_sets[].price_set.flash_price_campaign_id String flash price campaign id
{Product}.flash_price_sets[].price_set.price Price flash price pricing object
{Product}.flash_price_sets[].price_set.price_sale Price flash price sale price object
{Product}.flash_price_sets[].price_set.price_details Array
{Product}.is_preorder Boolean Pre-ordered or not
是否開放預購
{Product}.preorder_note_translations Translation Pre-order Note Info
預購資訊
{Product}.weight Integer weight of the product
{Product}.quantity Integer Quantity of product
{Product}.unlimited_quantity Boolean
{Product}.medias Array Media Data
媒體(照片)資訊
{Product}.detail_medias Array Additional Product Photos 更多商品圖片 Maximum 20 images for a product. 最多 20 張圖片
{Product}.category_ids Array Array of category id
{Product}.supplier String Product supplier
{Product}.sku String Product sku
{Product}.barcode String (deprecating) use {Product}.gtin
{Product}.field_titles String Field Title Data 規格名稱
{Product}.variations Array Product Variations Data 商品規格資訊
{Product}.variant_options Array Product Variations
商品規格
-
Maximum 3 types of variant option for a product, type allow (color, size, custom_1, custom_2, custom_3) 最多支援三種不同的 type, type 支援(color, size, custom_1, custom_2, custom_3)
{Product}.categories Array Categories Data 商品分類資訊
{Product}.location_id String 儲位編號
{Product}.description_translations Translation Product Description
商品描述
{Product}.seo_title_translations Translation SEO Title
SEO標題
{Product}.seo_description_translations Translation ...
{Product}.seo_keywords String SEO Description
SEO簡介
{Product}.link String
{Product}.is_reminder_active Boolean Out-Of-Stock Reminder
商品缺貨是否提醒
{Product}.show_custom_related_products Boolean Show Custom Related products
顯示相關商品
{Product}.related_product_ids Array Custom related products
自訂相關商品
{Product}.tags Array Tags
標籤
*Tags are used to search products at the admin panel and help set up the product-related coupons.
標籤功能用作商品搜尋，並能為指定商品設置優惠券的用途。
{Product}.blacklisted_delivery_option_ids Array ...
{Product}.blacklisted_payment_ids Array Excluded Delivery Options 排除的送貨方式
{Product}.gender String Excluded Payment Options
排除的付款方式
{Product}.age_group String Mapping Product Category:Age Group
產品使用類別：年齡層
newborn 新生兒
infant 嬰兒
toddler 幼兒
kids兒童
* Adult 成人
{Product}.adult String Mapping Product Category:Adult
產品使用類別：成人
yes 是
no 否
{Product}.condition String Mapping Product Category:Condition
產品使用類別：狀況
used 二手
refurbished 整新品
* new 新品
{Product}.brand String Brand 商品品牌
{Product}.mpn String Manufacturer Part Number
製造編號
{Product}.gtin String Barcode
商品條碼編號
{Product}.blacklisted_feed_channels Array 排除這個商品投放管道
Exclude this product to channel
{Product}.available_start_time String The datetime the product available on storefront
{Product}.available_end_time String The datetime the product is removed from storefront or null for listing without removal
{Product}.created_by ISOString
{Product}.is_excluded_promotion Boolean product is exclude promotion which is discount on order
不適用全店折扣的優惠是否開啟
{Product}.taxable Boolean taxable
是否收稅
{Product}.labels Array Array of TranslationArray of Translation,
must have include_fields[]=labels in query string to include in payload
{Product}.locked_inventory_count ... ...
{Product}.product_price_tiers[] Array only show if includes[] query string has product_price_tiers
{Product}.product_price_tiers[]._id String id of product price tier
{Product}.product_price_tiers[].member_price Price
{Product}.product_price_tiers[].membership_tier_id String id of membership tier
{Product}.product_price_tiers[].product_id String
{Product}.product_price_tiers[].status String
{Product}.out_of_stock_orderable Boolean orderable for out of stock
缺貨時是否可接單
{Product}.subscription_enabled Boolean subscription_enabled
是否為定期購商品
{Product}.subscription_period_duration Integer subscription period duration
定期購天數
{Product}.filter_tags Array filter tags
自訂篩選條件

Updated almost 3 years ago