Shipments

A shipment records the delivery of equipment against a purchase order. Each shipment is dispatched by a single courier and may include any number of line items drawn from the purchase order's BOM line items.

Multiple shipments may be associated with a single purchase order - for example, when an order is fulfilled in several deliveries or when a partial shipment is replaced.

Fields

Purchase Order

The purchase order this shipment delivers against.

Courier

The courier delivering the shipment.

Courier Account

The courier account being billed for the shipment. Optional. If specified, the account must belong to the selected courier.

Site

The destination site for the shipment. Optional, but a site and/or location is required when the shipment status is set to received.

Location

The destination location within the site. Optional, but a site and/or location is required when the shipment status is set to received. If specified, the location must belong to the selected site.

Tracking Number

The tracking number provided by the courier. The combination of courier and tracking number must be unique. When the courier has a tracking URL defined, this value is rendered as a clickable link.

Status

The shipment's lifecycle status. One of:

• Prepared (default)
• Shipped
• Received
• Cancelled
• Returned
• Lost

Permitted status transitions are controlled by status transition rules.

Date Shipped

The date on which the shipment left the vendor. Optional.

Date Expected

The date on which the shipment is expected to arrive. Optional. Must not be earlier than the date shipped.

Date Received

The date on which the shipment was received. Optional. Must not be earlier than the date shipped.

Archived

Indicates whether the shipment has been archived. Archiving preserves a shipment for future reference without disturbing its status or other attributes. Archived shipments are hidden from the list view by default; set the Archived list filter to Yes to view them. A shipment can be archived or unarchived with the Archive / Unarchive button on its detail page, through bulk editing, or via the edit form, import, and REST API. The REST API returns archived objects by default and accepts ?archived=true / ?archived=false to filter them.

While a shipment is archived it is read-only in the UI: it cannot be edited, have its status changed, or have its line items added, modified, or deleted. Unarchive the shipment to resume editing. It can still be deleted while archived.