Description
Path
| Post | /services/shipper/hold
|
Request content
The request body contains an order sequence, a holding tag, and up to 300 orders can
be sent at once.
Notes.
orderIds:
Ref No. or Tracking No.
holdType:
1:Hold
2: Release. (not enabled)
Can only hold orders with no operation history and no linehaul uploaded.
You can only release orders that have been held by the customer.
|
Request
1
2
3
4 | {
"orderIds":["Test001"],
"holdType":1
}
|
ResponseElements
Returnresults in the order of shipment information in request, including:
1)status(Failed / Success / Partial Success).
2)error
2.1)code
2.2)message
3)data
3.1)orderId
3.2)status
3.3)errors
3.3.1)code
3.3.2)message.
Response message
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 | {
"status": "Success",
"errors": null,
"data": [
{
"status": "Success",
"errors": null,
"orderId": "Test001"
},
{
"status": "Success",
"errors": null,
"orderId": "Test001"
}
]
}
|