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
ServiceResultOfAuctionParcelModel| Name | 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": "2c011741-7d68-45e5-afab-1008aad4e6fd",
"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": "0e3164b8-f796-4131-87b2-f50e735db63b",
"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": "df8d12d1-740b-4854-a939-71f648213271",
"DestinationCountryDisplay": "sample string 20",
"ParcelId": "496fb5f4-a754-45f1-a635-896e9fd6f88c",
"AuctionId": "25005318-58c5-4721-aadc-e27a37d86d74",
"DeliveryState": 1,
"CarrierAccountId": "06c2dd01-ea67-4769-b9a7-20abf61f6619",
"DeliveryDate": "2026-02-01T23:48:41.5692474+00:00",
"InsuranceType": 1,
"InsuranceTypeDisplay": "sample string 24",
"InsuranceFixedValue": null,
"InsuranceLevelId": "74c4f7be-91fe-43e1-8553-188400b49bfb",
"InsuranceLevel": null,
"CarrierAccount": null,
"AuctionPackages": [
{
"Id": "d83cc903-01d6-4ce5-b607-9b03d24e714c",
"BidParcelId": "sample string 2",
"AuctionParcelId": "14ab799f-c4c5-4ea7-8465-fba273242288",
"Name": "sample string 4",
"Weight": 5.0,
"Height": 6.0,
"Width": 7.0,
"Length": 8.0,
"QrCode": "cf1c9619-3908-45e8-a3ef-b6bb030e7ff5",
"PackageId": "49694fad-d190-4aa2-ba0e-9eede00c8c80",
"IsPickedup": true,
"ExternalCode": 1
},
{
"Id": "d83cc903-01d6-4ce5-b607-9b03d24e714c",
"BidParcelId": "sample string 2",
"AuctionParcelId": "14ab799f-c4c5-4ea7-8465-fba273242288",
"Name": "sample string 4",
"Weight": 5.0,
"Height": 6.0,
"Width": 7.0,
"Length": 8.0,
"QrCode": "cf1c9619-3908-45e8-a3ef-b6bb030e7ff5",
"PackageId": "49694fad-d190-4aa2-ba0e-9eede00c8c80",
"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.