Interface FulfillmentInboundApiListTransportationOptionsRequest

Request parameters for listTransportationOptions operation in FulfillmentInboundApi.

Export

FulfillmentInboundApiListTransportationOptionsRequest

interface FulfillmentInboundApiListTransportationOptionsRequest {
    inboundPlanId: string;
    pageSize?: number;
    paginationToken?: string;
    placementOptionId?: string;
    shipmentId?: string;
}

Index

Properties

inboundPlanId pageSize? paginationToken? placementOptionId? shipmentId?

Properties

`Readonly`inboundPlanId

inboundPlanId: string

Identifier of an inbound plan.

Memberof

FulfillmentInboundApiListTransportationOptions

`Optional` `Readonly`pageSize

pageSize?: number

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

Memberof

FulfillmentInboundApiListTransportationOptions

`Optional` `Readonly`paginationToken

paginationToken?: string

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.

Memberof

FulfillmentInboundApiListTransportationOptions

`Optional` `Readonly`placementOptionId

placementOptionId?: string

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

Memberof

FulfillmentInboundApiListTransportationOptions

`Optional` `Readonly`shipmentId

shipmentId?: string

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

Memberof

FulfillmentInboundApiListTransportationOptions