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": "31448684-b297-4e80-964e-f48b42cf22a0", "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": "46eefcac-1604-485e-8710-9759e293697e", "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": "85dcc381-fdb4-4e2c-82c8-d7b9669b793b", "DestinationCountryDisplay": "sample string 20", "ParcelId": "80e9cbd9-d559-4e2c-a1a7-02afdd273fd0", "AuctionId": "f1713d19-f59a-4d65-bd5c-d9c116fa17b8", "DeliveryState": 1, "CarrierAccountId": "df6227f9-f8ac-423e-af2b-06c4bdbe5468", "DeliveryDate": "2025-06-19T15:20:18.6237748+00:00", "InsuranceType": 1, "InsuranceTypeDisplay": "sample string 24", "InsuranceFixedValue": null, "InsuranceLevelId": "273cabe3-e928-4daf-8d22-3d05076141f7", "InsuranceLevel": null, "CarrierAccount": null, "AuctionPackages": [ { "Id": "6a7289de-5787-461a-94a5-b16f4157ab79", "BidParcelId": "sample string 2", "AuctionParcelId": "5447e4c6-6d4b-4279-b4c3-14e41f400961", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "40dce0be-6ad5-419a-a57a-966e85e459fc", "PackageId": "722cf873-6886-4e68-84fb-95168b61ef0a", "IsPickedup": true, "ExternalCode": 1 }, { "Id": "6a7289de-5787-461a-94a5-b16f4157ab79", "BidParcelId": "sample string 2", "AuctionParcelId": "5447e4c6-6d4b-4279-b4c3-14e41f400961", "Name": "sample string 4", "Weight": 5.0, "Height": 6.0, "Width": 7.0, "Length": 8.0, "QrCode": "40dce0be-6ad5-419a-a57a-966e85e459fc", "PackageId": "722cf873-6886-4e68-84fb-95168b61ef0a", "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.