v1

latestOpenAPI 3.1.0Proprietary2026-07-24710198.3 KB
Shipments

Get Shipments by Month and Year

Retrieves all shipments created under your account for a specific calendar month and year. Returns a summary list including tracking numbers, carriers, statuses, and creation dates.

When to use: Call this endpoint to build shipment history dashboards, generate monthly shipping reports, reconcile invoices, or audit shipment volumes for a given period.

Prerequisites:

  • Valid JWT token in the Authorization header
  • Month (MM) as a zero-padded two-digit string (01-12)
  • Year (YYYY) as a four-digit string

Key behaviors:

  • Returns all shipments for the authenticated account within the specified month
  • Results include tracking_number, carrier, status, and created_at for each shipment
  • The tracking_number from the response can be used with GET /guide/{tracking_number} to fetch full shipment details
  • Large result sets may be paginated; check the response for pagination metadata
get/guide/{MM}/{YYYY}

Path parameters

MMstring required
Example:03

Month (01-12)

YYYYstring required
Example:2024

Year (4 digits)

Response

Successful response

successboolean

Indicates if the request was successful