curl --request PUT \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_status": "awaiting_shipment"
}
'

{
  "data": {
    "id": 123,
    "order_number": "<string>",
    "order_key": "<string>",
    "order_status": "<string>",
    "sales_order_id": 123,
    "warehouse_group_id": 123,
    "destination_oms_id": 123,
    "destination_oms_store_id": 123,
    "fulfillment_channel_id": 123,
    "pushed_at": "2023-11-07T05:31:56Z",
    "packing_slip_printed_at": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "ship_by_date": "2023-12-25",
    "total": 123,
    "bill_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "ship_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "invoice_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "sales_order": {},
    "picklists": [
      {}
    ],
    "fulfillment_order_items": [
      {
        "id": 123,
        "shipment_id": 123,
        "status": "<unknown>",
        "sales_order_item_id": 123,
        "product_id": 123,
        "sku": "<string>",
        "name": "<string>",
        "weight": "<unknown>",
        "dimensions": "<unknown>",
        "quantity": 123,
        "unit_price": 123,
        "lot_id": 123,
        "lot_number": "<string>",
        "expiry_date": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_kit_component": true,
        "parent_fulfillment_order_item_id": 123,
        "kit_sales_order_item_id": 123,
        "is_synthetic": true
      }
    ],
    "total_weight": {
      "total_oz": 123,
      "total_lb": 123,
      "line_count": 123,
      "weighed_line_count": 123,
      "is_complete": true
    },
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ],
    "purchase_orders": [
      {
        "id": 123,
        "order_status": "active"
      }
    ],
    "source_reference_identifier": "<string>",
    "held_for_item_change": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Fulfillment Orders

Set fulfillment order status

Set a fulfillment order’s status. Intended for external systems (for example a 3PL or file-based fulfillment partner) that report back what happened to an order. Three statuses are accepted:

awaiting_shipment — records that the order was sent to the fulfillment partner. No shipment is created, and the order leaves the pending queue.
shipped — records a shipment with the given tracking number, carrier and ship date. The shipment is created first; if it cannot be created the request fails with 400 (Failed to create shipment: ...) and the order’s status is left unchanged. When some shippable lines end up without a shipment, the order is set to partially_shipped instead of shipped.
cancelled — cancels the order through the same path as other cancellations.

The status is written as given; unlike POST /fulfillment-orders/{fulfillmentOrderId}/mark-shipped, this endpoint does not check the order’s current status first.

Returns the updated fulfillment order.

PUT

fulfillment-orders

{fulfillmentOrderId}

status

curl --request PUT \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{fulfillmentOrderId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_status": "awaiting_shipment"
}
'

{
  "data": {
    "id": 123,
    "order_number": "<string>",
    "order_key": "<string>",
    "order_status": "<string>",
    "sales_order_id": 123,
    "warehouse_group_id": 123,
    "destination_oms_id": 123,
    "destination_oms_store_id": 123,
    "fulfillment_channel_id": 123,
    "pushed_at": "2023-11-07T05:31:56Z",
    "packing_slip_printed_at": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "ship_by_date": "2023-12-25",
    "total": 123,
    "bill_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "ship_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "invoice_to": {
      "name": "<string>",
      "company": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "street3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "sales_order": {},
    "picklists": [
      {}
    ],
    "fulfillment_order_items": [
      {
        "id": 123,
        "shipment_id": 123,
        "status": "<unknown>",
        "sales_order_item_id": 123,
        "product_id": 123,
        "sku": "<string>",
        "name": "<string>",
        "weight": "<unknown>",
        "dimensions": "<unknown>",
        "quantity": 123,
        "unit_price": 123,
        "lot_id": 123,
        "lot_number": "<string>",
        "expiry_date": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_kit_component": true,
        "parent_fulfillment_order_item_id": 123,
        "kit_sales_order_item_id": 123,
        "is_synthetic": true
      }
    ],
    "total_weight": {
      "total_oz": 123,
      "total_lb": 123,
      "line_count": 123,
      "weighed_line_count": 123,
      "is_complete": true
    },
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ],
    "purchase_orders": [
      {
        "id": 123,
        "order_status": "active"
      }
    ],
    "source_reference_identifier": "<string>",
    "held_for_item_change": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

fulfillmentOrderId

integer

required

ID of the fulfillment order

Body

application/json

order_status

enum<string>

required

Status to set.

Available options:

awaiting_shipment,

shipped,

cancelled

tracking_number

string | null

Carrier tracking number. Required when order_status is shipped.

Maximum string length: 255

carrier_code

string | null

Carrier code. Required when order_status is shipped.

Maximum string length: 255

ship_date

string<date> | null

Date the shipment left, Y-m-d. Required when order_status is shipped.

Example:

"2026-11-05"

Response

Fulfillment order status updated

data

object

Show child attributes

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Drive

Configuration

Integrations

Set fulfillment order status

Authorizations

Path Parameters

Body

Response