Interface FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlansRequest

Request parameters for listInboundPlans operation in FulfillmentInboundApi.

Export

FulfillmentInboundApiListInboundPlansRequest

interface FulfillmentInboundApiModelV20240320FulfillmentInboundApiListInboundPlansRequest {
    pageSize?: number;
    paginationToken?: string;
    sortBy?: "LAST_UPDATED_TIME" | "CREATION_TIME";
    sortOrder?: "ASC" | "DESC";
    status?: "SHIPPED" | "VOIDED" | "ACTIVE";
}

Index

Properties

pageSize? paginationToken? sortBy? sortOrder? status?

Properties

`Optional` `Readonly`pageSize

pageSize?: number

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

Memberof

FulfillmentInboundApiListInboundPlans

`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

FulfillmentInboundApiListInboundPlans

`Optional` `Readonly`sortBy

sortBy?: "LAST_UPDATED_TIME" | "CREATION_TIME"

Sort by field.

Memberof

FulfillmentInboundApiListInboundPlans

`Optional` `Readonly`sortOrder

sortOrder?: "ASC" | "DESC"

The sort order.

Memberof

FulfillmentInboundApiListInboundPlans

`Optional` `Readonly`status

status?: "SHIPPED" | "VOIDED" | "ACTIVE"

The status of an inbound plan.

Memberof

FulfillmentInboundApiListInboundPlans