TRtrackstarhq
carrier
Files

List Carrier Files

Changed on

Returns raw invoice files (CSV, PDF, etc.) from the carrier connection, each with a presigned download URL. Filter with created_date to select a time range. Subscribe to the carrier-file.created webhook to be notified when a new file is available, then fetch that file from /carrier/files/{id} for a fresh URL instead of polling.

get/carrier/files

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/carrier/files
  • Auth
    none required

Query parameters

page_tokenstring nullable
Example:page_token

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

limitinteger
Example:1000

The maximum number of items to return. The default is 1000.

instring[] required

A comma-separated list of resource IDs. If provided, all other query params are ignored.

{
  "in": [
    "_in"
  ]
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z",
  "neq": "2023-03-15T13:45:30Z",
  "in": [
    "2023-03-15T13:45:30Z"
  ],
  "nin": [
    "2023-03-15T13:45:30Z"
  ],
  "gt": "2023-03-15T13:45:30Z",
  "gte": "2023-03-15T13:45:30Z",
  "lt": "2023-03-15T13:45:30Z",
  "lte": "2023-03-15T13:45:30Z"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

Filter by file name (matches names containing the value). This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "invoice.csv",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

Filter by the file extension. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "csv",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
start_timestring date-time
Example:2023-03-15T13:45:30Z

Deprecated: use created_date[gte] instead.

end_timestring date-time
Example:2023-03-15T13:45:30Z

Deprecated: use created_date[lte] instead.

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

Example response

{
  "data": [
    {
      "id": "2025-11-15T00:00:00/crawl_id/invoice.csv",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "file_name": "invoice.csv",
      "file_type": "csv",
      "trackstar_created_date": "2023-03-15T13:45:30Z",
      "trackstar_updated_date": "2023-03-15T13:45:30Z",
      "download_url": "https://s3.amazonaws.com/...",
      "download_url_expires_at": "2025-01-15T10:50:00Z"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Changes

  • f9f948f2a7b3Revision changes
    • breaking

      for the query request parameter limit, default value 100 was removed

    • breaking

      for the query request parameter file_name, the type changed from string to object

    • breaking

      for the query request parameter file_type, the type changed from string to object

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the new optional query request parameter created_date

    • info

      added the new optional query request parameter ids

    • info

      added the new optional query request parameter trackstar_created_date

    • info

      added the new optional query request parameter trackstar_updated_date

    • info

      added the new optional query request parameter updated_date

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status