> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shippeek.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search shipments

> Search and filter shipments with pagination. Supports filtering by status, mode, carrier, dates, and free-text search.



## OpenAPI

````yaml openapi.json get /shipments
openapi: 3.0.0
info:
  title: ShipPeek API
  version: 1.0.0
  description: Multi-carrier shipping rate aggregation, booking, and tracking API.
  contact:
    name: ShipPeek API Support
    email: yash@shippeek.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://shippeek.com/terms
servers:
  - url: https://api.shippeek.dev
    description: Sandbox
  - url: https://api.shippeek.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Rates
    description: Get shipping rates from multiple carriers
  - name: Booking
    description: Book shipments and manage pickups
  - name: Tracking
    description: Track shipments by PRO or tracking number
  - name: Shipments
    description: Retrieve and search shipment data
paths:
  /shipments:
    get:
      tags:
        - Shipments
      summary: Search shipments
      description: >-
        Search and filter shipments with pagination. Supports filtering by
        status, mode, carrier, dates, and free-text search.
      operationId: searchShipments
      parameters:
        - name: continuationToken
          in: query
          description: Pagination token from a previous response
          schema:
            type: string
        - name: search
          in: query
          description: >-
            Search by PRO, tracking number, reference, BOL, company, city, or
            postal code
          schema:
            type: string
        - name: status
          in: query
          description: Filter by shipment status
          schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - awarded
                - confirmed
                - picked-up
                - delivered
                - canceled
        - name: mode
          in: query
          description: Filter by transport mode
          schema:
            type: array
            items:
              type: string
              enum:
                - ltl
                - parcel
                - truckload
        - name: pickupDateStart
          in: query
          description: Start of pickup date range (YYYY-MM-DD)
          schema:
            type: string
            format: date
        - name: pickupDateEnd
          in: query
          description: End of pickup date range (YYYY-MM-DD)
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Shipments returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  shipments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        createdDate:
                          type: string
                          format: date-time
                        status:
                          type: string
                        origin:
                          $ref: '#/components/schemas/Address'
                        destination:
                          $ref: '#/components/schemas/Address'
                        carrier:
                          type: object
                          properties:
                            name:
                              type: string
                            scac:
                              type: string
                        cost:
                          type: object
                          properties:
                            total:
                              type: number
                            currency:
                              type: string
                  continuationToken:
                    type: string
                    description: Token to fetch the next page
        '400':
          description: Invalid filter parameters
        '401':
          description: Unauthorized
components:
  schemas:
    Address:
      type: object
      properties:
        company:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your ShipPeek API token in the format `client_id.client_secret`.

````