Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Products

Get Product

To get detailed information for a specific product with its ID<br>使用商品ID獲取特定一個商品的詳細資料

get/products/{id}

Path parameters

idstring required

Product's ID<br>商品ID

Query parameters

fields[]string[]

Could only show certain parameters in the response<br>結果只顯示哪些參數

[
  "id"
]
excludes[]string[]

Could exclude certain parameters in the response<br>結果要排除哪些參數

[
  "id"
]
include_fields[]string[]

Provide additional attributes in the response<br>結果添加哪些參數

Response

OK

idstring

Product's ID<br>商品ID

status'active' | 'draft' | 'removed' | 'hidden'

Product's status<br>商品狀態<br>-<br>true: Published 上架<br> false: Unpublished 下架<br>"active": Published 上架<br>"draft": Unpublished 下架<br> "hidden": hidden 隱藏<br><br>Default: false

retail_status'active' | 'draft'

POS product's status<br>POS商品狀態<br>-<br> "active": Published 上架<br> "draft": Unpublished 下架<br><br> Default: active

hide_priceboolean

Hide Price to customers<br>隱藏價格<br>-<br>*Default: false

same_priceboolean

Main Product and Variation Product share the same price (Including original price and member price) <br>規格商品是否皆同主商品價格，包含原價格與會員價<br> 1. If same price is true, main product price is required and will be apply to all variation prices<br> 2. If same price is false, variation price is required and each variation can apply different prices.

is_preorderboolean

Pre-ordered or not<br>是否開放預購

preorder_limitinteger

Pre-ordere Limit<br>預購上限

weightnumber

Product's Weight (kg)<br>商品重量 (公斤)

quantitynumber

Product's Current quantity<br>商品目前數量<br>-<br> *If unlimited_quantity is true, the product has unlimited quantity<br> regardless of the quantity showing here

total_orderable_quantitynumber

Product's Current total orderable quantity<br>商品目前可購買總數量<br>-<br> *If unlimited_quantity is true or out_of_stock_orderable is true<br> this field will return -1

unlimited_quantitytrue | false

Unlimited product quantity or not.<br>商品數量是否無限

category_idsstring[]

Categories' IDs<br>商品所屬分類之ID

supplierstring

Supplier<br>供應商

skustring

Stock Keeping Unit<br>商品貨號

barcodestring

Product's Barcode<br>商品條碼編號

quantity_soldinteger

Product's Quantity Sold<br>商品銷售數量

barcode_type'Code 128' | 'Bookland EAN' | 'ISBN'

Barcode type<br>商品條碼編號類別

location_idstring

Stock Unit Number<br>儲位編號

seo_keywordsstring

Keywords of SEO<br>SEO關鍵字<br> *Keywords should be separated by commas (,) max length 160 characters.<br> 關鍵字以逗號(,)分隔, 最長 160字

linkstring
is_reminder_activeboolean

Out-Of-Stock Reminder<br>商品缺貨是否提醒

show_custom_related_productstrue | false

Show Custom Related products<br>顯示相關商品

related_product_idsstring[]

Custom related products<br>自訂相關商品

tagsstring[]

Tags<br>標籤<br> *Tags are used to search products at the admin panel and help set up the product-related coupons.<br> 標籤功能用作商品搜尋，並能為指定商品設置優惠券的用途。

blacklisted_delivery_option_idsstring[]

Excluded Delivery Options<br>排除的送貨方式

blacklisted_payment_idsstring[]

Excluded Payment<br>Options<br>排除的付款方式

max_order_quantityinteger

set maximum quantity per purchase for this product<br> 商品單次購買上限<br> *-1 represents there's no quantity limit for each purchase<br> -1代表無商品單次購買的上限

genderstring

Mapping Product Category: Gender<br>產品使用類別：性別<br> male 男性<br> female 女性<br>* unisex 男女通用

age_groupstring

Mapping Product Category:Age Group<br>產品使用類別：年齡層<br> newborn 新生兒<br> infant 嬰兒<br> toddler 幼兒<br> kids兒童<br>* Adult 成人

adultstring

Mapping Product Category:Adult<br>產品使用類別：成人<br> yes 是<br> no 否

conditionstring

Mapping Product Category:Condition<br>產品使用類別：狀況<br> used 二手<br> refurbished 整新品<br>* new 新品

brandstring

Brand<br>商品品牌

mpnstring

Manufacturer Part Number<br>製造編號

gtinstring

Barcode<br>商品條碼編號

blacklisted_feed_channelsstring[]

排除這個商品投放管道<br>Exclude this product to channel

updated_atstring

Last Updated Time<br>商品最後更新時間

created_atstring

Product Created Time<br>商品創建時間

available_start_timestring
available_end_timestring
created_bystring
is_excluded_promotionboolean

product is exclude promotion which is discount on order<br>不適用全店折扣的優惠是否開啟

taxableboolean

taxable<br>是否收稅

locked_inventory_countnumber
schedule_publish_atstring
metafieldsobject

metafields<br>only show if include_fields[]=metafields

out_of_stock_orderableboolean

out_of_stock_orderable<br>缺貨時是否可接單

subscription_enabledboolean

subscription_enabled<br>是否為定期購商品。

subscription_period_durationinteger

subscription_period_duration<br>定期購天數

subscription_recurring_count_limitinteger

Subscription recurring count limit<br>定期購期數

typestring

product type<br>商品型別<br> Only provided when include_fields contains 'type'<br> 僅於include_fields傳入 'type' 時提供

tax_typestring

Tax type<br>國內稅項

oversea_tax_typestring

Oversea tax type<br>海外稅項

allow_giftboolean

Specifies whether the item can be set as a gift.<br> 是否可以設為贈品<br> true: the product can be set as a gift.<br> false: the product cannot be set as a gift.

is_customboolean

Specifies whether the item can be set as a customized product.<br>是否可以設為訂制商品<br> true: the product is custom product.<br> false: the product isn't custom product.

sold_outboolean

Indicates whether the product is sold out.<br> 商品是否售罄.<br> true: the product is sold out. 已售罄<br> false: the product is still available. 尚有庫存<br>

cart_tag_idstring

Product Attribute ID<br>商品屬性設置 id<br> This field is unavailable when you get a product detail<br> 取得商品詳細資訊時不提供

cart_tagobject

Product Attribute<br>商品屬性設置<br> This field is only available when you get a product detail<br> 僅於取得商品詳細資訊時提供

Example response

{
  "id": "5d3594c276e7ec003b7021c0",
  "status": "active",
  "retail_status": "active",
  "title_translations": {
    "en": "testing SL-8049",
    "zh-hant": "測試 SL-8049 round 2"
  },
  "summary_translations": {
    "en": "testing SL-8049",
    "zh-hant": "測試 SL-8049 round 2"
  },
  "price": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "price_sale": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "lowest_price": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "lowest_price_sale": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "same_price": true,
  "cost": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "member_price": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "retail_price": {
    "cents": 999999999,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$999,999,999",
    "dollars": 999999999
  },
  "flash_price_sets": [
    {
      "price_set": {
        "price": {
          "cents": 999999999,
          "currency_symbol": "NT$",
          "currency_iso": "TWD",
          "label": "NT$999,999,999",
          "dollars": 999999999
        },
        "price_sale": {
          "cents": 999999999,
          "currency_symbol": "NT$",
          "currency_iso": "TWD",
          "label": "NT$999,999,999",
          "dollars": 999999999
        },
        "price_details": [
          {
            "price": {
              "cents": 999999999,
              "currency_symbol": "NT$",
              "currency_iso": "TWD",
              "label": "NT$999,999,999",
              "dollars": 999999999
            },
            "price_sale": {
              "cents": 999999999,
              "currency_symbol": "NT$",
              "currency_iso": "TWD",
              "label": "NT$999,999,999",
              "dollars": 999999999
            }
          }
        ]
      }
    }
  ],
  "preorder_limit": 1,
  "preorder_note_translations": {
    "en": "Shipping starts April 20th, 1971, preorder NOW!",
    "zh-hant": "1971/04/20 開始出貨, 立即訂購!"
  },
  "weight": 123.99,
  "quantity": 87,
  "total_orderable_quantity": 87,
  "medias": [
    {
      "id": "5f8e5dc08a8bb70a5c9cd93c",
      "alt_translations": {
        "en": "Image ALT",
        "zh-hant": "圖片ALT"
      },
      "images": {
        "original": {
          "width": 800,
          "height": 800,
          "url": "https://img.example.com/media/1234/thumb.jpg"
        }
      }
    }
  ],
  "detail_medias": [
    {
      "id": "5f8e5dc08a8bb70a5c9cd93c",
      "alt_translations": {
        "en": "Image ALT",
        "zh-hant": "圖片ALT"
      },
      "images": {
        "original": {
          "width": 800,
          "height": 800,
          "url": "https://img.example.com/media/1234/thumb.jpg"
        }
      }
    }
  ],
  "category_ids": [
    "5be90603d1270b4032bed8b4"
  ],
  "sku": "sku_123345",
  "field_titles": [
    {
      "key": "color",
      "label": "Color",
      "name_translations": {
        "en": "Color",
        "zh-hant": "顏色"
      },
      "selectorEnabled": false
    },
    {
      "key": "custom",
      "label": "Custom",
      "name_translations": {
        "en": "Custom1",
        "zh-hant": "自訂1"
      },
      "selectorEnabled": false
    }
  ],
  "variations": [
    {
      "id": "5d3594c2e95d2f000642e011",
      "price": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "price_sale": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "member_price": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "retail_price": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "cost": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "quantity": 100,
      "total_orderable_quantity": 100,
      "preorder_limit": 1,
      "media": {
        "id": "5f8e5dc08a8bb70a5c9cd93c",
        "alt_translations": {
          "en": "Image ALT",
          "zh-hant": "圖片ALT"
        },
        "images": {
          "original": {
            "width": 800,
            "height": 800,
            "url": "https://img.example.com/media/1234/thumb.jpg"
          }
        }
      },
      "sku": "green_l1",
      "location_id": "LaB123",
      "feed_variations": {
        "color": {
          "zh-hant": "紅色",
          "en": "red"
        },
        "size": {
          "zh-hant": "xs",
          "en": "xs"
        }
      },
      "variant_option_ids": [
        "5d3594c2622a56618082c99f",
        "5d3594c2622a56618082c9a0"
      ],
      "locked_inventory_count": 10,
      "weight": 1.2
    }
  ],
  "variant_options": [
    {
      "id": "5d3594c2622a56618082c99f",
      "name_translations": {
        "en": "green",
        "zh-hant": "綠"
      },
      "type": "custom",
      "media": {},
      "index": 0
    },
    {
      "id": "5d3594c2622a56618082c9a0",
      "name_translations": {
        "en": "L1",
        "zh-hant": "大1"
      },
      "type": "custom",
      "media": {},
      "index": 1
    },
    {
      "id": "5d3594c2622a56618082c9a1",
      "name_translations": {
        "en": "S1",
        "zh-hant": "小1"
      },
      "type": "custom",
      "media": {},
      "index": 1
    },
    {
      "id": "5d3594c2622a56618082c9a2",
      "name_translations": {
        "en": "Red",
        "zh-hant": "紅"
      },
      "type": "custom",
      "media": {},
      "index": 0
    }
  ],
  "location_id": "shoplineabc",
  "feed_category": {
    "google_category_id": "animals_pet_supplies",
    "google_option_id": "live_animals",
    "google_product_category": "Animals & Pet Supplies > Live Animals"
  },
  "feed_variations": {
    "color": "red",
    "size": "small",
    "material": "gold"
  },
  "seo_keywords": "電商, 開店, 創業",
  "related_product_ids": [
    "5d3593cd5722660032e8fbed",
    "5d355b7b0e5da9001741ac2c"
  ],
  "max_order_quantity": 4,
  "blacklisted_feed_channels": [
    "google"
  ],
  "updated_at": "2020-12-09T07:15:06.813+00:00",
  "created_at": "2020-11-23T02:31:32.926+00:00",
  "created_by": "openapi",
  "is_excluded_promotion": true,
  "taxable": true,
  "labels": [
    {
      "en": "ABC",
      "zh-hant": "ddd"
    }
  ],
  "locked_inventory_count": 10,
  "schedule_publish_at": "2020-11-23T02:31:32.926+00:00",
  "product_price_tiers": [
    {
      "_id": "610cdc702c1c120047c3519c",
      "created_at": "2021-08-06T06:55:45.471Z",
      "updated_at": "2021-08-06T06:55:45.471Z",
      "member_price": {
        "cents": 999999999,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$999,999,999",
        "dollars": 999999999
      },
      "membership_tier_id": "5de6192b9a8b7900365abb5b",
      "product_id": "5d3594c276e7ec003b7021c0",
      "status": "active",
      "variation_key": "610cdcf19f09bc003a2139a4"
    }
  ],
  "metafields": {
    "namespace": {
      "key1": "value",
      "key2": 3,
      "key3": {
        "json": "object"
      }
    }
  },
  "subscription_enabled": true,
  "subscription_period_duration": 30,
  "subscription_recurring_count_limit": 5,
  "filter_tags": [
    {
      "id": "5d3594c2e95d2f000642e011"
    }
  ],
  "bundle_set": {
    "price_type": "fixed_amount",
    "discount_value": 20,
    "bundle_set_products": {
      "6200c988dcf97a004b22ec26": {
        "min_quantity": 1
      }
    }
  },
  "type": "product",
  "allow_gift": true,
  "is_custom": true,
  "sold_out": true,
  "cart_tag_id": "63ec73c11ac51b368c74b92b",
  "cart_tag": {
    "id": "63ec73c11ac51b368c74b92b",
    "name_translations": {
      "en": "",
      "zh-hant": "一車常溫"
    },
    "priority": 1
  }
}