curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/shipments/{shipmentId}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "packages": [
    {
      "sscc": 123456789012345680,
      "tracking": "PKG-001",
      "package_quantity": 1,
      "package_type": "box",
      "packing_type": "standard",
      "length_in": 12,
      "width_in": 8,
      "height_in": 6,
      "weight_lb": 5,
      "contained_items": [
        {
          "order_item_id": 1001,
          "line_item_key": "line-1",
          "sku": "WIDGET-001",
          "internal_sku": "WIDGET-001",
          "upc": "123456789012",
          "quantity": 5,
          "description": "Premium Widget",
          "lot_number": "LOT-2024-001",
          "serial_number": "SN-001",
          "expiration_date": "2024-12-31",
          "weight_lb": 1
        },
        {
          "order_item_id": 1002,
          "line_item_key": "line-2",
          "sku": "GADGET-002",
          "internal_sku": "GADGET-002",
          "quantity": 3,
          "description": "Electronic Gadget",
          "weight_lb": 0.5
        }
      ]
    }
  ]
}
'

{
  "data": [
    {
      "id": 1,
      "sscc": 123456789012345680,
      "tracking": "PKG-001",
      "package_quantity": 1,
      "package_type": "box",
      "packing_type": "standard",
      "length_in": 12,
      "width_in": 8,
      "height_in": 6,
      "weight_lb": 5,
      "parent_package_id": null,
      "shipment_id": 123,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "items": [
        {
          "id": 1,
          "order_item_id": 1001,
          "line_item_key": "line-1",
          "sku": "WIDGET-001",
          "internal_sku": "WIDGET-001",
          "upc": "123456789012",
          "quantity": 5,
          "description": "Premium Widget",
          "lot_number": "LOT-2024-001",
          "serial_number": "SN-001",
          "expiration_date": "2024-12-31",
          "weight_lb": 1,
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "child_packages": []
    }
  ]
}

Sales Orders

Create shipment packages

Create detailed package and item tracking for a sales order shipment.

This endpoint allows you to create hierarchical package structures with:

Multiple packages per shipment
Child packages (packages within packages)
Detailed item tracking within each package
Package dimensions, weights, and tracking information
Item-level details including lot numbers, serial numbers, and expiration dates

Use Cases

Track individual packages within a shipment
Manage nested packaging (e.g., items in boxes, boxes in pallets)
Record detailed inventory information for compliance
Provide granular tracking for complex shipments

Package Hierarchy

Packages can contain:

Items: Individual products with quantities and details
Child Packages: Nested packages that can themselves contain items or more child packages

This allows for complex packaging scenarios like:

Individual items packed in small boxes, then grouped in larger shipping boxes
Palletized shipments with multiple layers of packaging
Mixed shipments with different packaging types

POST

sales-orders

{salesOrderId}

shipments

{shipmentId}

packages

curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/shipments/{shipmentId}/packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "packages": [
    {
      "sscc": 123456789012345680,
      "tracking": "PKG-001",
      "package_quantity": 1,
      "package_type": "box",
      "packing_type": "standard",
      "length_in": 12,
      "width_in": 8,
      "height_in": 6,
      "weight_lb": 5,
      "contained_items": [
        {
          "order_item_id": 1001,
          "line_item_key": "line-1",
          "sku": "WIDGET-001",
          "internal_sku": "WIDGET-001",
          "upc": "123456789012",
          "quantity": 5,
          "description": "Premium Widget",
          "lot_number": "LOT-2024-001",
          "serial_number": "SN-001",
          "expiration_date": "2024-12-31",
          "weight_lb": 1
        },
        {
          "order_item_id": 1002,
          "line_item_key": "line-2",
          "sku": "GADGET-002",
          "internal_sku": "GADGET-002",
          "quantity": 3,
          "description": "Electronic Gadget",
          "weight_lb": 0.5
        }
      ]
    }
  ]
}
'

{
  "data": [
    {
      "id": 1,
      "sscc": 123456789012345680,
      "tracking": "PKG-001",
      "package_quantity": 1,
      "package_type": "box",
      "packing_type": "standard",
      "length_in": 12,
      "width_in": 8,
      "height_in": 6,
      "weight_lb": 5,
      "parent_package_id": null,
      "shipment_id": 123,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "items": [
        {
          "id": 1,
          "order_item_id": 1001,
          "line_item_key": "line-1",
          "sku": "WIDGET-001",
          "internal_sku": "WIDGET-001",
          "upc": "123456789012",
          "quantity": 5,
          "description": "Premium Widget",
          "lot_number": "LOT-2024-001",
          "serial_number": "SN-001",
          "expiration_date": "2024-12-31",
          "weight_lb": 1,
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "child_packages": []
    }
  ]
}

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

salesOrderId

integer

required

ID of the sales order

shipmentId

integer

required

ID of the shipment to add packages to

Body

application/json

packages

object[]

required

Array of packages to create for the shipment

Minimum array length: 1

Show child attributes

bol_number

string | null

Bill of Lading Number for logistics tracking; saved on the shipment

Example:

"BOL-123456789"

pro_number

string | null

Progressive Rotating Order Number (common in LTL shipping); saved on the shipment

Example:

"PRO-987654321"

partner_reference_number

string | null

General reference number from/for the shipping partner; saved on the shipment

Example:

"PARTNER-REF-001"

trailer_number

string | null

Trailer number for the shipment (common in LTL/FTL freight); saved on the shipment

Example:

"TRL-456789"

scac

string | null

Standard Carrier Alpha Code (SCAC) for the shipment's carrier; saved on the shipment and included on outbound EDI 856/810 documents

Maximum string length: 10

Response

Packages created successfully

data

object[]

Show child attributes

Force-push shipment fulfillment to order source Fulfillment orders

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Create shipment packages

Use Cases

Package Hierarchy

Authorizations

Path Parameters

Body

Response