> ## 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.

# Mark fulfillment order as shipped

> Mark a fulfillment order as shipped, optionally recording carrier details. This mints
the shipment through the same path the web app uses, so it carries the existing
transition checks — if the order cannot be shipped from its current state the request
is rejected with `422`.

Returns the updated fulfillment order.




## OpenAPI

````yaml /api-reference/build.yaml post /fulfillment-orders/{fulfillmentOrderId}/mark-shipped
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: 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 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: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /fulfillment-orders/{fulfillmentOrderId}/mark-shipped:
    post:
      tags:
        - Fulfillment Orders
      summary: Mark fulfillment order as shipped
      description: >
        Mark a fulfillment order as shipped, optionally recording carrier
        details. This mints

        the shipment through the same path the web app uses, so it carries the
        existing

        transition checks — if the order cannot be shipped from its current
        state the request

        is rejected with `422`.


        Returns the updated fulfillment order.
      operationId: markFulfillmentOrderShipped
      parameters:
        - in: path
          name: fulfillmentOrderId
          required: true
          schema:
            type: integer
          description: ID of the fulfillment order
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_number:
                  type: string
                  nullable: true
                  maxLength: 255
                  description: Carrier tracking number to record on the shipment.
                carrier_code:
                  type: string
                  nullable: true
                  maxLength: 255
                  description: Carrier code to record on the shipment.
      responses:
        '200':
          description: Fulfillment order marked as shipped
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Fulfillment order ID
                      order_number:
                        type: string
                        description: Fulfillment order number
                      order_key:
                        type: string
                        nullable: true
                        description: Fulfillment order key
                      order_status:
                        type: string
                        description: Fulfillment order status
                      sales_order_id:
                        type: integer
                        description: Associated sales order ID
                      warehouse_group_id:
                        type: integer
                        nullable: true
                        description: Warehouse group ID
                      destination_oms_id:
                        type: integer
                        nullable: true
                        description: Destination app integration account ID
                      destination_oms_store_id:
                        type: integer
                        nullable: true
                      fulfillment_channel_id:
                        type: integer
                        nullable: true
                      pushed_at:
                        type: string
                        format: date-time
                        nullable: true
                      error_message:
                        type: string
                        nullable: true
                        description: >-
                          Last push error from the destination OMS, when the
                          fulfillment order is in Error status
                      ship_by_date:
                        type: string
                        format: date
                        nullable: true
                        description: Ship by date
                      total:
                        type: number
                        format: float
                        nullable: true
                        description: Order total
                      bill_to:
                        type: object
                        nullable: true
                        description: Billing address
                        properties:
                          name:
                            type: string
                          company:
                            type: string
                          street1:
                            type: string
                          street2:
                            type: string
                          street3:
                            type: string
                          city:
                            type: string
                          state:
                            type: string
                          postal_code:
                            type: string
                          country:
                            type: string
                          phone:
                            type: string
                      ship_to:
                        type: object
                        nullable: true
                        description: Shipping address
                        properties:
                          name:
                            type: string
                          company:
                            type: string
                          street1:
                            type: string
                          street2:
                            type: string
                          street3:
                            type: string
                          city:
                            type: string
                          state:
                            type: string
                          postal_code:
                            type: string
                          country:
                            type: string
                          phone:
                            type: string
                      invoice_to:
                        type: object
                        nullable: true
                        description: Invoice address
                        properties:
                          name:
                            type: string
                          company:
                            type: string
                          street1:
                            type: string
                          street2:
                            type: string
                          street3:
                            type: string
                          city:
                            type: string
                          state:
                            type: string
                          postal_code:
                            type: string
                          country:
                            type: string
                          phone:
                            type: string
                      sales_order:
                        type: object
                        nullable: true
                        description: Nested sales order data
                      picklists:
                        type: array
                        description: Associated picklists
                        items:
                          type: object
                      fulfillment_order_items:
                        type: array
                        description: Fulfillment order line items
                        items:
                          type: object
                      total_weight:
                        type: object
                        nullable: true
                        description: >-
                          Total product weight of this fulfillment order's own
                          lines, at the fulfillment quantity. Present only when
                          the line items are loaded. A product with no recorded
                          weight contributes nothing, so a total of `0` usually
                          means "weight unknown" rather than "weightless" —
                          check `is_complete` before treating the total as
                          authoritative.
                        properties:
                          total_oz:
                            type: number
                            format: float
                            description: Total weight in ounces
                          total_lb:
                            type: number
                            format: float
                            description: Total weight in pounds
                          line_count:
                            type: integer
                            description: Number of fulfillment order lines
                          weighed_line_count:
                            type: integer
                            description: >-
                              Number of lines that had a usable weight and
                              contributed to the total
                          is_complete:
                            type: boolean
                            description: >-
                              True only when there is at least one line and
                              every line contributed a weight. When false, the
                              total omits one or more lines whose product has no
                              recorded weight.
                      tags:
                        type: array
                        description: >-
                          Tags attached directly to this fulfillment order.
                          Present when the relation is loaded. Tags inherited
                          from the parent sales order are not included.
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Unique identifier for the tag
                            name:
                              type: string
                              description: Name of the tag
                            description:
                              type: string
                              nullable: true
                              description: Description of the tag
                            icon:
                              type: string
                              nullable: true
                              description: Icon identifier or URL for the tag
                            color:
                              type: string
                              nullable: true
                              description: Color code for the tag
                          required:
                            - id
                            - name
                      purchase_orders:
                        type: array
                        description: >-
                          Linked purchase orders. Present when the relation is
                          loaded; deduplicated by ID.
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            order_status:
                              type: string
                              nullable: true
                              enum:
                                - active
                                - deleted
                                - completed
                      source_reference_identifier:
                        type: string
                        nullable: true
                        description: >-
                          The source system's reference identifier for this
                          fulfillment order (e.g. the originating OMS order ID)
                      created_at:
                        type: string
                        format: date-time
                        description: When the fulfillment order was created
                      updated_at:
                        type: string
                        format: date-time
                        description: When the fulfillment order was last updated
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Fulfillment order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: The order cannot be marked shipped from its current state
          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.

````