Interface FulfillmentInboundApiListShipmentBoxesRequest

Request parameters for listShipmentBoxes operation in FulfillmentInboundApi.

Export

FulfillmentInboundApiListShipmentBoxesRequest

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

Properties

inboundPlanId pageSize? paginationToken? shipmentId

Properties

ReadonlyinboundPlanId

inboundPlanId: string

Identifier of an inbound plan.

Memberof

FulfillmentInboundApiListShipmentBoxes

Optional ReadonlypageSize

pageSize?: number

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

Memberof

FulfillmentInboundApiListShipmentBoxes

Optional ReadonlypaginationToken

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

FulfillmentInboundApiListShipmentBoxes

ReadonlyshipmentId

shipmentId: string

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

Memberof

FulfillmentInboundApiListShipmentBoxes

Settings

Member Visibility

On This Page

Properties