# Parcel

The Parcel endpoint returns information regarding a given parcel. This broadly includes shipper and consignee address, delivery information, ETA timestamps and much more.

Endpoint: GET /api/v2/external/parcel/{parcelIdentifier}
Version: 2.0.0
Security: bearerToken

## Path parameters:

  - `parcelIdentifier` (string, required)
    Parcel number or tracking id
    Example: "10362781851"

## Response 200 fields (application/json):

  - `parcelNumber` (string, required)
    Example: "10362781851"

  - `trackingId` (string, required)
    Example: "YUTKBBTN"

  - `status` (any, required)

  - `jobType` (string, required)
    Enum: "DELIVERY", "PICKUP", "COLLECTION", "UNKNOWN"

  - `supportedCustomizedDeliveryTypes` (array, required)
    Enum: "DEPOSIT_PERMISSION", "DELIVER_TO_NEIGHBOR", "DELIVER_TO_PARCELSHOP", "HINT"

  - `shipperId` (string)

  - `customizedDelivery` (any)

  - `fromAddress` (object)

  - `fromAddress.name` (string)
    Example: "Max Mustermann"

  - `toAddress` (object)

  - `toAddress.street` (string)
    Example: "GLS Germany-Straße"

  - `toAddress.number` (string)
    Example: "1-7"

  - `toAddress.postcode` (string)
    Example: 36286

  - `toAddress.city` (string)
    Example: "Neuenstein"

  - `toAddress.country` (string)
    Two digit country code of format ISO 3166-1 alpha-2
    Example: "DE"

  - `toAddress.coordinates` (object)

  - `toAddress.coordinates.lat` (number, required)
    Geographic latitude coordinate
    Example: 50.9098881

  - `toAddress.coordinates.lng` (number, required)
    Geographic longitude coordinate
    Example: 9.5806327

## Response 401 fields (application/json):

  - `message` (string, required)
    Example: "Unauthorized"

## Response default fields (application/json):

  - `id` (string, required)
    Example: "PARCEL-404"

  - `reason` (string)
    Example: "The provided trackingId cannot be found."

  - `payload` (string)