---
title: "Get a list of parcels"
method: POST
path: "/api/v{version}/parcels/search"
tags: ["orders"]
---

# Get a list of parcels

`POST /api/v{version}/parcels/search`

Get a list of parcels with pagination and filtering support. Permissions requises : SupplierAdminRole, SupplierParcelsManagerRole.

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchSupplierParcelsRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable
  - `includeProducts` boolean
  - `parcelTypes` string[], nullable

## Response `200`

OK

- PagedListSearchSupplierParcelResponse
  - `items` SearchSupplierParcelResponse[], nullable
    - `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
    - `returnPrice` number, double, nullable
    - `deliveryPrice` 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
    - `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
    - `hubStockId` 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
    - `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
    - `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
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

---

[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)