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": "a56f857e-1fbc-4fbe-9958-07f1d30cada5", "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": "d7640e0c-ec95-41a1-a937-f6297ab51af5", "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": "c585bf32-b01c-4db1-921b-6227255733e9", "DestinationCountryDisplay": "sample string 20", "ParcelId": "ff6a0112-211c-4bf8-9aee-9eda447c6efe", "AuctionId": "b27455a9-e9e4-4523-a41e-68adc938e9f1", "DeliveryState": 1, "CarrierAccountId": "f7b12928-e672-4714-9339-0f841ad4cebe", "DeliveryDate": "2025-04-28T15:00:43.7758362+00:00", "InsuranceType": 1, "InsuranceTypeDisplay": "sample string 24", "InsuranceFixedValue": null, "InsuranceLevelId": "082b509c-02c4-4887-94cc-2419607eaf24", "InsuranceLevel": null, "CarrierAccount": null, "AuctionPackages": [ { "Id": "9aa99c06-6c63-4008-b151-ef6fc5380083", "BidParcelId": "sample string 2", "AuctionParcelId": "d346fb26-7a31-405b-abdd-e196628dfc1c", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "96ef444c-0662-4254-a6e8-0f7df15043ab", "PackageId": "217bbc10-05b6-45ed-a65f-3576d0da41fe", "IsPickedup": true, "ExternalCode": 1 }, { "Id": "9aa99c06-6c63-4008-b151-ef6fc5380083", "BidParcelId": "sample string 2", "AuctionParcelId": "d346fb26-7a31-405b-abdd-e196628dfc1c", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "96ef444c-0662-4254-a6e8-0f7df15043ab", "PackageId": "217bbc10-05b6-45ed-a65f-3576d0da41fe", "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.