GET api/Parcel/GetAuctionParcel?authToken={authToken}&auctionParcelId={auctionParcelId}
Get Auction Parcel Information
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The Authentiation Token |
string |
Required |
auctionParcelId |
The Auction Parcel Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfAuctionParcelModelName | Description | Type | Additional information |
---|---|---|---|
Result | AuctionParcelModel |
None. |
|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "Id": "103f876e-33e6-467b-9a27-0d0967587a9d", "Name": "sample string 2", "Comments": "sample string 3", "Reference": "sample string 4", "ATCode": "sample string 5", "CollectionAddress": "sample string 6", "CollectionZipCode": "sample string 7", "CollectionPhone": "sample string 8", "CollectionName": "sample string 9", "CollectionCity": "sample string 10", "CollectionCountry": "5e395915-fdd3-4129-a3bf-4cd033f0b1ca", "CollectionCountryDisplay": "sample string 12", "DestinationName": "sample string 13", "DestinationPhone": "sample string 14", "DestinationEmail": "sample string 15", "DestinationAddress": "sample string 16", "DestinationZipCode": "sample string 17", "DestinationCity": "sample string 18", "DestinationCountry": "1eb5be01-ecb6-45d8-a0dc-d6a137513201", "DestinationCountryDisplay": "sample string 20", "ParcelId": "d9f69f52-805d-492f-add1-542c6d4b08d8", "AuctionId": "8cbbefab-d629-42d4-b655-04a8148bfc69", "DeliveryState": 1, "CarrierAccountId": "908cfc9d-955b-4a7f-b48b-40dce41cb56a", "DeliveryDate": "2024-04-19T21:49:28.1768077+00:00", "InsuranceType": 1, "InsuranceTypeDisplay": "sample string 24", "InsuranceFixedValue": null, "InsuranceLevelId": "327985db-2363-4c8b-bd23-029a28c3ed2c", "InsuranceLevel": null, "CarrierAccount": null, "AuctionPackages": [ { "Id": "392b530a-3ae8-4849-a18b-bc9d2cf53452", "BidParcelId": "sample string 2", "AuctionParcelId": "328c8a1c-0851-4376-81ff-665c1df5a528", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "0c96e50c-05ee-4fc3-8b7b-4359f9054790", "PackageId": "5f80e528-5049-4ffd-8f96-7fa0e2910922", "IsPickedup": true, "ExternalCode": 1 }, { "Id": "392b530a-3ae8-4849-a18b-bc9d2cf53452", "BidParcelId": "sample string 2", "AuctionParcelId": "328c8a1c-0851-4376-81ff-665c1df5a528", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "0c96e50c-05ee-4fc3-8b7b-4359f9054790", "PackageId": "5f80e528-5049-4ffd-8f96-7fa0e2910922", "IsPickedup": true, "ExternalCode": 1 } ], "BidParcelId": "sample string 25" }, "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.