Shipment

The shipment object represents a shipment for an order, including carrier and tracking information.

{%- comment -%} Show shipment tracking {%- endcomment -%}
<p>{{ shipment.title }} — {{ shipment.carrier }}</p>
{% if shipment.tracking_url %}
  <a href="{{ shipment.tracking_url }}">Track {{ shipment.tracking_code }}</a>
{% endif %}

title

Title for this shipment, usually carrier name and product name combined.

carrier

Carrier name

carrier_product

Carrier product name

description

Description for this shipment if any

address

Shipping address

pickup_address

Pickup address address if any.

packages

Returns information about shipment packages, following properties are available for the package:

• description
• width (in cm)
• height (in cm)
• length (in cm)
• weight (in grams)
• items
  • shipped_quantity
  • line_item
  • width
  • height
  • length
  • weight
• tracking_url (if defined)
• tracking_code (if defined)

tracking_url

Tracking url for this shipment. If this is multiparcel shipment, the first available package tracking url is returned.

tracking_code

Tracking code for this shipment. If this is multiparcel shipment, the first available package tracking code is returned.

created_at

Date when this shipment was created