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	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": "256364f5-45bb-4e04-bb63-21a5ee1531ec",
    "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": "5b70fe4a-6d96-41af-96fb-545f587e076e",
    "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": "f72d0283-b385-4ca7-86a7-6d5a373ad41a",
    "DestinationCountryDisplay": "sample string 20",
    "ParcelId": "cf013f3b-595a-453b-8328-f9308e3d64e0",
    "AuctionId": "51fa47c6-8431-4334-b24c-3ea9f75232b5",
    "DeliveryState": 1,
    "CarrierAccountId": "53a57948-d27e-4ce5-9cad-a65051adbc91",
    "DeliveryDate": "2024-11-07T15:25:40.2806515+00:00",
    "InsuranceType": 1,
    "InsuranceTypeDisplay": "sample string 24",
    "InsuranceFixedValue": null,
    "InsuranceLevelId": "3637ac5f-8df1-4961-b321-dcb10de2bf2f",
    "InsuranceLevel": null,
    "CarrierAccount": null,
    "AuctionPackages": [
      {
        "Id": "8edd46a0-f072-4b79-b880-e0a8c6caeaed",
        "BidParcelId": "sample string 2",
        "AuctionParcelId": "d165e1ef-54d2-4c57-bfe3-fd9e79695aff",
        "Name": "sample string 4",
        "Weight": 5.0,
        "Height": 6.0,
        "Width": 7.0,
        "Length": 8.0,
        "QrCode": "a40f76a5-f15f-431d-8e6f-871e75901dc7",
        "PackageId": "f44fc0aa-4a17-4842-9977-fb738dbed415",
        "IsPickedup": true,
        "ExternalCode": 1
      },
      {
        "Id": "8edd46a0-f072-4b79-b880-e0a8c6caeaed",
        "BidParcelId": "sample string 2",
        "AuctionParcelId": "d165e1ef-54d2-4c57-bfe3-fd9e79695aff",
        "Name": "sample string 4",
        "Weight": 5.0,
        "Height": 6.0,
        "Width": 7.0,
        "Length": 8.0,
        "QrCode": "a40f76a5-f15f-431d-8e6f-871e75901dc7",
        "PackageId": "f44fc0aa-4a17-4842-9977-fb738dbed415",
        "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.