Sign in
latestOpenAPI 3.0.02026-07-26318168886.7 KB

1675ac12cde7

Gifts

Update Gift

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

put/gifts/{id}

Path parameters

idstring required

Gift ID<br>欲更新資訊的贈品ID

Request body

title_translationsTitleTranslations — unresolved $ref
unlimited_quantityUnlimitedQuantity — unresolved $ref
skuSku — unresolved $ref
costCost — unresolved $ref
weightWeight — unresolved $ref
quantityQuantity — unresolved $ref
media_idsstring[]

Response

OK

idstring

Gift ID<br>贈品ID

status'active' | 'draft'

Gift's Status<br>贈品狀態

skustring

Stock Keeping Unit<br>贈品貨號

quantitynumber

Current Quantity<br>贈品目前庫存

weightnumber

Weight of Gift (kg)<br>贈品重量 (公斤重)

unlimited_quantityboolean

Unlimited gift quantity or not.<br>贈品數量是否無限

updated_atstring

Updated Time<br>贈品更新時間

created_atstring

Created Time<br>贈品創造時間

Example response

{
  "id": "5b3d860559d52419850001bc",
  "status": "active",
  "sku": "gift_a",
  "quantity": 20,
  "weight": 1,
  "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"
      }
    }
  },
  "unlimited_quantity": true,
  "updated_at": "2018-07-05T02:44:59.596+00:00",
  "created_at": "2018-07-05T02:44:21.073+00:00",
  "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
    }
  ],
  "field_titles": [
    {
      "key": "color",
      "label": "Color",
      "name_translations": {
        "en": "Color",
        "zh-hant": "顏色"
      }
    },
    {
      "key": "custom",
      "label": "Custom",
      "name_translations": {
        "en": "Custom1",
        "zh-hant": "自訂1"
      }
    }
  ],
  "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
    }
  ]
}