Interface VendorShippingApiGetShippingLabelsRequest

Request parameters for getShippingLabels operation in VendorShippingApi.

Export

VendorShippingApiGetShippingLabelsRequest

interface VendorShippingApiGetShippingLabelsRequest {
    createdAfter: string;
    createdBefore: string;
    limit?: number;
    nextToken?: string;
    shipFromPartyId?: string;
    sortOrder?: GetShippingLabelsSortOrderEnum;
}

Index

Properties

createdAfter createdBefore limit? nextToken? shipFromPartyId? sortOrder?

Properties

`Readonly`createdAfter

createdAfter: string

Shipping labels that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

Memberof

VendorShippingApiGetShippingLabels

`Readonly`createdBefore

createdBefore: string

Shipping labels that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

Memberof

VendorShippingApiGetShippingLabels

`Optional` `Readonly`limit

limit?: number

The limit to the number of records returned.

Memberof

VendorShippingApiGetShippingLabels

`Optional` `Readonly`nextToken

nextToken?: string

Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.

Memberof

VendorShippingApiGetShippingLabels

`Optional` `Readonly`shipFromPartyId

shipFromPartyId?: string

The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses.

Memberof

VendorShippingApiGetShippingLabels

`Optional` `Readonly`sortOrder

sortOrder?: GetShippingLabelsSortOrderEnum

The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order.

Memberof

VendorShippingApiGetShippingLabels