---
title: "get parcel item by trackingNumber"
method: GET
path: "/api/v{version}/parcels/{trackingNumber}"
tags: ["orders"]
---

# get parcel item by trackingNumber

`GET /api/v{version}/parcels/{trackingNumber}`

gets parcel item by id. Permissions requises : SupplierAdminRole, SupplierParcelsManagerRole.

## Path parameters

- `version` string, required
- `trackingNumber` string, required

## Query parameters

- `scan` boolean

## Headers

- `X-Tenant` string, required

## Response `200`

OK

- GetParcelResponse
  - `id` string, uuid
  - `customer` ParcelCustomerDto
    - `customerId` string, uuid
    - `name` string, nullable
    - `phone` PhoneDto
      - `number1` string, nullable
      - `number2` string, nullable
      - `number3` string, nullable
  - `supplier` ParcelSupplierDto
    - `supplierName` string, nullable
    - `supplierCityTerritoryId` string, uuid
    - `supplierHubId` string, uuid
    - `supplierHubCityTerritoryId` string, uuid
    - `supplierHubName` string, nullable
    - `phone` PhoneDto
      - `number1` string, nullable
      - `number2` string, nullable
      - `number3` string, nullable
    - `supportPhone` PhoneDto
      - `number1` string, nullable
      - `number2` string, nullable
      - `number3` string, nullable
  - `deliveryAddress` ParcelAddressDto
    - `street` string, nullable
    - `city` string, nullable
    - `cityTerritoryId` string, uuid
    - `district` string, nullable
    - `districtTerritoryId` string, uuid
    - `cityTerritoryCode` integer
    - `postalCode` string, nullable
    - `country` string, nullable
    - `coordinates` Coordinates
      - `lat` number, double, nullable
      - `lng` number, double, nullable
    - `hubId` string, uuid, nullable
    - `hubName` string, nullable
  - `createdAt` string, date-time, nullable
  - `amount` number, double, nullable
  - `deliveryPrice` number, double, nullable
  - `returnPrice` number, double, nullable
  - `trackingNumber` string, nullable
  - `paymentMethod` string, nullable
  - `deliveryType` string, nullable
  - `weight` WeightDto
    - `weight` number, double, nullable
    - `dimensionalWeight` number, double, nullable
    - `effectiveWeight` number, double
  - `bagId` string, uuid, nullable
  - `deliveryPersonId` string, uuid, nullable
  - `deliveryPerson` GetDeliveryPersonWithHubDto
    - `id` string, uuid
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `assignedPriceListId` string, uuid
    - `phone` PhoneDto
      - `number1` string, nullable
      - `number2` string, nullable
      - `number3` string, nullable
    - `hub` GetHubDto
      - `id` string, uuid
      - `name` string, nullable
      - `type` string, nullable
      - `address` AddressDto
        - `street` string, nullable
        - `city` string, nullable
        - `cityTerritoryId` string, uuid
        - `district` string, nullable
        - `districtTerritoryId` string, uuid
        - `postalCode` string, nullable
        - `country` string, nullable
        - `coordinates` Coordinates
          - `lat` number, double, nullable
          - `lng` number, double, nullable
      - `services` HubServiceDto[], nullable
        - `id` string, uuid
        - `type` string, nullable
    - `email` string, nullable
    - `status` string, nullable
    - `isUnavailable` boolean
    - `isAccountActivated` boolean
    - `penalities` PenalityDto[], nullable
      - `id` string, uuid
      - `reducedCommission` number, double
      - `startDate` string, date-time
      - `endDate` string, date-time
      - `comment` string, nullable
  - `state` StateDto
    - `id` string, uuid
    - `name` string, nullable
    - `description` string, nullable
    - `isBlocking` boolean, nullable
    - `isLocked` boolean, nullable
    - `visibleFor` 0 | 1 | 2 | 4 | 8
    - `editableBy` 0 | 1 | 2 | 4 | 8
    - `color` string, nullable
  - `lastStateSituationId` string, uuid, nullable
  - `situation` SituationDto
    - `id` string, uuid
    - `name` string, nullable
    - `description` string, nullable
    - `slug` string, nullable
    - `metadata` object, nullable
  - `tenantId` string, nullable
  - `lastLocationHubId` string, uuid, nullable
  - `lastStateUpdateAt` string, date-time, nullable
  - `lastSituationUpdateAt` string, date-time, nullable
  - `hubStockId` string, uuid, nullable
  - `description` string, nullable
  - `productsDescription` string, nullable
  - `productsStockType` string, nullable
  - `isReturn` boolean, nullable
  - `isControlled` boolean, nullable
  - `type` string, nullable
  - `isExchanged` boolean, nullable
  - `originalParcelId` string, uuid, nullable
  - `returnParcelId` string, uuid, nullable
  - `pickupBagId` string, uuid, nullable
  - `externalId` string, nullable
  - `hasActiveModificationRequest` boolean, nullable
  - `orderedProducts` OrderedProductResponse[], nullable
    - `id` string, uuid
    - `productId` string, uuid
    - `productName` string, nullable
    - `productSku` string, nullable
    - `unitPrice` number, double, nullable
    - `quantity` integer, nullable
    - `stockType` string, nullable
    - `dimensions` DimensionsResponse
      - `length` number, double, nullable
      - `width` number, double, nullable
      - `height` number, double, nullable

---

[API](https://skmtc.net/zrexpress/apis/zrexpress-api.md) · [All operations](https://skmtc.net/zrexpress/apis/zrexpress-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zrexpress/zrexpress-api/versions/99b075e0b641/schema)