# General
# PA-API-2.1 Get available VAS
POST /vas
API type | Request API |
Usage | - Get available VAS. The VAS will be input in requesting PA-API-3.1 Create order. |
# Request
Name | Type | Mandatory | Default | Description | Remarks |
---|---|---|---|---|---|
merchant_id | string | Y | - | Merchant ID in Zeek Platform | |
product_code | string | Y | - | Product code | - Support "DASH2HR" , "DASH4HR" or "MPOINTS" . - Please consult Zeek team about the supported values |
Example:
{
"merchant_id": "1111111",
"product_code": "DASH2HR"
}
# Response
Name | Type | Description | Remarks |
---|---|---|---|
vas[] | array | VAS services | |
vas[].code | string | Service code | |
vas[].name | string | Service name | |
vas[].description | string | Service description | |
vas[].help | string | Help URL | |
vas[].options | array | Sercice options | |
vas[].options[].count | string | Service count | While creating order, please input the count value into PA-API-3.1 Create order API. |
vas[].options[].fee | string | Service fee | |
vas[].options[].label | string | Option name |
Example:
{
"error": 0,
"data": {
"vas": [
{
"code": "HKDASH_HOURS",
"name": "Hourly rental",
"description": "Please state the brief requirement in remarks, and negotiate with the driver about the fee. Cash on delivery is required for this.",
"help": "https://staging-ap1-img.ks-it.co/Markdown/manual_93_zh_hk.html?1593428037",
"options": [
{
"count": "1",
"fee": "$10",
"label": "1 Car"
},
{
"count": "2",
"fee": "$20",
"label": "2 Car"
},
{
"count": "3",
"fee": "$30",
"label": "3 Car"
}
]
},
{
"code": "HKDASH_TMBAG",
"name": "Thermal bag",
"description": "",
"help": "",
"options": [
{
"count": "0",
"label": "No required",
"fee": "$0"
},
{
"count": "1",
"label": "Required",
"fee": "$0"
}
]
}
]
}
}
# PA-API-2.2 Get available business positions
POST /business_positions
API type | Request API |
Usage | - Get available business positions. It will be input in the preferences parameter while requesting PA-API-3.1 Create order. |
# Request
Name | Type | Mandatory | Default | Description | Remarks |
---|---|---|---|---|---|
merchant_id | string | Y | - | Merchant ID in Zeek Platform | |
product_code | string | Y | - | Product code | - Support "DASH2HR" , "DASH4HR" or "MPOINTS" . - Please consult Zeek team about the supported values |
schedule_time | string | N | '' | Scheduled pickup time | - Please omit it for realtime order - Earliest schedule time = Current time + 30mins - Latest schedule time = Current time + 31days - Example: "2020-09-08 16:00" |
items | object | N | - | Items | |
items.box | string | Y | - | Item capacity code | - Supports "XS" 、"S" 、"M" 、"L" 、"XL" |
path | array | N | - | Delivery waypoints | Please input the starting point, waypoints (if any) and destination in sequence. |
path[].coordinate | string | Y | - | Coordinates |
Example:
{
"merchant_id": "1111111",
"product_code": "DASH2HR",
"schedule_time": "2020-08-19 19:30",
"items": {
"box": "M"
},
"path": [
{
"coordinate": "22.277495,114.166271"
},
{
"coordinate": "22.300813,114.179696"
}
]
}
# Response
Name | Type | Description | Remarks |
---|---|---|---|
business_positions[] | array | Business positions | |
business_positions[].code | string | Business position code | |
business_positions[].name | string | Business position name |
Example:
{
"error": 0,
"data": {
"business_positions": [
{
"code": "mR",
"name": "Motorbike",
},
{
"code": "mC",
"name": "Car",
},
{
"code": "mV",
"name": "Van",
}
]
}
}