Home
HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Delivery Option

Suggest Edits

Function

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

URL

GET <<api_domain>>/v1/delivery_options/:id

Request example

ParameterTypeDescriptionExample
id
*Required		StringDelivery Option ID
物流方式ID		ruby 58d25b6201cda3475300002b

Response fields

FieldTypeDescriptionExample
idStringDelivery Option ID
送貨方式ID		58d25b6201cda3475300002b
statusStringDelivery Option Status
送貨方式狀態
-
Status allows:
active 啟用中
draft 隱藏		active
name_translationsTranslationDelivery Option Name
送貨方式名稱		面交取貨
requires_customer_addressBooleanRequires Customer Address
需要顧客提供地址
description_translationsTranslationDelivery Option Description
送貨方式簡介
fee_typeStringFee Type
收費模式
-
Fee type allow:
flat
 flat_weight
subtotal
 item_count
* sl_logistic 		flat
form_fieldsArray
region_typeStringDelivery Option Code
送貨方式代碼
local
 international
pickup custom
 store_pickup tw_711_pay
tw_711_nopay
 tw_711_b2c_pay
tw_711_b2c_nopayemap_only_711
 ninja_van sl_logistics_ninjavan
sl_logistics_ninjavan_cod
 sfexpress
hk_integrated_sfexpress
 hk_integrated_sf_pickup
sl_logistics_kerry_th_nd
 sl_logistics_kerry_th_nd_cod
sl_logistics_kerry_th_2d
 sl_logistics_kerry_th_2d_cod
sl_logistics_kerry_th_3d
 sl_logistics_kerry_th_3d_cod
* sl_logistics_ghtk_ghtk" 		"delivery_options.fields.delivery_types.custom': ""自订"",
'delivery_options.fields.delivery_types.pickup': ""面交取货"",
'delivery_options.fields.delivery_types.local': ""本地邮寄"",
'delivery_options.fields.delivery_types.email': ""邮箱"",
'delivery_options.fields.delivery_types.international': ""海外邮寄"",
'delivery_options.fields.delivery_types.hop': ""HOP!"",
'delivery_options.fields.delivery_types.sfexpress': ""顺丰速运"",
'delivery_options.fields.delivery_types.sfexpress.type': ""服务类型"",
'delivery_options.fields.delivery_types.sfexpress.pickup': ""取货点"",
'delivery_options.fields.delivery_types.sfexpress.711': ""7-11便利店取件"",
'delivery_options.fields.delivery_types.sfexpress.circlek': ""OK便利店取件"",
'delivery_options.fields.delivery_types.sfexpress.store': ""顺丰站取件"",
'delivery_options.fields.delivery_types.sfexpress.centre': ""服务中心取件"",
'delivery_options.fields.delivery_types.sfexpress.eflocker': ""顺便智能柜取件"",
'delivery_options.fields.delivery_types.sfexpress.service': ""顺丰服务点取件"",
'delivery_options.fields.delivery_types.hk_sfplus.home': ""即日送货服务"",
'delivery_options.fields.delivery_types.hk_sfplus.eflocker': ""智能柜取件"",
'delivery_options.fields.delivery_types.hk_sfplus': ""顺丰到+ "",
'delivery_options.fields.delivery_types.hk_sfplus.id': ""顺丰客户号码"",
'delivery_options.fields.delivery_types.tw_711_nopay': ""7-11 取货不付款 (C2C)"",
'delivery_options.fields.delivery_types.tw_711_pay': ""7-11 取货付款 (C2C)"",
'delivery_options.fields.delivery_types.tw_711_b2c_nopay': ""7-11 取货不付款 (B2C)"",
'delivery_options.fields.delivery_types.tw_711_b2c_pay': ""7-11 取货付款 (B2C)"",
'delivery_options.fields.delivery_types.tw_simple_711': ""7-11 取货 (无串接)"",
'delivery_options.fields.delivery_types.tw_simple_familymart': ""全家取货 (无串接)"",
""delivery_options.fields.delivery_types.tw_ezship"": ""ezship 超商取货付款"",
""delivery_options.fields.delivery_types.711_return_nopay"": ""7-11 退货便 (C2B)"",
""delivery_options.fields.delivery_types.tw_fm_b2c_nopay"": ""全家 取货不付款 (B2C)"",
""delivery_options.fields.delivery_types.tw_fm_b2c_pay"": ""全家 取货付款 (B2C)"",
""delivery_options.fields.delivery_types.tw_ezship.hint"": ""必须在「付款设定」同时新增「超商取货付款（经由ezShip）」并输入ezShip 帐户"",
""delivery_options.fields.delivery_types.tw_711_pay.hint"": ""必须在「付款设定」同时新增「7-11取货付款」"",
""delivery_options.fields.delivery_types.tw_711_b2c_pay.hint"": ""必须在「付款设定」同时新增「7-11 B2C 取货付款」"",
""delivery_options.fields.delivery_types.tw_fm_b2c_pay.hint"": ""必须在「付款设定」同时新增「全家 B2C 取货付款」"",
""delivery_options.fields.delivery_types.tw_fm_c2c_pay.hint"": ""必须在「付款设定」同时新增「全家 C2C 取货付款」"","
excluded_payment_idsArrayExcluded Payment Method IDs
該送貨方式排除的付款方式ID		5de88dbdce10df002ad927e0
config_dataHashConfiguration Data
物流設置資訊		See Example2 below
config_data.supported_countriesArraySupported Countries
可支援配送區域		TW
config_data.lead_timeStringLead Time
預估備貨天數		10
config_data.max_lead_timeStringSelectable day length (from lead time)
備貨期後可指定的天數長度		1
config_data.excluded_weekdaysArrayExclude specific day of week
排除特定星期		"excluded_weekdays": [
0,
1
]

Meaning:
Exclude Sunday & Monday
排除星期日和星期一
config_data.excluded_datesArrayExcluded Dates
排除特定日期		"excluded_dates": [
{
"date": "2022/02/18"
},
{
"date": "2022/02/19"
}
]
config_data.delivery_time_requiredBoolean"Specified Date" is a required field
指定出貨日期是否必填		false
config_data.specific_delivery_time_translationsArraySpecified Timeslot
出貨訂單需指定時段		"en": "morning","zh-hant": "上午"

Response Example

{
    "id": "58d25b6201cda3475300002b",
    "status": "active",
    "name_translations": {
        "zh-hant": "面交取貨"
    },
    "requires_customer_address": false,
    "description_translations": {},
    "fee_type": "flat",
    "form_fields": null,
    "region_type": "custom",
    "excluded_payment_ids": [
			"5de88dbdce10df002ad927e0"
		],
    "config_data": {
        "lead_time": 4,
        "specific_delivery_time_translations": [
            {
                "en": "morning",
                "zh-hant": "上午"
            },
            {
                "en": "afternoon",
                "zh-hant": "下午"
            }
        ],
        "excluded_weekdays": [
            6,
            0
        ]
    },
    "supported_countries": [
        "TW"
    ]
}

{
  "_id": "605b1c46e5a0600044fbcba0",
  "created_at": "2021-03-24T11:02:30.322Z",
  "updated_at": "2022-02-18T09:28:43.633Z",
  "owner_id": "5cac58964c084800011cf924",
  "status": "active",
  "form_fields": null,
  "region_type": "international",
  "name_translations": {
    "en": "Others",
    "zh-hant": "其他test",
    "zh-cn": "其他",
    "vi": "Khác",
    "ms": "Others",
    "ja": "Others",
    "th": "อื่นๆ",
    "id": "Others",
    "de": "Others",
    "fr": "Others"
  },
  "description_translations": {
    "en": "",
    "zh-hant": "test",
    "zh-cn": "",
    "vi": "",
    "ms": "",
    "ja": "",
    "th": "",
    "id": "",
    "de": "",
    "fr": ""
  },
  "delivery_time_description_translations": {
    "en": "",
    "zh-hant": "",
    "zh-cn": "",
    "vi": "",
    "ms": "",
    "ja": "",
    "th": "",
    "id": "",
    "de": "",
    "fr": ""
  },
  "show_description_on_checkout": false,
  "requires_customer_address": true,
  "config_data": {
    "shopid": "",
    "parentid": "",
    "delivery_target_area": "localOnly",
    "lead_time": 1,
    "max_lead_time": 2,
    "execute_shipment_permission": true,
    "delivery_time_required": true,
    "pakpobox_type": null,
    "tcat_egs_id": 1,
    "product_name": "delivery_options.options.7_11_cross_border.null",
    "attributable_threshold": 0,
    "sender_pickup_address": {
      "country": "malaysia"
    },
    "specific_regions": [],
    "specific_delivery_time_translations": [
      {
        "zh-hant": "19:00 - 20:00"
      },
      {
        "zh-hant": "22:00 - 23:00"
      }
    ],
    "excluded_weekdays": [
      0,
      1
    ],
    "excluded_dates": [
      {
        "date": "2022/02/18"
      },
      {
        "date": "2022/02/19"
      }
    ]
  },
  "fee_type": "flat",
  "delivery_rates": [
    {
      "_id": "620f66cb15e20e0039ca9774",
      "countries": [
        "US"
      ],
      "created_at": "2022-02-18T09:28:43.665Z",
      "delivery_areas": [],
      "delivery_config": {},
      "delivery_option_id": "605b1c46e5a0600044fbcba0",
      "fee": {
        "cents": 22,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$22",
        "dollars": 22
      },
      "fee_data": null,
      "name": null,
      "rate_limit": -1,
      "updated_at": "2022-02-18T09:28:43.665Z"
    }
  ],
  "is_return": false,
  "time_slots": [],
  "calculate_mode": "customized_degree",
  "delivery_type": "post",
  "supported_countries": [
    "US"
  ],
  "fee": {
    "cents": 22,
    "currency_symbol": "NT$",
    "currency_iso": "TWD",
    "label": "NT$22",
    "dollars": 22
  },
  "accepted_countries": [
    "US"
  ]
}

Updated over 2 years ago