---
title: "Update Gift"
method: PUT
path: "/gifts/{id}"
tags: ["Gifts"]
---

# Update Gift

`PUT /gifts/{id}`

To update information about existing gift with open API.<br>透過open API 更新贈品

## Path parameters

- `id` string, required

## Request body

- object
  - `title_translations` TitleTranslations — unresolved $ref
  - `unlimited_quantity` UnlimitedQuantity — unresolved $ref
  - `sku` Sku — unresolved $ref
  - `cost` Cost — unresolved $ref
  - `weight` Weight — unresolved $ref
  - `quantity` Quantity — unresolved $ref
  - `media_ids` string[]

## Response `200`

OK

- Gift
  - `id` string — Gift ID<br>贈品ID
  - `status` 'active' | 'draft' — Gift's Status<br>贈品狀態
  - `title_translations` object — Title Translations<br>贈品名稱
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `sku` string — Stock Keeping Unit<br>贈品貨號
  - `quantity` number — Current Quantity<br>贈品目前庫存
  - `cost` object — Cost of Gift<br>贈品成本
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `weight` number — Weight of Gift (kg)<br>贈品重量 (公斤重)
  - `medias` object — Media Data<br>媒體(照片)資訊
    - `id` string — Media ID
    - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
  - `unlimited_quantity` boolean — Unlimited gift quantity or not.<br>贈品數量是否無限
  - `updated_at` string — Updated Time<br>贈品更新時間
  - `created_at` string — Created Time<br>贈品創造時間
  - `variations` ProductVariation[] — Product Variations Data<br>商品規格資訊
    - `id` string — Product Variation's ID<br>規格 ID
    - `fields_translations` object — Field Translation<br>規格名稱
      - `en` string[] — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string[] — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string[] — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string[] — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string[] — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string[] — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string[] — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string[] — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string[] — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string[] — Merchant defined France name<br>店家定義法文名稱
    - `price` object — Price<br>原價格
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `price_sale` object — Price on sale<br>特價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `member_price` object — Member Price<br>會員價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `retail_price` object — Retail Price<br>零售價<br> Only provided when include_fields contains 'retail_price'<br> 僅於include_fields傳入 'retail_price' 時提供
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `cost` object — Cost<br>成本價
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
    - `quantity` number — Product variation's current quantity<br>規格現有數量
    - `total_orderable_quantity` number — Product variation's current orderable quantity<br>規格現有可購買數量
    - `unlimited_quantity` boolean — Whether the variation has unlimited quantity or not.<br>規格是否有無限數量<br>*Please check the main product's unlimited_quantity to see whether variation has unlimited quantity or not.<br><br>unlimited_quantity of variation will always shows null
    - `preorder_limit` integer — Pre-ordere Limit<br>預購上限
    - `media` object — Media Data<br>圖片資料
      - `id` string — Media ID
      - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
    - `sku` string — Stock Keeping Unit<br>貨號
    - `location_id` string — Location ID<br>儲位編號
    - `feed_variations` object — Default variations for product feed<br>廣告規格<br> 當商品為多規格並且規格中有設置color、size時，此时color、size為json。<br> 當商品規格中未設置color、size，但商家有在產品規格摘要頁麵填冩color、size時，此時color、size爲純字串<br>
      - `color` object
      - `size` object
      - `material` string
    - `variant_option_ids` string[] — ID of the corresponding variant options<br>對應規格類別 ID
    - `barcode` string — Barcode<br>商品條碼編號
    - `mpn` string — Manufacturer Part Number<br>製造編號
    - `gtin` string — Barcode<br>商品條碼編號
    - `barcode_type` 'Code 128' | 'Bookland EAN' | 'ISBN' — Barcode type<br>商品條碼編號類別
    - `locked_inventory_count` number
    - `weight` number — Weight (kg)<br>重量 (公斤)
  - `field_titles` object[] — Field Title Data<br>規格名稱
    - `key` string
    - `label` string
    - `name_translations` Translatable
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `variant_options` object[] — Product Variations<br>商品規格<br>-<br> Maximum 3 types of variant option for a product, type allow (color, size, custom_1, custom_2, custom_3)<br> 最多支援三種不同的 type, type 支援(color, size, custom_1, custom_2, custom_3)<br>
    - `id` string
    - `name_translations` Translatable
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `type` 'color' | 'size' | 'custom_1' | 'custom_2' | 'custom_3'
    - `media` object
    - `index` integer

## Other responses

- `400` — Bad Request
- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)
