Home
HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Products

Suggest Edits

GET /v1/products

List of merchant's product sorted by creation time

Request Example

curl --request GET \
     --url '<<api_domain>>/v1/products?sort_by=desc&per_page=24&page=1' \
     --header 'Accept: application/json'

Request Parameters
sort_by Required string asc or desc, sort the list by creation time, default desc
per_page integer the number of item to get back
page integer the page to start fetching, default 1, leave out if uses previous_id
excludes[] array of string
fields[] array of string
id string only show specific products based on ids
e.g. id="in:id_1,id_2,id_3"
previous_id string previous_id of the last fetch item, replace page number if added
include_fields[] string add additional attributes in response
updated_after DateTime UTC time e.g. 2021-01-01 00:00:00
updated_before DateTime UTC time e.g. 2021-01-01 00:00:00

Response Example

{
  "items": [
    {
      "id": "612c7e0638be9e0045dd618b",
      "status": "active",
      "retail_status": "active",
      "title_translations": {
        "zh-hant": "ccc",
        "en": "ccc"
      },
      "price": {
        "cents": 555,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$555",
        "dollars": 555
      },
      "price_sale": {
        "cents": 0,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$0",
        "dollars": 0
      },
      "lowest_price": {
        "cents": 555,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$555",
        "dollars": 555
      },
      "lowest_price_sale": {
        "cents": 0,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "",
        "dollars": 0
      },
      "hide_price": false,
      "same_price": true,
      "cost": {
        "cents": 3333,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$3,333",
        "dollars": 3333
      },
      "member_price": {
        "cents": 0,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$0",
        "dollars": 0
      },
      "flash_price_sets": [],
      "is_preorder": false,
      "preorder_note_translations": {},
      "weight": 5,
      "quantity": 3,
      "unlimited_quantity": false,
      "medias": [
        {
          "images": {
            "favicon_small": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "favicon": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "favicon_large": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "transparent_thumb": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "transparent_large": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "transparent_xlarge": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "original": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "thumb": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            },
            "source": {
              "width": 1800,
              "height": 881,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/612c7df938be9e0045dd618a/original.jpg?1630305785"
            }
          },
          "_id": "612c7df938be9e0045dd618a",
          "alt_translations": {}
        }
      ],
      "detail_medias": [],
      "category_ids": [
        "611cd8b4679a9c00424f4adb"
      ],
      "supplier": null,
      "sku": null,
      "barcode": null,
      "field_titles": [
        {
          "key": "color",
          "label": "顏色",
          "name_translations": {
            "en": "Color",
            "zh-hant": "顏色",
            "zh-hk": "顏色",
            "zh-cn": "颜色",
            "zh-tw": "顏色",
            "vi": "Màu",
            "ms": "warna",
            "ja": "カーラー",
            "th": "สี"
          },
          "index": 0
        }
      ],
      "variations": [
        {
          "id": "61d6bf6b539d27004165fce5",
          "fields_translations": {
            "en": [
              "紅色"
            ],
            "zh-hant": [
              "紅色"
            ],
            "vi": [
              ""
            ]
          },
          "price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "",
            "dollars": 0
          },
          "price_sale": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "member_price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "cost": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "quantity": 1,
          "unlimited_quantity": null,
          "media": null,
          "sku": "1234",
          "location_id": null,
          "variant_option_ids": [
            "61d6bf6b65900f00476d6b4c"
          ],
          "barcode": null,
          "mpn": null,
          "gtin": null,
          "barcode_type": "Code 128",
          "locked_inventory_count": null,
          "weight": 0
        },
        {
          "id": "61d6bf6b539d27004165fce6",
          "fields_translations": {
            "en": [
              "藍色"
            ],
            "zh-hant": [
              "藍色"
            ],
            "vi": [
              ""
            ]
          },
          "price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "",
            "dollars": 0
          },
          "price_sale": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "member_price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "cost": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "quantity": 2,
          "unlimited_quantity": null,
          "media": null,
          "sku": "1235",
          "location_id": null,
          "variant_option_ids": [
            "61d6bf6b65900f00476d6b4d"
          ],
          "barcode": null,
          "mpn": null,
          "gtin": null,
          "barcode_type": "Code 128",
          "locked_inventory_count": null,
          "weight": 0
        }
      ],
      "variant_options": [
        {
          "id": "61d6bf6b65900f00476d6b4c",
          "name_translations": {
            "zh-hant": "紅色",
            "en": "紅色",
            "vi": ""
          },
          "type": "color",
          "media": null,
          "index": 0
        },
        {
          "id": "61d6bf6b65900f00476d6b4d",
          "name_translations": {
            "zh-hant": "藍色",
            "en": "藍色",
            "vi": ""
          },
          "type": "color",
          "media": null,
          "index": 0
        }
      ],
      "categories": [
        {
          "id": "611cd8b4679a9c00424f4adb",
          "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,
          "children": [],
          "created_by": "admin"
        }
      ],
      "location_id": null,
      "summary_translations": {
        "en": "",
        "zh-hant": "",
        "vi": ""
      },
      "description_translations": {
        "en": "",
        "zh-hant": "",
        "vi": ""
      },
      "seo_title_translations": {
        "zh-hant": "ccc",
        "en": "ccc"
      },
      "seo_description_translations": {
        "en": "",
        "zh-hant": "",
        "vi": ""
      },
      "seo_keywords": null,
      "link": "/ccc",
      "is_reminder_active": false,
      "show_custom_related_products": false,
      "related_product_ids": [
        "611dd0c7679a9c00424f4bb6"
      ],
      "tags": [],
      "blacklisted_delivery_option_ids": [],
      "blacklisted_payment_ids": [],
      "max_order_quantity": -1,
      "gender": "unisex",
      "age_group": "all_ages",
      "adult": "no",
      "condition": "new",
      "brand": null,
      "mpn": "",
      "gtin": "",
      "barcode_type": "Code 128",
      "blacklisted_feed_channels": [],
      "updated_at": "2022-01-17T06:59:18.333+00:00",
      "created_at": "2021-08-30T06:43:18.901+00:00",
      "available_start_time": null,
      "available_end_time": null,
      "schedule_publish_at": null,
      "created_by": "admin",
      "is_excluded_promotion": false,
      "taxable": false,
      "labels": [],
      "locked_inventory_count": null,
      "product_price_tiers": [
        {
          "_id": "61c304c254c3f81bbd99cdf7",
          "created_at": "2021-12-22T10:58:10.984+00:00",
          "updated_at": "2021-12-22T10:58:10.984+00:00",
          "member_price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "membership_tier_id": "61543f22eb6b37004978ce4d",
          "product_id": "612c7e0638be9e0045dd618b",
          "status": "active",
          "variation_key": null
        }
      ],
      "out_of_stock_orderable": true,
      "subscription_enabled": false,
      "subscription_period_duration": 30,
      "filter_tags": [
        {
          "id": "612c7f9638be9e0045dd6198",
          "name_translations": {
            "zh-hant": "",
            "en": "volumn"
          }
        },
        {
          "id": "61e513c2bbc40304f4731ae8",
          "name_translations": {
            "en": "bcc",
            "zh-hant": "繁體"
          }
        }
      ]
    },
    {
      "id": "611dd0c7679a9c00424f4bb6",
      "status": "active",
      "retail_status": "active",
      "title_translations": {
        "en": "html51"
      },
      "price": {
        "cents": 1999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$1,999",
        "dollars": 1999
      },
      "price_sale": {
        "cents": 200,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$200",
        "dollars": 200
      },
      "lowest_price": {
        "cents": 1999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$1,999",
        "dollars": 1999
      },
      "lowest_price_sale": {
        "cents": 200,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$200",
        "dollars": 200
      },
      "hide_price": false,
      "same_price": false,
      "cost": {
        "cents": 2999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$2,999",
        "dollars": 2999
      },
      "member_price": {
        "cents": 0,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$0",
        "dollars": 0
      },
      "flash_price_sets": [],
      "is_preorder": false,
      "preorder_note_translations": {},
      "weight": 10,
      "quantity": 43,
      "unlimited_quantity": false,
      "medias": [
        {
          "images": {
            "favicon_small": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "favicon": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "favicon_large": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "transparent_thumb": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "transparent_large": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "transparent_xlarge": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "original": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "thumb": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            },
            "source": {
              "width": 421,
              "height": 421,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/611dd093679a9c00424f4bb5/original.png?1629343891"
            }
          },
          "_id": "611dd093679a9c00424f4bb5",
          "alt_translations": {}
        }
      ],
      "detail_medias": [],
      "category_ids": [],
      "supplier": null,
      "sku": null,
      "barcode": null,
      "field_titles": [],
      "variations": [],
      "variant_options": [],
      "categories": [],
      "location_id": null,
      "summary_translations": {
        "en": ""
      },
      "description_translations": {
        "en": ""
      },
      "seo_title_translations": {
        "en": "html51"
      },
      "seo_description_translations": {
        "en": ""
      },
      "seo_keywords": null,
      "link": "/html51",
      "is_reminder_active": false,
      "show_custom_related_products": false,
      "related_product_ids": [
        "612c7e0638be9e0045dd618b"
      ],
      "tags": [],
      "blacklisted_delivery_option_ids": [
        "611dd04a679a9c00424f4bb1"
      ],
      "blacklisted_payment_ids": [
        "611dd067679a9c00424f4bb3"
      ],
      "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": "2022-01-17T04:50:09.674+00:00",
      "created_at": "2021-08-19T03:32:23.939+00:00",
      "available_start_time": null,
      "available_end_time": null,
      "schedule_publish_at": null,
      "created_by": "admin",
      "is_excluded_promotion": false,
      "taxable": false,
      "labels": [],
      "locked_inventory_count": null,
      "product_price_tiers": [
        {
          "_id": "61c571febed718004669736a",
          "created_at": "2021-12-24T07:08:46.739+00:00",
          "updated_at": "2021-12-24T07:08:46.739+00:00",
          "member_price": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
          },
          "membership_tier_id": "61543f22eb6b37004978ce4d",
          "product_id": "611dd0c7679a9c00424f4bb6",
          "status": "active",
          "variation_key": null
        }
      ],
      "out_of_stock_orderable": false,
      "subscription_enabled": false,
      "subscription_period_duration": 30,
      "filter_tags": []
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 2,
    "total_pages": 1
  }
}
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
{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 ...
{Product}.preorder_note_translations Translation
{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 (Deprecated) refer to {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 Location ID
儲位編號
{Product}.description_translations Translation Product Description
商品描述
{Product}.seo_title_translations Translation SEO Title
SEO標題
{Product}.seo_description_translations Translation SEO Description
SEO簡介
{Product}.seo_keywords String SEO Keyword
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 Excluded Delivery Options
排除的送貨方式
{Product}.blacklisted_payment_ids Array Excluded Payment Options
排除的付款方式
{Product}.gender String Mapping Product Category: Gender
產品使用類別：性別
male 男性
female 女性
* unisex 男女通用
{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 product is available on storefront
{Product}.available_end_time String The datetime the product is removed from storefront, null for never delist
{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 included_fields[]=labels in query string to include in payload
{Product}.locked_inventory_count
{Product}.product_price_tiers[] Array
{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 array of filter tags
自訂篩選條件
pagination Pagination

Updated over 2 years ago