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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Month (01-12)

string
required

Year (4 digits)

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json