GET api/Parcel/Get?authToken={authToken}&parcelId={parcelId}

Get Specific Parcel by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authToken

The Authentication Token

string

Required

parcelId

The Parcel Id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ServiceResultOfParcelDetailsModel
NameDescriptionTypeAdditional information
Result

ParcelDetailsModel

None.

ErrorCode

ServiceErrorCode

None.

ErrorMessage

Collection of string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Name": "sample string 2",
    "BidParcelId": "sample string 3",
    "NumberOfVolumes": 4,
    "Comments": "sample string 5",
    "Reference": "sample string 6",
    "ATCode": "sample string 7",
    "InsurancesIsActive": true,
    "InsuranceType": 1,
    "InsuranceTypeDisplay": "sample string 9",
    "InsuranceFixedModel": null,
    "InsuranceLevelId": "3a511580-d27a-446d-816e-1aab732d21cb",
    "InsuranceLevel": null,
    "CollectionAddress": "sample string 10",
    "CollectionZipCode": "sample string 11",
    "CollectionPhone": "sample string 12",
    "CollectionName": "sample string 13",
    "CollectionCity": "sample string 14",
    "CollectionCountry": "5f820174-0452-4d7d-b40f-fe09281da92f",
    "CollectionCountryDisplay": "sample string 16",
    "DestinationName": "sample string 17",
    "DestinationEmail": "sample string 18",
    "DestinationPhone": "sample string 19",
    "DestinationAddress": "sample string 20",
    "DestinationZipCode": "sample string 21",
    "DestinationCity": "sample string 22",
    "DestinationCountry": "c6d7ba01-e44d-486d-9e61-0275707e6e50",
    "DestinationCountryDisplay": "sample string 24",
    "Packages": [
      {
        "Id": "fbd30c47-70dd-4fb4-865c-28f1b71a5e76",
        "PackageNumber": 2,
        "Name": "sample string 3",
        "Weight": 4.0,
        "Height": 5.0,
        "Width": 6.0,
        "Length": 7.0,
        "Quantity": 8,
        "BidParcelId": "sample string 9",
        "ExternalOperatorId": "76b1a5a4-9b88-4337-be49-78ca3f172218",
        "ExternalOperator": "sample string 10",
        "ExternalCode": 1
      },
      {
        "Id": "fbd30c47-70dd-4fb4-865c-28f1b71a5e76",
        "PackageNumber": 2,
        "Name": "sample string 3",
        "Weight": 4.0,
        "Height": 5.0,
        "Width": 6.0,
        "Length": 7.0,
        "Quantity": 8,
        "BidParcelId": "sample string 9",
        "ExternalOperatorId": "76b1a5a4-9b88-4337-be49-78ca3f172218",
        "ExternalOperator": "sample string 10",
        "ExternalCode": 1
      }
    ]
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.