> ## 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

**filters** `null | object`

* `null` - Retrieve list of all packages.
* `object` - Retrieve list of packages using specified [Search Filters](https://docs.shipstream.io/merchant-api/search-filters.md).

**options** `null | array`

* `null` - No options will be applied.
* `object` - Apply specified [Search Options](https://docs.shipstream.io/merchant-api/search-options.md).

**fields** `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).

## Entity Properties

### Package Properties

**Package Properties**

**package\_id** `string`

The internal package ID.

**shipment\_id** `string`

The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #".

**order\_unique\_id** `string`

The "unique\_id" property for the order associated with this shipment.

**order\_ref** `string`

The user-specified order "order\_ref" field.

**package\_status** `string`

The "Status" property. Allowed values: packing, tracking\_required, packed, manifested, shipped, delivered.

**updated\_at** `string`

The "Updated At" property.

**shipped\_at** `string`

Date and time when the package was shipped from the warehouse in ISO 8601 format.

**delivered\_at** `string`

Date and time when the package was delivered in ISO 8601 format.

**items** `array`

Array of [Package Item](#package-item-properties) objects.

**sscc** `string`

The Serial Shipping Container Code.

**tracking\_numbers** `array`

Array of [Shipment Track](#track-properties) objects.

### Package Item Properties

**Package Item Properties**

**sku** `string`

The "SKU" property.

**name** `string`

The "Name" property.

**weight** `number`

The "Weight" property.

**weight\_unit** `string`

The unit of measure used for `weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).

**qty** `integer`

The "Quantity" property.

**order\_item\_id** `integer`

The internal order item ID.

**package\_data** `array`

The "Package Data" property.

### Shipment Track Properties

**Shipment Track Properties**

**track\_id** `integer`

The internal track ID.

**carrier** `string`

The carrier code.

**carrier\_name** `string`

The carrier name.

**description** `string`

The method description (without the carrier name).

**number** `string`

The carrier's tracking number.

**date** `string`

The date and time the tracking number was created.

**items** `array`

SKUs and quantities of the related package items.

**weight** `string`

The weight of the package.

**weight\_unit** `string`

The unit of measure used for `weight`. See: [Weight Units](https://docs.shipstream.io/merchant-api/units-of-measure.md#weight).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.