POST api/WillCall/Activate
Use to activate an order from a quote status, you can also update contents
Request Information
URI Parameters
None.
Body Parameters
ActiveWillCallParm| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system generated user identifier |
string |
None. |
| TrackingNumber |
Tracking number associated with the shipment |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserGUID": "sample string 1",
"TrackingNumber": "sample string 2"
}
application/xml, text/xml
Sample:
<ActiveWillCallParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models"> <TrackingNumber>sample string 2</TrackingNumber> <UserGUID>sample string 1</UserGUID> </ActiveWillCallParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActiveWillCallResp| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentNumber |
Unique system generated shipment number |
integer |
None. |
| IsSuccessful |
If true, then method call was successful |
boolean |
None. |
| ErrorMessage |
Contains an error message is method call failed |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ShipmentNumber": 1,
"IsSuccessful": true,
"ErrorMessage": "sample string 3"
}
application/xml, text/xml
Sample:
<ActiveWillCallResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models"> <ErrorMessage>sample string 3</ErrorMessage> <IsSuccessful>true</IsSuccessful> <ShipmentNumber>1</ShipmentNumber> </ActiveWillCallResp>