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

    Interface InboundPlan

    Inbound plan containing details of the inbound workflow.

    interface InboundPlan {
        createdAt: string;
        inboundPlanId: string;
        lastUpdatedAt: string;
        marketplaceIds: string[];
        name: string;
        packingOptions?: PackingOptionSummary[];
        placementOptions?: PlacementOptionSummary[];
        shipments?: ShipmentSummary[];
        sourceAddress: Address;
        status: string;
    }
    Index

    Properties

    createdAt inboundPlanId lastUpdatedAt marketplaceIds name packingOptions? placementOptions? shipments? sourceAddress status

    Properties

    createdAt: string

    The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ.

    inboundPlanId: string

    Identifier of an inbound plan.

    lastUpdatedAt: string

    The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

    marketplaceIds: string[]

    A list of marketplace IDs.

    name: string

    Human-readable name of the inbound plan.

    packingOptions?: PackingOptionSummary[]

    Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details.

    placementOptions?: PlacementOptionSummary[]

    Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details.

    shipments?: ShipmentSummary[]

    A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the confirmPlacementOptions operation. Only shipments from the chosen placement option are returned. Query the shipment for more details.

    sourceAddress: Address
    status: string

    Current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

    Settings

    Member Visibility

    On This Page

    Properties