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": "3cfd61fc-8504-4e69-a303-15aa5c3e4060",
"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": "1637ba04-c78b-4643-96c1-3c3ad7dba022",
"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": "db781e1a-c195-4f03-b66b-3774f1106884",
"DestinationCountryDisplay": "sample string 20",
"ParcelId": "d119ed26-20f2-47cf-8043-45bde2922b4c",
"AuctionId": "7555af3c-60f8-4f98-bb5e-bf50c4594105",
"DeliveryState": 1,
"CarrierAccountId": "af3bacbb-4afa-4141-b9bd-cadd42ddc4b8",
"DeliveryDate": "2026-01-10T17:29:18.1445552+00:00",
"InsuranceType": 1,
"InsuranceTypeDisplay": "sample string 24",
"InsuranceFixedValue": null,
"InsuranceLevelId": "b91bd086-2c55-484b-aa18-f90f4f8361e4",
"InsuranceLevel": null,
"CarrierAccount": null,
"AuctionPackages": [
{
"Id": "3b9e960a-f3f9-4482-85fb-8ca18eccde6e",
"BidParcelId": "sample string 2",
"AuctionParcelId": "8b2b75dd-6312-4fc4-a75d-86a9ece3262d",
"Name": "sample string 4",
"Weight": 5.0,
"Height": 6.0,
"Width": 7.0,
"Length": 8.0,
"QrCode": "9c33a863-9920-46df-9cc7-b8021b5ef86b",
"PackageId": "7bc28143-62ca-484d-b705-b49ee993af98",
"IsPickedup": true,
"ExternalCode": 1
},
{
"Id": "3b9e960a-f3f9-4482-85fb-8ca18eccde6e",
"BidParcelId": "sample string 2",
"AuctionParcelId": "8b2b75dd-6312-4fc4-a75d-86a9ece3262d",
"Name": "sample string 4",
"Weight": 5.0,
"Height": 6.0,
"Width": 7.0,
"Length": 8.0,
"QrCode": "9c33a863-9920-46df-9cc7-b8021b5ef86b",
"PackageId": "7bc28143-62ca-484d-b705-b49ee993af98",
"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.