Get Delivery Option
Function
To get delivery option information by inputing delivery option ID
輸入送貨方式ID取得該送貨方式資訊
URL
GET <<api_domain>>/v1/delivery_options/:id
Request example
Parameter | Type | Description | Example |
|---|---|---|---|
id *Required |
| Delivery Option ID | |
Response fields
Field | Type | Description | Example |
|---|---|---|---|
id |
| Delivery Option ID | 58d25b6201cda3475300002b |
status |
| Delivery Option Status
| active |
name_translations | Delivery Option Name | 面交取貨 | |
requires_customer_address |
| Requires Customer Address | |
show_description_on_checkout |
| Display description on the checkout page | |
description_translations | Delivery Option Description | ||
delivery_time_description_translations | Description of Delivery Time | ||
fee_type |
| Fee Type
| flat |
form_fields |
| ||
region_type |
| Delivery Option Code (等同於 Order Delivery 的
| tw_711_b2c_pay |
delivery_type |
|
| custom |
excluded_payment_ids |
| Excluded Payment Method IDs | 5de88dbdce10df002ad927e0 |
config_data |
| Configuration Data | See Example2 below |
config_data.lead_time |
| Lead Time | 10 |
config_data.max_lead_time |
| Selectable day length (from lead time) | 1 |
config_data.excluded_weekdays |
| Exclude specific day of week | "excluded_weekdays": "data": { Meaning: |
config_data.excluded_dates |
| Excluded Dates | "excluded_dates": |
config_data.delivery_time_required |
| "Specified Date" is a required field | false |
config_data.specific_delivery_time_translations |
| Specified Timeslot | "en": "morning","zh-hant": "上午" |
supported_countries |
| Supported Countries | [block |
delivery_rates |
| Delivery Fee | [{ |
approved |
| true 設定且已審核 | |
support_cod |
| Support COD payment | |
support_non_cod |
| Support non COD payment | |
store_pickup_option |
| For delivery option type as store_pickup, it shows the information of the stores. | |
store_pickup_option.config_option |
| 篩選門市的下拉選單，讓顧客可以快速找到指定門市。下拉選單 field 最多可以設置三層，依照需求在 label 中帶入字串。 level_fields 表示在結帳時顧客會可下拉的選單層級數量。 | "config_option": { |
store_pickup_option.addresses |
| 選單選項所對應的門市資訊，讓顧客在選擇到對應選項後可顯示對應的門市，例如： 在上一個欄位 level_fields 前台可以選擇到 level 1， store_name 門市名稱 | "addresses": [ |
is_return |
| Is It Return Delivery |
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"
],
"is_return": false,
}{
"_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"
]
}{
"id": "628b35c03d678200245a7685",
"status": "active",
"name_translations": {
"en": "",
"zh-hant": "線上訂線下取 - 既有門市功能（沒有綁實體倉庫）"
},
"description_translations": {
"en": "",
"zh-hant": ""
},
"requires_customer_address": false,
"show_description_on_checkout": false,
"delivery_time_description_translations": {
"en": "",
"zh-hant": ""
},
"fee_type": "flat",
"form_fields": null,
"region_type": "store_pickup",
"excluded_payment_ids": [],
"config_data": {
"support_cod": false,
"support_non_cod": true,
"shopid": "",
"parentid": "",
"execute_shipment_permission": true,
"delivery_time_required": false,
"pakpobox_type": null,
"tcat_egs_id": 1,
"product_name": "delivery_options.options.7_11_cross_border.null",
"attributable_threshold": 0,
"delivery_time_slot_enable": false,
"delivery_time_slot_type": "inactive",
"specific_regions": [],
"file_urls": {
"beta_url": "https://tmp-shoplineapp-com.s3-ap-southeast-1.amazonaws.com/StoreAddress_611a0246e2ccae003f50dd50_1691384212.json",
"prod_url": "https://tmp-shoplineapp-com.s3-ap-southeast-1.amazonaws.com/StoreAddress_611a0246e2ccae003f50dd50_1691384212.json"
}
},
"supported_countries": [
"TW"
],
"delivery_type": "store_pickup",
"delivery_rates": [
{
"fee": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"rate_limit": -1,
"countries": [
"TW"
],
"delivery_areas": [],
"fee_data": {},
"delivery_config": {
"MY": {
"MY_west": false,
"MY_east": false
},
"TW": {
"local": false,
"outlying_island": false
}
}
}
],
"approved": null,
"support_cod": null,
"support_non_cod": null,
"store_pickup_option": {
"config_option": {
"dropdown_fields_v2": {
"en": [
{
"field": "level_1",
"label": null
},
{
"field": "level_2",
"label": null
},
{
"field": "level_3",
"label": null
}
],
"zh-hant": [
{
"field": "level_1",
"label": "城市"
},
{
"field": "level_2",
"label": "區域"
},
{
"field": "level_3",
"label": "街道"
}
],
"zh-cn": [
{
"field": "level_1",
"label": null
},
{
"field": "level_2",
"label": null
},
{
"field": "level_3",
"label": null
}
]
},
"level_fields": [
"level_1",
"level_2",
"level_3"
]
},
"addresses": [
{
"name_translations": {
"en": null,
"zh-hant": "台中",
"zh-cn": null
},
"level": "level_1",
"next_level": [
{
"name_translations": {
"en": null,
"zh-hant": "清水區",
"zh-cn": null
},
"level": "level_2",
"next_level": [
{
"name_translations": {
"en": null,
"zh-hant": "市民大道",
"zh-cn": null
},
"level": "level_3",
"next_level": [
{
"level": "store",
"store_name": {
"en": null,
"zh-hant": "台中門市",
"zh-cn": null
},
"store_address": {
"en": null,
"zh-hant": "台中市清水區X街X號",
"zh-cn": null
},
"instruction": {
"en": null,
"zh-hant": "營業時間 10-19",
"zh-cn": null
},
"channel_id": null
}
]
}
]
}
]
},
{
"name_translations": {
"en": null,
"zh-hant": "台南",
"zh-cn": null
},
"level": "level_1",
"next_level": [
{
"name_translations": {
"en": null,
"zh-hant": "東區",
"zh-cn": null
},
"level": "level_2",
"next_level": [
{
"name_translations": {
"en": null,
"zh-hant": "永康街",
"zh-cn": null
},
"level": "level_3",
"next_level": [
{
"level": "store",
"store_name": {
"en": null,
"zh-hant": "台南門市",
"zh-cn": null
},
"store_address": {
"en": null,
"zh-hant": "台南市永康區X路X號",
"zh-cn": null
},
"instruction": {
"en": null,
"zh-hant": "營業時間 10-19",
"zh-cn": null
},
"channel_id": null
}
]
}
]
}
]
}
]
},
"is_return": false
}{
"id": "62d90db84189cd0011b97fb8",
"status": "active",
"name_translations": {
"en": "",
"zh-hant": "線上定線下取 實體門市"
},
"description_translations": {
"en": "",
"zh-hant": ""
},
"requires_customer_address": false,
"show_description_on_checkout": false,
"delivery_time_description_translations": {
"en": "",
"zh-hant": ""
},
"fee_type": "flat",
"form_fields": null,
"region_type": "store_pickup",
"excluded_payment_ids": [],
"config_data": {
"support_cod": false,
"shopid": "",
"parentid": "",
"execute_shipment_permission": true,
"delivery_time_required": false,
"pakpobox_type": null,
"tcat_egs_id": 1,
"product_name": "delivery_options.options.7_11_cross_border.null",
"attributable_threshold": 0,
"delivery_time_slot_enable": false,
"delivery_time_slot_type": "date",
"specific_regions": [],
"file_urls": {
"beta_url": "https://tmp-shoplineapp-com.s3-ap-southeast-1.amazonaws.com/StoreAddress_611a0246e2ccae003f50dd50_1660543667.json",
"prod_url": "https://tmp-shoplineapp-com.s3-ap-southeast-1.amazonaws.com/StoreAddress_611a0246e2ccae003f50dd50_1660543667.json"
},
"instore_pickup_config": {
"binded_warehouse": true,
"channel_warehouse": {
"611cac6ec471f30026800985": "611cac6072747a003be3a129",
"611cac7d8355b3003585c27f": "611cac55c471f300208009c0"
}
},
"support_non_cod": true
},
"supported_countries": [
"TW"
],
"delivery_type": "store_pickup",
"delivery_rates": [
{
"fee": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"rate_limit": -1,
"countries": [
"TW"
],
"delivery_areas": [],
"fee_data": {},
"delivery_config": {}
}
],
"approved": null,
"support_cod": null,
"support_non_cod": null,
"store_pickup_option": {
"config_option": {
"dropdown_fields_v2": {
"en": [
{
"field": "level_1",
"label": null
},
{
"field": "level_2",
"label": null
},
{
"field": "level_3",
"label": null
}
],
"zh-hant": [
{
"field": "level_1",
"label": null
},
{
"field": "level_2",
"label": null
},
{
"field": "level_3",
"label": null
}
]
},
"level_fields": []
},
"addresses": [
{
"level": "store",
"store_name": {
"en": null,
"zh-hant": "台北門市"
},
"store_address": {
"en": null,
"zh-hant": "台北市大安區敦化南路一段23號"
},
"instruction": {
"en": null,
"zh-hant": null
},
"channel_id": "611cac7d8355b3003585c27f"
},
{
"level": "store",
"store_name": {
"en": null,
"zh-hant": "新竹門市"
},
"store_address": {
"en": null,
"zh-hant": "新竹市東區中正路123號"
},
"instruction": {
"en": null,
"zh-hant": null
},
"channel_id": "611cac6ec471f30026800985"
}
]
},
"is_return": false
}Updated 11 days ago