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": "5ea8ccc5-523e-4050-884d-2cec02d36b7c", "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": "f19b2138-070e-4d59-99eb-a94fd1843a04", "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": "5568e324-1ad2-403e-bd2d-f441900f041e", "DestinationCountryDisplay": "sample string 20", "ParcelId": "4918350d-49db-4942-8b26-0750a559e442", "AuctionId": "71b1c31b-d088-4918-9594-bb884d36c1ca", "DeliveryState": 1, "CarrierAccountId": "511c0c69-72e3-4cfa-965c-aac6f6d54427", "DeliveryDate": "2025-07-02T10:06:25.7953474+00:00", "InsuranceType": 1, "InsuranceTypeDisplay": "sample string 24", "InsuranceFixedValue": null, "InsuranceLevelId": "be490fac-1ab9-4ae4-ab24-61ae54285e46", "InsuranceLevel": null, "CarrierAccount": null, "AuctionPackages": [ { "Id": "1b0938d4-1ea0-493b-b12a-447df6cd14ba", "BidParcelId": "sample string 2", "AuctionParcelId": "4b1d78a4-e892-4435-b85c-cd3ecc9ca0ed", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "a86fa410-2ba1-4783-b62a-58ca037a935a", "PackageId": "d1f6d529-6dba-4c70-8484-602c6beba689", "IsPickedup": true, "ExternalCode": 1 }, { "Id": "1b0938d4-1ea0-493b-b12a-447df6cd14ba", "BidParcelId": "sample string 2", "AuctionParcelId": "4b1d78a4-e892-4435-b85c-cd3ecc9ca0ed", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "a86fa410-2ba1-4783-b62a-58ca037a935a", "PackageId": "d1f6d529-6dba-4c70-8484-602c6beba689", "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.