5).queryOrderRoute

Service capabilities: query order route

request url:host:port/server/gateway/order/queryRoute

SDK request class:QueryOrderRouteRequest

parameter data:

parameter name	description	is required	parameter type	remark
orderNo		TRUE	string	orderNo is not empty

demo:

{
    "orderNo":""
}

SDK response class:OpResponse

response data:

parameter name	description	parameter type		is required
code		int32
message		string
displayable		boolean
data		OrderRouteResponseDTO	OrderRouteResponseDTO
orderRoutes			array[OrderRoute]
channel		string		N
orderNo		string		Y
action	tracing action	string		Y
routingDescription		string		Y
operatorTime		string		Y
updateTime		string		Y
imageUrl		string		N
orderLocation		string		Y
utcOperatorTime		string		Y
timeZone		string		Y
success		boolean

demo:

{
    "code":0,
    "message":"",
    "displayable":true,
    "data":{
        "orderRoutes":[
                {
                    "action":"collect_order",
                    "operatorTime":"2023-04-26 20:43:59",
                    "orderLocation":"FOOTSCRAY",
                    "orderNo":"test",
                    "outOrderNo":"test",
                    "routingDescription":"Parcel arrived at warehouse [warehouse name]",
                    "timeZone":"America/Chicago",
                    "updatedTime":1682559843000,
                    "utcOperatorTime":"2023-04-27 01:43:59"
                },
                {
                    "action":"create_order",
                    "operatorTime":"2023-04-20 03:40:14",
                    "orderLocation":"FOOTSCRAY",
                    "orderNo":"test",
                    "outOrderNo":"test",
                    "routingDescription":"Order created by 【SHEIN】to be collected",
                    "timeZone":"America/Chicago",
                    "updatedTime":1681980014000,
                    "utcOperatorTime":"2023-04-20 08:40:14"
                }
            ]
        },
    "success":true
}

action mapping:

code	routingDescription	Explain	shown
create_order	Order created by [sender name]	Create order	Y
collect_order	Parcel arrived at warehouse [warehouse name]	Parcel arrived at warehouse [warehouse name]	Y
update_order	Order info updated	Order info updated
deliver_in_warehose	Parcel arrived at warehouse [warehouse name]	Parcel arrived in distribute warehourse	Y
exception_order	Order exception	System error
damage_order	Order damaged	Parcel damaged
order_sorting_finish	Order sorting	Warehouse sorting completed
out_warehorse_2	Parcel left warehouse [warehouse name] and being delivered by [driver name]	Driver pick up	Y
exception_change_data_1	Rescheduled-unable to contact: [deriver name] could not contact recipent and has rescheduled the delivery. Parcel is expected to be redelivered within two days.	Driver marks can not finish delivery	Y
exception_reject	Rejected: You have rejected parcel.	Driver marks reject by recipient	Y
exception_withdrawing_re_in_warehouse	Your parcel has been withdrawn according to the sender's request	FHE staff marks withdraw	Y
exception_lose	Lost: Your parcel is lost, please wait for our further information.	Driver marks lost	Y
damage_warehouse_out	Undelivered, please contact customer service.	Parcel damaged and already out of the warehouse
refund_warehouse_out	Undelivered, please contact customer service.	Parcel withdrawn and already out of the warehouse
sign_in	Your parcel has been delivered.	Signed by recipient	Y
sign_image	Your parcel has been delivered.	Delivered at front door, other safe place etc.	Y
navigation_or_address_error	Navigation error or wrong address, unable to reach destination	Driver marks navigation error or wrong address	Y
recipient_address_pobox	The receiving address is a PO BOX	Driver marks PO BOX	Y
no_safe_no_way_contact	here is no safe place for the parcel, and the recipient cannot be contacted	Driver marks no safe place to leave parcel	Y
user_request_for_time_change	The recipient requests to change the delivery time.	Driver marks recipient requests a new time for delivery	Y
exception_breakage	xxx Mark as damaged.	Liu Mark as damaged. The parcel is about to return to the warehouse, please wait for further processing. If you haveany questions, please contact your sender for further information	Y
exception_lose	Sorry, your parcel has been lost, please contact the customer service.	Sorry, your parcel has been lost, please contact the customer service.	Y
order_oversize	Oversized or exceeding standards.	Oversized or exceeding standards.	Y
lost	Parcel lost, please contact customer service.	FHE staff marks lost	Y
modify_sign_in	Your parcel has been delivered.	Driver change sign information	Y
reassign	The delivery has not been completed. parcel has been returned to the warehoused, and will be redeliverd for you as soon as possible.	Driver marks can not finish delivery, and will be deliver one more time	Y
transport_order	Your parcel has been forwarded to USPS, Tracking Number: [tracking number]	Forwarded to USPS (Only in US)	Y
transport_order_v2	display the detail message from other channel	Forwarded to USPS (Only in US)	Y
to_be_delivered	display the detail message from other channel	Forwarded to USPS (Only in US)	Y
allocate_order	Parcel left warehouse [warehouseName] and being transported to [transferWarehouseId]	Parcel left warehouse [warehouseName] and being transported to [transferWarehouseName]	Y
block_remove_package	Remove binning, reason %s	Remove binning, reason %s
block_remove_package_abnormal_remark	Order block Remove Package	Removed and marked as abnormal, reason %s
allocate_wait_out	The parcel will be shipped to %s	Order allocate wait out	Y
allocate_out	Parcel left warehouse [warehouseName] and being transported to [transferWarehouseName]	Order allocate out	Y
allocate_in	Parcel arrived at warehouse [warehouseName]. We will deliver within 3 working days	Parcel arrived at warehouse [warehouseName]. We will deliver within 3 working days	Y