v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Delivery Options

Get Delivery Option

To get delivery option information by inputing delivery option ID 輸入送貨方式ID取得該送貨方式資訊

get/delivery_options/{id}

Path parameters

idstring required

Delivery Option ID 物流方式ID

Response

idstring

Delivery Option ID 送貨方式ID

status'active' | 'draft'

Delivery Option Status 送貨方式狀態 - Status allows: active 啟用中 draft 隱藏

requires_customer_addressboolean

Requires Customer Address 需要顧客提供地址

show_description_on_checkoutboolean

Display description on the checkout page 在結帳頁面上顯示送貨方式簡介

fee_type'flat' | 'flat_weight' | 'subtotal' | 'item_count' | 'sl_logistic'

Fee Type 收費模式 - Fee type allow: flat flat_weight subtotal item_count * sl_logistic

form_fieldsobject[]

region_typestring

Delivery Option Code 送貨方式代碼 store_pickup: 門市自取 custom: 自訂 sfexpress: 順豐速運 tw_711_nopay: 7-11 取貨不付款 (C2C) tw_711_pay: 7-11 取貨付款 (C2C) tw_711_b2c_nopay: 7-11 取貨不付款 (B2C) tw_711_b2c_pay: 7-11 取貨付款 (B2C) emap_only_711: 7-11 超商取貨 (純地圖) tw_simple_711: 7-11 取貨 (無串接) cross_border_711_store_pick_up: 7-11 跨境門市取貨不付款 cross_border_711_home_delivery: 7-11 跨境宅配 tw_simple_familymart: 全家取貨 (無串接) tw_ezship: ezship 超商取貨付款 711_return_nopay: 7-11 退貨便 (C2B) tw_fm_b2c_nopay: 全家取貨不付款 (B2C) tw_fm_b2c_pay: 全家取貨付款 (B2C) tw_fm_c2c_nopay: 全家取貨不付款 (C2C) tw_fm_c2c_pay: 全家取貨付款 (C2C) emap_only_fm: 全家超商取貨 (純地圖) hk_sfplus: Zeek斑馬快送 hk_integrated_sfexpress: 順豐速運 (串接) hk_integrated_sf_pickup: 順豐速運 (串接) hk_pakpobox: Alfred 智能櫃 tw_tcat_roomtemp: 黑貓宅配 - 常溫 tw_tcat_roomtemp_cod: 黑貓宅配 - 常溫 (貨到付款) tw_tcat_refrigerated: 黑貓宅配 - 冷藏 tw_tcat_refrigerated_cod: 黑貓宅配 - 冷藏 (貨到付款) tw_tcat_frozen: 黑貓宅配 - 冷凍 tw_tcat_frozen_cod: 黑貓宅配 - 冷凍 (貨到付款) custom_return: 自訂退貨 ninja_van: Ninja Van - 需取件 sl_logistics_fmt_freeze_pay: 全家冷凍取貨付款 (B2C) sl_logistics_fmt_freeze_nopay: 全家冷凍取貨不付款 (B2C) sl_logistics_ninjavan: Ninja Van (經由 SL logistics) sl_logistics_ninjavan_cod: Ninja Van 貨到付款 (經由 SL logistics) sl_logistics_kerry_th_nd: Kerry ND（經由 SL logistics） sl_logistics_kerry_th_nd_cod: Kerry ND 貨到付款（經由 SL logistics） sl_logistics_kerry_th_2d: Kerry 宅配（標準） sl_logistics_kerry_th_2d_cod: Kerry 宅配 - 貨到付款（標準） sl_logistics_kerry_th_3d: Kerry 3D（經由 SL logistics） sl_logistics_kerry_th_3d_cod: Kerry 3D 貨到付款（經由 SL logistics） sl_logistics_yto_home: 中國 - 台灣物流專線宅配（標準 - 普貨） sl_logistics_yto_home_cod: 中國 - 台灣物流專線宅配- 貨到付款（標準 - 普貨） sl_logistics_yto_store: 中國 - 台灣物流專線超取 - 取貨不付款（標準 - 普貨） sl_logistics_yto_store_cod: 中國 - 台灣物流專線超取 - 取貨付款（標準 - 普貨） sl_logistics_yto_special_home: 中國 - 台灣物流專線宅配（標準 - 特貨） sl_logistics_yto_special_home_cod: 中國 - 台灣物流專線宅配- 貨到付款（標準 - 特貨） sl_logistics_yto_special_store: 中國 - 台灣物流專線超取 - 取貨不付款（標準 - 特貨） sl_logistics_yto_special_store_cod: 中國 - 台灣物流專線超取 - 取貨付款（標準 - 特貨）

delivery_typestring

excluded_payment_idsstring[]

Excluded Payment Method IDs 該送貨方式排除的付款方式ID

supported_countriesstring[]

Supported Countries 可支援配送區域

approvedboolean

true 設定且已審核 false 未設定或未審核通過

support_codboolean

Support COD payment 支援 COD 付款 allows: true 設定且已審核 false 未設定或未審核通過

support_non_codboolean

Support non COD payment 支援非 COD 付款 allows: true 設定且已審核 false 未設定或未審核通過

store_pickup_optionobject

For delivery option type as store_pickup, it shows the information of the stores. 物流類別為門市自取的送貨方式可用，顯示門市資訊。

is_returnboolean

Is It Return Delivery 是否為退貨

Example response

{
  "id": "58d25b6201cda3475300002b",
  "status": "active",
  "name_translations": {
    "zh-hant": "面交取貨"
  },
  "fee_type": "flat",
  "region_type": "custom",
  "delivery_type": "custom",
  "excluded_payment_ids": [
    "5de88dbdce10df002ad927e0"
  ],
  "config_data": {
    "excluded_dates": [
      "2021/01/31"
    ],
    "specific_delivery_time_translations": {
      "en": "09:00AM - 12:00 PM",
      "zh-hant": "上午09:00 - 下午12:00"
    }
  },
  "supported_countries": [
    "TW"
  ],
  "delivery_rates": [
    {
      "countries": [
        "CN",
        "HK"
      ],
      "rate_limit": -1,
      "fee": {
        "cents": 0,
        "currency_symbol": "HK$",
        "currency_iso": "HKD",
        "label": "",
        "dollars": 0
      }
    }
  ],
  "store_pickup_option": {
    "config_option": {
      "dropdown_fields_v2": {
        "en": [
          {
            "field": "level_1",
            "label": "City"
          },
          {
            "field": "level_2",
            "label": "Region"
          },
          {
            "field": "level_3",
            "label": "Street"
          }
        ],
        "zh-hant": [
          {
            "field": "level_1",
            "label": "城市"
          },
          {
            "field": "level_2",
            "label": "地區"
          },
          {
            "field": "level_3",
            "label": "街道"
          }
        ]
      },
      "level_fields": [
        "level_1",
        "level_2",
        "level_3"
      ]
    },
    "addresses": [
      {
        "name_translations": {
          "en": "Hong Kong",
          "zh-hant": "香港"
        },
        "level": "level_1",
        "next_level": [
          {
            "name_translations": {
              "en": "Hong Kong Island",
              "zh-hant": "香港島"
            },
            "level": "level_2",
            "next_level": [
              {
                "name_translations": {
                  "en": "Sheung Wan",
                  "zh-hant": "上環"
                },
                "level": "level_3",
                "next_level": [
                  {
                    "level": "store",
                    "store_name": {
                      "en": "SHOPLINE",
                      "zh-hant": "商線"
                    },
                    "store_address": {
                      "en": "21F, 148 Wing Lok St, Sheung Wan",
                      "zh-hant": "上環永樂街148號21樓"
                    },
                    "instruction": {
                      "en": "Business hours：Monday to Friday 10AM to 7PM",
                      "zh-hant": "營業時間：週一至週五 10AM-7PM"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}