Skip to main content
GET
Waybill Extract

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required
Carrier
string
header
required

The railroad whose reports to return, by mark (for example WTNN or TKEN).

Query Parameters

startDate
string

Required. First reporting day, YYYY-MM-DD, railroad-local, inclusive.

endDate
string

Required. Last reporting day, YYYY-MM-DD, railroad-local, inclusive. Any range is allowed: each page covers at most 31 reporting days, so follow nextPageToken until it is absent. A page can hold fewer than pageSize rows, even none, and still have a nextPageToken.

equipmentInitial
string

Only rows for this car. Set both or neither. Leading zeros and letter case are ignored.

equipmentNumber
string
waybillNumber
string

Only rows for this waybill number. Leading zeros are ignored.

waybillDate
string

Only rows for a waybill dated this day, YYYY-MM-DD.

pageSize
integer<int64>

Rows per page. Defaults to 500; values above 1000 are treated as 1000.

pageToken
string

nextPageToken from the previous response, sent with the same dates and filters.

Response

A successful response.

nextPageToken
string

Present when more rows remain; pass it back as pageToken.

rows
object[]

In the file's order: by transaction (or delete/undelete) time, then transaction id.