---
title: "Finds shipments based on search parameters"
method: POST
path: "/api/shipments/list"
tags: ["Shipments"]
---

# Finds shipments based on search parameters

`POST /api/shipments/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- ShipmentsListParameters — Parameters used for searching V3 shipments
  - `shipmentStatus` 'pending' | 'open' | 'shipped' | 'cancelled'
  - `packingStatus` 'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked'
  - `salesOrderId` string, nullable — Filter shipments by sales order identifier
  - `purchaseOrderId` string, nullable — Filter shipments by purchase order identifier
  - `shipmentType` 'unknown' | 'standard' | 'outsideProcessing'
  - `shipmentIds` string[] — Filter shipments by shipment identifiers.
  - `shipByDateBefore` string, date-time, nullable — Filter to shipments scheduled to ship before this date (exclusive).
  - `shipByDateAfter` string, date-time, nullable — Filter to shipments scheduled to ship after this date (exclusive).
  - `shippedDateBefore` string, date-time, nullable — Filter to shipments actually shipped before this date (exclusive). Compares against the shipped date override (a shop-local date) when one is set, otherwise the shipped date (UTC).
  - `shippedDateAfter` string, date-time, nullable — Filter to shipments actually shipped after this date (exclusive). Compares against the shipped date override (a shop-local date) when one is set, otherwise the shipped date (UTC).

## Response `200`

OK

- DtoPagedResultDtoShipmentsShipmentDto — Paged result
  - `data` ShipmentsShipmentDto[], required — The data
    - `id` string, required — Unique id associated to this entity.
    - `number` integer, required — Number
    - `name` string, required — Shipment Name
    - `status` 'pending' | 'open' | 'shipped' | 'cancelled', required
    - `packingStatus` 'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked', required
    - `trackingNumber` string, nullable — Tracking number
    - `shipByDate` string, date-time, nullable — Ship by date.
    - `shippedDate` string, date-time, nullable — Shipped date.
    - `shippedDateOverride` string, date-time, nullable — Shipped date override.
    - `notes` string, nullable — Shipment notes.
    - `displayNotesToCustomer` boolean — Whether to display the shipment notes on the pack list.
    - `shippingMethod` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `shippingAccount` CommonReferenceDto — Represents a reference to a document in a DB collection
      - `id` string, nullable — Unique Id associated to the referenced object
      - `name` string, nullable — Descriptive name associated to the object
    - `shippingCost` number, double, nullable — The actual cost to ship as set on the shipment page
    - `shippingCharge` number, double, nullable — The estimated cost to ship as set on the original shipment from the sales order page. It is charged to the customer via the Shipping/Handling line
    - `address` CommonAddressDto — Address definition
      - `name` string, nullable — Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).
      - `address1` string, required — Primary address line.
      - `address2` string, nullable — Second address line.
      - `address3` string, nullable — Third address line.
      - `city` string, required — Address city
      - `stateProvince` string, nullable — Address state/province.
      - `postalCode` string, required — Postal/zip code.
      - `country` string, nullable — Country identifier.
      - `phone` string, tel, nullable — Phone number.
      - `email` string, email, nullable — Email address
    - `customFields` object, nullable — Custom fields that have been defined on this entity.
    - `externalReferences` object, nullable — The external references associated with this shipment
  - `page` integer, required — The 1-indexed page
  - `pageSize` integer, required — The page size
  - `totalCount` integer, required — The total count of records
  - `totalPages` integer, required — The total pages
  - `hasPreviousPage` boolean, required — True if there is a previous page
  - `hasNextPage` boolean, required — True if there is a next page

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)