Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface FulfillmentInboundApiGetLabelsRequest

    Request parameters for getLabels operation in FulfillmentInboundApi.

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

    Properties

    labelType numberOfPackages? numberOfPallets? packageLabelsToPrint? pageSize? pageStartIndex? pageType shipmentId

    Properties

    labelType: GetLabelsLabelTypeEnum

    The type of labels requested.

    numberOfPackages?: number

    The number of packages in the shipment.

    numberOfPallets?: number

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

    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.

    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.

    pageStartIndex?: number

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

    pageType: GetLabelsPageTypeEnum

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

    shipmentId: string

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

    Settings

    Member Visibility

    On This Page

    Properties