Request parameters for getLabels operation in FbaInboundApi.

FbaInboundApiGetLabelsRequest

interface FbaInboundApiGetLabelsRequest {
    labelType: GetLabelsLabelTypeEnum;
    numberOfPackages?: number;
    numberOfPallets?: number;
    packageLabelsToPrint?: string[];
    pageSize?: number;
    pageStartIndex?: number;
    pageType: GetLabelsPageTypeEnum;
    shipmentId: string;
}

Properties

The type of labels requested.

FbaInboundApiGetLabels

numberOfPackages?: number

The number of packages in the shipment.

FbaInboundApiGetLabels

numberOfPallets?: number

The number of pallets in the shipment. This returns four identical labels for each pallet.

FbaInboundApiGetLabels

packageLabelsToPrint?: string[]

A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the FBA Inbound Shipment Carton Information Feed, then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the `listShipmentBoxes` response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code.

FbaInboundApiGetLabels

pageSize?: number

The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

FbaInboundApiGetLabels

pageStartIndex?: number

The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.

FbaInboundApiGetLabels

The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

FbaInboundApiGetLabels

shipmentId: string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

FbaInboundApiGetLabels