Skip to main content
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": []
    }
  ]
}

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.

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

Response

Packages created successfully

​
data
object[]