Methods


Entity Properties


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


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

orderdescription
0
  • null - Retrieve list of all packages.
  • object - Retrieve list of packages using specified filters.
1
  • null - No options will be applied.
  • object - Apply specified options.
2
  • 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 '*'.

See "Package Properties". Example: ['*', 'package_status']

Entity Properties

Package Properties

package_id
{ "package_id" : "123" }
The internal package ID.
shipment_id
{ "shipment_id" : "100000005" }
The "Shipment ID" property. This number may appear on the packing slip as the "Packing Slip #".
order_unique_id
{ "order_unique_id" : "100000010" }
The "unique_id" property for the order associated with this shipment.
order_ref
{ "order_ref" : "ABC-54321" }
The user-specified order "order_ref" field.
package_status
{ "package_status" : "not_on_manifest" }
The "Status" property. Allowed values: not_on_manifest, on_manifest, on_truck.
updated_at
{ "updated_at" : "2016-05-11 18:51:18" }
The "Updated At" property.
items Array of Package Item objects.
tracking_numbers Array of Shipment Track objects.

Package Item Properties

sku
{ "sku" : "product1" }
The "SKU" property.
name
{ "name" : "product1" }
The "Name" property.
weight
{ "weight" : 12 }
The "Weight" propertry.
qty
{ "qty" : 1 }
The "Quantity" propertry.
order_item_id
{ "order_item_id" : 2 }
The internal order item ID.
package_data
[
    {"label" : "Serial Number - 8 Characters", "value" : "55285368"},
    {"label" : "Serial Number - 8 Characters", "value" : "55285368"}
]
The "Package Data" property.

Shipment Track Properties

track_id
{ "track_id" : 1 }
The internal track ID.
carrier
{ "carrier" : "fedex" }
The carrier code.
carrier_name
{ "carrier_name" : "Federal Express" }
The carrier name.
description
{ "description" : "Express Saver" }
The method description (without the carrier name).
number
{ "track_number" : "800027315160887" }
The carrier's tracking number.
date
{ "created_at" : "2014-07-24T18:51:18+00:00" }
The date and time the tracking number was created.