[TOC]
Description
- Get Fulfillment Task List by FT NOs API
Request URL
/rest/fp_api/fulfillment_task/get_by_no
Request Method
Request Parameter (Request Parameter)
| Name |
Data Type |
Mandatory |
Description |
| ft_nos |
string[] |
Y |
Comma-separated list of Fulfillment task no in square brackets. Max List Size: 5. |
Fulfillment Task Standard Response Properties Definition (Object[] )
| Name |
Data Type |
Description |
| ft_no |
String |
Fulfillment Task No (Unique) |
| fp_name |
String |
Fulfillment Point Name |
| created_time |
Long |
Created Date Time |
| status |
String |
Status |
| allow_ft_split |
Int |
Allow warehouse to pack this fulfillment task into multiple parcels or not. |
| order_no |
String |
Order No |
| sc_type |
String |
Sales Channel Type |
| sales_channel |
String |
Sales Channel Name |
| order_created_time |
Long |
Order Created Date Time |
| packing_instruction |
String |
Packing Instruction of Fulfillment Task |
| delivery_instruction |
String |
Delivery Instruction of Fulfillment Task |
| ship_by_date |
Long |
Ship By Date |
| cross_border |
Int |
Is Cross Board Order |
| country |
String |
Country |
| state |
String |
State/Province |
| city |
String |
City |
| district |
String |
District |
| address |
String |
Address |
| postcode |
String |
Postal Code |
| name |
String |
Receiver Name |
| organization |
String |
Receiver Organization |
| phone |
String |
Receiver Phone No. |
| email |
String |
Receiver Email |
| delivery_carrier |
String |
Delivery Partner Carrier |
| delivery_type |
String |
Delivery Type |
| avail_delivery_carrier |
Objectg[] |
Available Delivery Carrier |
| ├──name |
String |
Display Name of available delivery carrier. |
| ├──id |
String |
Identifier of available delivery carrier. Use this id to update chose delivery carrier when necessary. |
| task_details |
Object[] |
Task Details |
| ├──order_item_status |
String |
Status of fulfillment task. |
| ├──order_item_id |
Long |
Id of OMS4 Order Item. |
| ├──task_detail_id |
Long |
Fulfillment Task Detail Id |
| ├──ship_by_date |
Long |
Ship By Date |
| ├──delivery_carrier |
String |
Delivery Carrier |
| ├──delivery_type |
String |
Delivery Type |
| ├──seller_sku_code |
String |
Seller SKU Code |
| ├──brand_code |
String |
Brand Code |
| ├──brand_sku_code |
String |
Brand SKU Code |
| ├──sku_name |
String |
SKU Name |
| ├──qty |
Int |
Qty |
| ├──unit_price |
Number |
Unit Price |
| ├──total |
Number |
Total |
| ├──use_upstream_tpt |
Int |
Use Upstream Integrated Delivery, which means Upstream System will arrange and manage transportation |
| ├──req_fp_gen_track_no |
Int |
'1' means require FP generate tracking no and push the tracking no to OMS4 in the parcel information |
Success Response Example
{
"code": "200",
"data": {
"ft_list": [
{
"status": "SHIPPING",
"country": "SG",
"state": "",
"city": "",
"district": "",
"address": "233 Paya Lebar Road, #18-13, SG, 409044",
"postcode": "409044",
"name": "Li Ping",
"organization": "",
"phone": "24207284",
"email": "test@email.com",
"ft_no": "FT399957592694063104",
"fp_name": "test_tiktok_fp_general",
"created_time": 1704787721010,
"allow_ft_split": 1,
"order_no": "576614480732652628",
"sc_type": "TikTok",
"sales_channel": "0000000000000000001-tiktok",
"order_created_time": 1704781028180,
"packing_instruction": "Pack separately",
"delivery_instruction": "home delivery",
"ship_by_date": 1704902399000,
"cross_border": 0,
"delivery_carrier": "J&T",
"delivery_type": "Standard",
"avail_delivery_carrier": [
{
"id": "01111",
"name": "J&T"
}
],
"task_details": [{
"qty": 1,
"total": 10.0000,
"order_item_id": 17022,
"ship_by_date": 1704902399000,
"delivery_carrier": "J&T",
"delivery_type": "Standard",
"order_item_status": "SHIPPING",
"task_detail_id": 16616,
"seller_sku_code": "MUG20231102",
"brand_code": "SKU001",
"brand_sku_code": "MUG20231102",
"sku_name": "Plastic USB Cable Type-C Metal",
"unit_price": 10.0000,
"use_upstream_tpt": 1,
"req_fp_gen_track_no": 0
}, {
"qty": 1,
"total": 10.0000,
"order_item_id": 17023,
"ship_by_date": 1704902399000,
"delivery_carrier": "J&T",
"delivery_type": "Standard",
"order_item_status": "SHIPPING",
"task_detail_id": 16617,
"seller_sku_code": "MUG20231101",
"brand_code": "SKU001",
"brand_sku_code": "MUG20231101",
"sku_name": "OMS4 Designer Mug - white-blue",
"unit_price": 10.0000,
"use_upstream_tpt": 1,
"req_fp_gen_track_no": 0
}
],
"orig_delivery_option": "7062707673698928386"
}
]
},
"message": "success",
"request_id": "2d48f902-7efa-4718-8b88-9686803a8a02"
}
