GET api/WillCall/{UserGUID}
Retruns Orders list which status is set to "WILL CALL"
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserGUID | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ActiveWillCallOrdersRespName | Description | Type | Additional information |
---|---|---|---|
Shipments |
List of active orders |
Collection of WillCallShipmentItem |
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:
{ "Shipments": [ { "OrderNumber": "sample string 1", "OtherReference1": "sample string 2", "OtherReference2": "sample string 3", "PickupCityName": "sample string 4", "PickupCountryID": "sample string 5", "PickupCountryName": "sample string 6", "DeliveryCityName": "sample string 7", "DeliveryCountryID": "sample string 8", "DeliveryCountryName": "sample string 9", "Reference": "sample string 10", "Contents": "sample string 11" }, { "OrderNumber": "sample string 1", "OtherReference1": "sample string 2", "OtherReference2": "sample string 3", "PickupCityName": "sample string 4", "PickupCountryID": "sample string 5", "PickupCountryName": "sample string 6", "DeliveryCityName": "sample string 7", "DeliveryCountryID": "sample string 8", "DeliveryCountryName": "sample string 9", "Reference": "sample string 10", "Contents": "sample string 11" } ], "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ActiveWillCallOrdersResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Shipments xmlns:d2p1="http://schemas.datacontract.org/2004/07/ParcelLogic.Transportation"> <d2p1:WillCallShipmentItem> <d2p1:Contents>sample string 11</d2p1:Contents> <d2p1:DeliveryCityName>sample string 7</d2p1:DeliveryCityName> <d2p1:DeliveryCountryID>sample string 8</d2p1:DeliveryCountryID> <d2p1:DeliveryCountryName>sample string 9</d2p1:DeliveryCountryName> <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber> <d2p1:OtherReference1>sample string 2</d2p1:OtherReference1> <d2p1:OtherReference2>sample string 3</d2p1:OtherReference2> <d2p1:PickupCityName>sample string 4</d2p1:PickupCityName> <d2p1:PickupCountryID>sample string 5</d2p1:PickupCountryID> <d2p1:PickupCountryName>sample string 6</d2p1:PickupCountryName> <d2p1:Reference>sample string 10</d2p1:Reference> </d2p1:WillCallShipmentItem> <d2p1:WillCallShipmentItem> <d2p1:Contents>sample string 11</d2p1:Contents> <d2p1:DeliveryCityName>sample string 7</d2p1:DeliveryCityName> <d2p1:DeliveryCountryID>sample string 8</d2p1:DeliveryCountryID> <d2p1:DeliveryCountryName>sample string 9</d2p1:DeliveryCountryName> <d2p1:OrderNumber>sample string 1</d2p1:OrderNumber> <d2p1:OtherReference1>sample string 2</d2p1:OtherReference1> <d2p1:OtherReference2>sample string 3</d2p1:OtherReference2> <d2p1:PickupCityName>sample string 4</d2p1:PickupCityName> <d2p1:PickupCountryID>sample string 5</d2p1:PickupCountryID> <d2p1:PickupCountryName>sample string 6</d2p1:PickupCountryName> <d2p1:Reference>sample string 10</d2p1:Reference> </d2p1:WillCallShipmentItem> </Shipments> </ActiveWillCallOrdersResp>