Get Delivery Options

Function

To get all kinds of delivery options with open API
透過open API獲取所有的送貨方式

URL

GET <<api_domain>>/v1/delivery_options

Request parameters

Parameter	Value	Description	Example
per_page	`Integer`	Numbers of Delivery Options per Page 每頁顯示 n 筆資料 (Default: 24)	`ruby per_page: 24`
page	`Integer`	Page Number 頁數 (Default: 1)	`ruby page: 1`

Response Fields

Field	Type	Description	Example
items	Get Delivery Option	Delivery Option Data 送貨方式資訊	Please check the link on the left
pagination	Pagination	Pagination Data 頁面資訊	Please check the link on the left

Response Example

{
    "items": [
        {
            "id": "58d25b6201cda3475300002b",
            "owner_id": "58c1362e01cda33293000048",
            "owner_type": "Merchant",
            "status": "active",
            "name_translations": {
                "zh-hant": "面交取貨"
            },
            "requires_customer_address: false,
            "description_translations": {},
            "fee_type": "flat",
            "form_fields": null,
            "region_type": "custom",
            "excluded_payment_ids": [],
            "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": "58d3379401cda31bfb000000",
            "owner_id": "58c1362e01cda33293000048",
            "owner_type": "Merchant",
            "status": "active",
            "name_translations": {
                "zh-hant": "自取"
            },
            "requires_customer_address: false,
            "description_translations": {},
            "fee_type": "flat",
            "form_fields": null,
            "region_type": "pos",
            "excluded_payment_ids": [],
            "config_data": {},
            "supported_countries": [
                "*"
            ]
        },
        {
            "id": "58d3388e01cda31bfb000003",
            "owner_id": "58c1362e01cda33293000048",
            "owner_type": "Merchant",
            "status": "draft",
            "name_translations": {
                "zh-hant": "本地郵寄"
            },
            "requires_customer_address: true,
            "description_translations": {},
            "fee_type": "flat",
            "form_fields": null,
            "region_type": "local",
            "excluded_payment_ids": [],
            "config_data": {},
            "supported_countries": [
                "TW"
            ]
        }
    ]
}

Delivery Option ID is shown in the url. (Refer to below picture)