Create a new shipment record for a specific sales order. Once the shipment is added,
the sales order status will automatically be updated to either shipped or partially_shipped.
Also, any shipment costs will be added to the sales order total.
Pass an optional fulfillment_order_id to link the shipment to a specific fulfillment order belonging to this
sales order. To create a shipment scoped directly to a fulfillment order without referencing the sales order,
use POST /fulfillment-orders/{id}/shipments instead.
NOTE: At this time, inventory adjustments will not be made automatically.
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.
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
ID of the sales order
Date when the shipment will be sent (YYYY-MM-DD)
Tracking number for the shipment
Code identifying the carrier
"fedex"
ID of the warehouse shipping from
Items to be included in this shipment
1Bill of Lading Number for logistics tracking
"BOL-123456789"
Progressive Rotating Order Number (common in LTL shipping)
"PRO-987654321"
General reference number from/for the shipping partner
"PARTNER-REF-001"
Whether this is a return shipment
Code identifying the shipping service
"ups_ground"
Cost of shipping
Cost of insurance
Code identifying the package type
"flat_rate_envelope"
Optional ID of a fulfillment order belonging to this sales order. When provided, the shipment is linked to the
fulfillment order (populating the fulfillment-order/shipment pivot and the legacy sales_order_shipment_id FK).
The fulfillment order must belong to the sales order in the path.
Shipment created successfully
Unique identifier for the shipment
ID of the associated sales order
Date when the shipment was or will be sent
Tracking number for the shipment
Bill of Lading Number for logistics tracking
"BOL-123456789"
Progressive Rotating Order Number (common in LTL shipping)
"PRO-987654321"
General reference number from/for the shipping partner
"PARTNER-REF-001"
Whether this is a return shipment
Code identifying the carrier (e.g., ups, fedex)
Code identifying the shipping service
Code identifying the package type
Cost of shipping
Cost of insurance
ID of the warehouse group associated with this shipment (from the linked fulfillment order)
Status of the shipment
Items included in this shipment
Timestamp when the shipment was created
Timestamp when the shipment was last updated