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

​
Methods

​
Entity Properties

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.
​
options
null | array
  • null - No options will be applied.
  • object - Apply specified Search Options.
​
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:
['*', 'package_status']
See Package Properties.

​
Entity Properties

​
Package Properties

​
Package Item Properties

​
Shipment Track Properties