listTransportationOptions

Retrieves all transportation options for a shipment. Transportation options must first be generated by the generateTransportationOptions operation before becoming available.

Path Params
string
required
length between 38 and 38

Identifier of an inbound plan.

Query Params
integer
1 to 20
Defaults to 10

The number of transportation options to return in the response matching the given query.

string
length between 0 and 1024

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

string
length between 38 and 38

The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.

string
length between 38 and 38

The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.

Responses

Language
Response
Choose an example:
application/json