> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perform.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Shipment Overview

> Search, filter, view, update and export every shipment and order in one workspace, with parcel details, statuses, bookmarks and bulk actions.

**Available to all Post-Purchase customers.**

## Summary

Shipment Overview is the workspace where you see every shipment and order, their current status and tracking history, and act on them. Filters, bookmarks, search, column settings, bulk actions and exports let support and operations teams work through large volumes quickly.

## Who it’s for

Customer service agents answering a shopper’s question about one parcel, and operations teams monitoring pending, delayed or returned shipments across carriers and markets.

## Key benefits

* **Every shipment in one list.** Outbound and return shipments from the API, file uploads, Shopify and other channels appear together, with the latest event and status.
* **Find what you need fast.** Search by tracking number, shipment or order reference, carrier, tag or recipient email, including partial matches, and filter on dates, status, carrier, destination, issues and more.
* **Save the views you use daily.** Bookmarks store a filter and column set, and can be shared with your team.
* **Act in bulk.** Export, archive or tag many shipments at once.
* **See the whole journey.** Parcel details show tracking events, addresses, line items, costs, notifications sent, ratings, documents and proof of delivery.

## How it works

### Shipment statuses

| Status | Meaning |
| - | - |
| Pending | No tracking event yet |
| Expired | Pending shipment that received no event in the 10 days after its first update cycle |
| Active | At least one tracking event, not yet delivered |
| Inactive | Active shipment with no new event for 14 days after the last one |
| Delivered | Delivered or collected |
| Return | Carries a return-to-sender event, either a failed delivery returned to you or a return started by the shopper |

Perform.AI updates each shipment on a schedule that depends on its status. If a carrier shows an event that has not reached the shipment yet, select **Update** in the shipment details to request an instant update.

### Search and filters

Search matches partial values on tracking number, shipment ID and reference, order ID and reference, carrier, tag and recipient email.

Date filters cover date added, date shipped, date delivered and date of an issue event. Data filters include carrier, cash on delivery, notification phone, destination and origin country, domestic or international, duties borne by, channel, issue and issue type, last event, order source, payment type, shipping service, status, tags, each address type, sender and recipient country, Tracking Page reference, sales channel, destination region, line items, rating and rating categories, notifications sent, linked carrier, shipment type (outbound or return), booking result and shipping product.

### Columns and bookmarks

Choose up to 20 columns and drag them into the order you want. Save a filter and column set as a bookmark, share it with other users in your account, and open shared bookmarks from **View all bookmarks**. Standard bookmarks give ready-made views such as pending or delayed shipments.

### Parcel details

| Section | Contents | Editable |
| - | - | - |
| Tracking details | Identifiers, status, progress milestones, events with date, time, location and tooltips, recipient information and proof of delivery, carrier name, reference and tracking link | No |
| Customer data | To, from, recipient, sender and return addresses, order information, custom fields | Yes |
| Line items | Product image, name, quantity, prices, costs, discounts, tax and duties | No |
| Tags | Your own tags | Yes |
| Shipping costs | Total or itemised shipping costs | No |
| Additional details | Shipment UUID, shipment information, timestamps, shipment type | Partly |
| Notifications | Email addresses and phone numbers notified, and the history of notifications sent | Yes |
| Rating | Score, reason, timestamp and comment from the Tracking Page | No |
| Documents | Packing slips, invoices and other documents | Download |
| Notes | Your notes on the shipment | Yes |

The language, timezone and time format of tracking details follow your profile settings.

### Linked shipments

When a parcel moves between carriers, Perform.AI combines the events from each carrier into one view. For some carriers, mostly postal carriers, the next carrier is found automatically. You can also add up to 10 linked tracking numbers with their carriers when creating a shipment.

### Proof of delivery

When the carrier provides it, proof of delivery (a signature, a photo at the delivery location or the recipient’s name) appears in the recipient information section and can be downloaded as a JPG. It is also returned as `pod_url` in the v5.2 shipment details and webhook payloads; the link is public and expires after 7 days, and a new link is generated on each response. Availability depends on the carrier and the integration.

### Bulk actions and export

Select shipments with the checkboxes to **Export**, **Archive** or **Add tags**. Export generates a CSV report and emails you a download link; large exports take from 15 minutes to about an hour. The maximum number of rows per export depends on your subscription and is shown in the export dialog. To export only the current page, use the three-dot menu and choose **Export parcels**.

## Set up in the portal

Go to **Post-Purchase** > **Shipment Overview**.

1. Add filters and search to narrow the list, then select the three-dot menu and **Edit columns** to choose up to 20 columns. Select **Confirm**.
2. Select the three-dot menu and **Save as bookmark**, name it and save. Share it with your team from the bookmark menu.
3. Open a shipment to see its parcel details. Edit customer data, tags, shipment information, notification recipients and notes directly; select **Update** to request the latest carrier events.
4. Select shipments with the checkboxes to export, archive or tag them in bulk.

## Use via API and MCP

* [List Shipments](https://developers.perform.ai/api-reference/v5/shipments/list-shipments.md) with the same filters as the portal, and [Retrieve Shipment Details](https://developers.perform.ai/api-reference/v5/shipments/retrieve-shipment-details.md) or the [v5.2 variant](https://developers.perform.ai/api-reference/v5/shipments/retrieve-shipment-details-v52.md) for one shipment. Guides: [List shipments](https://developers.perform.ai/guides/list-shipments.md), [Retrieve a shipment](https://developers.perform.ai/guides/retrieve-shipment.md).
* Documents: [List documents](https://developers.perform.ai/api-reference/v5/documents/list-documents.md) and [Retrieve a document](https://developers.perform.ai/api-reference/v5/documents/retrieve-a-document.md). Guide: [Shipment documents](https://developers.perform.ai/guides/shipment-documents.md).
* MCP tools: `list_shipments`, `list_shipments_filters`, `get_shipment_filter_values`, `list_event_types`, `list_bookmarks`, `list_shipments_from_saved` and `get_shipment_details`. See [MCP tools](https://developers.perform.ai/mcp/tools.md).

## FAQ

### Why does a shipment show no update?

The next scheduled update has not run yet, the shipment was added without a carrier reference the carrier recognises, or the carrier integration is under maintenance. Select **Update** on the shipment; if that fails, contact your account team.

### How do I see only return shipments?

Filter on **Shipment type** = Return. Return shipments are listed with outbound shipments and separated by this filter.

### How many rows can I export?

The limit depends on your subscription and is shown in the export dialog. Larger limits are available through your account team.

### Can I edit a shipment after it was created?

Yes. Customer data, tags, shipment information, shipment type, notification recipients and notes can be edited in the parcel details. Tracking data from the carrier cannot be edited.

### Why do events differ from the carrier’s own site?

Carrier events are mapped to standard Perform.AI events and the shipment is updated on a schedule. If a mapping looks wrong, ask your account team for an event mapping review.

## Troubleshooting

| Symptom | Cause | Fix |
| - | - | - |
| Shipment stuck in Pending | No carrier event received yet, or the carrier reference is not configured for the account | Check the carrier assigned to the shipment and reassign it if needed, then select **Update**. |
| Export email never arrives | The export is still running, or the row limit was exceeded | Wait up to an hour, then check the limit in the export dialog and narrow the filter. |
| A column I need is missing | It is not in the standard column set | Search for it in **Edit columns**; if it is not there, ask your account team about customisation. |
| Proof of delivery link no longer opens | The `pod_url` expired after 7 days | Request the shipment details again to receive a new link. |
| Linked carrier events do not appear | The second carrier is not linked | Add the linked tracking number and carrier when creating the shipment. |

## Related

* [Delivery Notifications](https://developers.perform.ai/products/post-purchase/delivery-notifications.md)
* [Delivery Experience Ratings](https://developers.perform.ai/products/post-purchase/delivery-experience-ratings.md)
* [Returns Overview](https://developers.perform.ai/products/returns/returns-overview.md)
* [Data Integration](https://developers.perform.ai/products/platform/data-integration.md)
* [Post-Purchase overview](https://developers.perform.ai/products/post-purchase/overview.md)


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