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

# Package

There may be multiple packages for one shipment. Each package may have multiple tracking numbers, most packages will have only one tracking number.

## Methods

* [package.search](#package-search)

***

## Entity Properties

* [Package](#package-properties)

***

## `package.search`

`package.search(null|object $filters, array $options = [], null|string|object $fields = [])`

Retrieve list of packages by filters. Package data can be customized by specifying properties to retrieve.

### Parameters

<ParamField path="filters" type="null | object">
  * `null` - Retrieve list of all packages.
  * `object` - Retrieve list of packages using specified [Search Filters](/merchant-api/search-filters).
</ParamField>

<ParamField path="options" type="null | array">
  * `null` - No options will be applied.
  * `object` - Apply specified [Search Options](/merchant-api/search-options).
</ParamField>

<ParamField path="fields" type="null | string | object">
  * `null` - Retrieve "shipment\_id", "order\_unique\_id" and "order\_ref".
  * `string '*'` - Retrieve all properties excluding "items" and "tracking\_numbers".
  * `object` - List of properties to retrieve in addition to "shipment\_id", "order\_unique\_id" and "order\_ref". List may include '\*'.
    Example:

  ```json theme={null}
  ['*', 'package_status']
  ```

  See [Package Properties](#package-properties).
</ParamField>

## Entity Properties

### Package Properties

<Expandable title="Package Properties">
  <ParamField path="package_id" type="string">
    The internal package ID.
  </ParamField>

  <ParamField path="shipment_id" type="string">
    The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #".
  </ParamField>

  <ParamField path="order_unique_id" type="string">
    The "unique\_id" property for the order associated with this shipment.
  </ParamField>

  <ParamField path="order_ref" type="string">
    The user-specified order "order\_ref" field.
  </ParamField>

  <ParamField path="package_status" type="string">
    The "Status" property. Allowed values: packing, tracking\_required, packed, manifested, shipped, delivered.
  </ParamField>

  <ParamField path="updated_at" type="string">
    The "Updated At" property.
  </ParamField>

  <ParamField path="shipped_at" type="string">
    Date and time when the package was shipped from the warehouse in ISO 8601 format.
  </ParamField>

  <ParamField path="delivered_at" type="string">
    Date and time when the package was delivered in ISO 8601 format.
  </ParamField>

  <ParamField path="items" type="array">
    Array of [Package Item](#package-item-properties) objects.
  </ParamField>

  <ParamField path="sscc" type="string">
    The Serial Shipping Container Code.
  </ParamField>

  <ParamField path="tracking_numbers" type="array">
    Array of [Shipment Track](#track-properties) objects.
  </ParamField>
</Expandable>

### Package Item Properties

<Expandable title="Package Item Properties">
  <ParamField path="sku" type="string">
    The "SKU" property.
  </ParamField>

  <ParamField path="name" type="string">
    The "Name" property.
  </ParamField>

  <ParamField path="weight" type="number">
    The "Weight" property.
  </ParamField>

  <ParamField path="weight_unit" type="string">
    The unit of measure used for `weight`. See: [Weight Units](/merchant-api/units-of-measure#weight).
  </ParamField>

  <ParamField path="qty" type="integer">
    The "Quantity" property.
  </ParamField>

  <ParamField path="order_item_id" type="integer">
    The internal order item ID.
  </ParamField>

  <ParamField path="package_data" type="array">
    The "Package Data" property.
  </ParamField>
</Expandable>

### Shipment Track Properties

<Expandable title="Shipment Track Properties">
  <ParamField path="track_id" type="integer">
    The internal track ID.
  </ParamField>

  <ParamField path="carrier" type="string">
    The carrier code.
  </ParamField>

  <ParamField path="carrier_name" type="string">
    The carrier name.
  </ParamField>

  <ParamField path="description" type="string">
    The method description (without the carrier name).
  </ParamField>

  <ParamField path="number" type="string">
    The carrier's tracking number.
  </ParamField>

  <ParamField path="date" type="string">
    The date and time the tracking number was created.
  </ParamField>

  <ParamField path="items" type="array">
    SKUs and quantities of the related package items.
  </ParamField>

  <ParamField path="weight" type="string">
    The weight of the package.
  </ParamField>

  <ParamField path="weight_unit" type="string">
    The unit of measure used for `weight`. See: [Weight Units](/merchant-api/units-of-measure#weight).
  </ParamField>
</Expandable>