XPS Ship

Interact with XPS Ship API for comprehensive shipping operations

Actions17

Quote Actions
- Get Quote
Order Actions
- Create Order
- Delete Order
Shipment Actions
Label Actions
- Download Label
Service Actions
- List Services
- Get Integrated Quoting Options
Tag Actions
Webhook Actions

Shipment → Search Shipments

AI-generated

Summary

Search shipments for a given XPS Ship customer using optional filters such as start date, end date, and tracking number.

Inputs

Customer ID (required) — The XPS Ship customer ID to identify the customer account for the shipment search.
Search Parameters — Optional filters for the search including Start Date, End Date, and Tracking Number to narrow down shipment results.

Output shape

a list of shipment records matching the search criteria

The results include shipments filtered by the specified parameters if provided. If no search parameters are given, it returns shipments for the customer without additional filtering.

Examples

Example 1: Search all shipments for a customer within a date range

Provide Customer ID and set Start Date and End Date in Search Parameters to filter shipments by date.

Example 2: Search shipments by tracking number

Provide Customer ID and Tracking Number in Search Parameters to find shipments matching that tracking number.

XPS ShipInstall