Retrieves a list of transportation options for a placement option.

{
  "transportationOptions": [
    {
      "carrier": {
        "name": "string",
        "alphaCode": "string"
      },
      "preconditions": [
        "string"
      ],
      "shipmentId": "string",
      "shippingMode": "string",
      "shippingSolution": "string",
      "transportationOptionId": "string",
      "carrierAppointment": {
        "endTime": "2024-01-15T09:30:00Z",
        "startTime": "2024-01-15T09:30:00Z"
      },
      "quote": {
        "cost": {
          "amount": 1.1,
          "code": "string"
        },
        "expiration": "2024-01-15T09:30:00Z",
        "voidableUntil": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

Path parameters

inboundPlanIdstringRequired

Identifier of an inbound plan.

Query parameters

pageSizeintegerOptional1-30

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

paginationTokenstringOptional

A token to fetch a certain page when there are multiple pages worth of results.

placementOptionIdstringOptional

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

shipmentIdstringOptional

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

Response

Success

transportationOptionslist of objects

Transportation options generated for the placement option.

paginationobjectOptional

Contains tokens to fetch from a certain page.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error