> ## Documentation Index
> Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Amazon FBA inbound plans not yet shipped

> List active Amazon FBA inbound plans (Fulfillment Inbound API 2024-03-20) for one Amazon FBA
integration account that have no confirmed shipment yet, so they do not appear in
`GET /inbound-shipments`. A plan is included when it has
no shipments, or every shipment is still `UNCONFIRMED`. Each item carries its per-SKU quantity.

Plans are read live from Amazon through the account's Trackstar connection and cached for 15 minutes per
account; `fetched_at` tells you when the data was read. Amazon throttles these calls, so the endpoint is
rate limited to 20 requests per minute. When the complete list cannot be read, the API returns `503` with a
`Retry-After` header — it never returns a partial list.

Each item's Amazon MSKU is mapped to the Luminous SKU it is linked to on the account (`sku_id` / `sku`);
both are `null` when the MSKU is not linked.




## OpenAPI

````yaml /api-reference/build.yaml get /inbound-plans
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Freight
    description: >-
      Freightview LTL freight — quotes, booking and documents for fulfillment
      orders
  - name: Fulfillment Priority Lists
    description: Configure fulfillment routing priority lists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Supplier Portal
    description: >-
      Read a supplier's response to a purchase order and control the one-click
      portal link
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Warehouse
    description: >-
      Warehouse-floor lookups for PickFlow — barcode resolution, bin and product
      stock, bin search, and receivables
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Drive
    description: >
      Browse, upload, tag and manage files in your Luminous Drive. An API token
      sees the shared

      drive only, never My Files or restricted folders and files. Every write
      and download made

      through the API is recorded in the file's activity log (`GET
      /file-cabinet/files/{id}/activity`)

      with `actor_kind: api_token`.
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
  - name: Automations
    description: Create, test, and inspect automation rules and their runs
paths:
  /inbound-plans:
    get:
      tags:
        - Inbound Shipments
      summary: Amazon FBA inbound plans not yet shipped
      description: >
        List active Amazon FBA inbound plans (Fulfillment Inbound API
        2024-03-20) for one Amazon FBA

        integration account that have no confirmed shipment yet, so they do not
        appear in

        `GET /inbound-shipments`. A plan is included when it has

        no shipments, or every shipment is still `UNCONFIRMED`. Each item
        carries its per-SKU quantity.


        Plans are read live from Amazon through the account's Trackstar
        connection and cached for 15 minutes per

        account; `fetched_at` tells you when the data was read. Amazon throttles
        these calls, so the endpoint is

        rate limited to 20 requests per minute. When the complete list cannot be
        read, the API returns `503` with a

        `Retry-After` header — it never returns a partial list.


        Each item's Amazon MSKU is mapped to the Luminous SKU it is linked to on
        the account (`sku_id` / `sku`);

        both are `null` when the MSKU is not linked.
      operationId: getInboundPlans
      parameters:
        - in: query
          name: app_integration_account_id
          required: true
          schema:
            type: integer
          description: >-
            Amazon FBA integration account ID (same value as
            `app_integration_account_id` on inbound shipments).
      responses:
        '200':
          description: Inbound plans for the account
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      app_integration_account_id:
                        type: integer
                      fetched_at:
                        type: string
                        format: date-time
                        description: >-
                          When the plans were read from Amazon (earlier than now
                          when served from cache).
                      plans:
                        type: array
                        items:
                          type: object
                          properties:
                            inbound_plan_id:
                              type: string
                            name:
                              type: string
                              nullable: true
                            status:
                              type: string
                              nullable: true
                            created_at:
                              type: string
                              nullable: true
                            last_updated_at:
                              type: string
                              nullable: true
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  msku:
                                    type: string
                                    nullable: true
                                    description: Amazon merchant SKU.
                                  fnsku:
                                    type: string
                                    nullable: true
                                  asin:
                                    type: string
                                    nullable: true
                                  quantity:
                                    type: integer
                                  sku_id:
                                    type: integer
                                    nullable: true
                                    description: >-
                                      Luminous product ID the MSKU is linked to
                                      on this account; `null` when not linked.
                                  sku:
                                    type: string
                                    nullable: true
                                    description: >-
                                      Luminous internal SKU the MSKU is linked
                                      to; `null` when not linked.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: >-
            `app_integration_account_id` is missing, or the account is not an
            Amazon FBA integration account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '429':
          description: Rate limit exceeded (20 requests per minute).
        '503':
          description: >-
            Amazon throttled or failed a call, so the list could not be read
            completely. Retry after the number of seconds in the `Retry-After`
            header.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.