Skip to main content
POST
/
sales-orders
/
{salesOrderId}
/
shipments
Create a new shipment for a sales order
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "carrier_code": "fedex",
  "warehouse_id": 123,
  "ship_to": {
    "name": "<string>",
    "street1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "residential": true,
    "company": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "phone": "<string>"
  },
  "items": [
    {
      "product_id": 123,
      "order_item_id": 123,
      "quantity": 2,
      "unit_price": 1,
      "weight": {
        "value": 123,
        "units": "ounces"
      }
    }
  ],
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "service_code": "ups_ground",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "package_code": "flat_rate_envelope",
  "weight": {
    "value": 123,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 123,
    "width": 123,
    "height": 123
  }
}
'
{
  "id": 123,
  "sales_order_id": 123,
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "carrier_code": "<string>",
  "service_code": "<string>",
  "package_code": "<string>",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "warehouse_id": 123,
  "status": 123,
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "residential": true
  },
  "weight": {
    "value": 123,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 123,
    "width": 123,
    "height": 123
  },
  "items": [
    {
      "id": 123,
      "shipment_id": 123,
      "product_id": 123,
      "order_item_id": 123,
      "quantity": 123,
      "weight": {
        "value": 123,
        "units": "ounces"
      },
      "unit_price": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact [email protected]

Path Parameters

salesOrderId
integer
required

ID of the sales order

Body

application/json
ship_date
string<date>
required

Date when the shipment will be sent (YYYY-MM-DD)

tracking_number
string
required

Tracking number for the shipment

carrier_code
string
required

Code identifying the carrier

Example:

"fedex"

warehouse_id
integer
required

ID of the warehouse shipping from

ship_to
object
required
items
object[]
required

Items to be included in this shipment

Minimum array length: 1
bol_number
string

Bill of Lading Number for logistics tracking

Example:

"BOL-123456789"

pro_number
string

Progressive Rotating Order Number (common in LTL shipping)

Example:

"PRO-987654321"

partner_reference_number
string

General reference number from/for the shipping partner

Example:

"PARTNER-REF-001"

is_return
boolean

Whether this is a return shipment

service_code
string

Code identifying the shipping service

Example:

"ups_ground"

shipment_cost
number<float>

Cost of shipping

insurance_cost
number<float>

Cost of insurance

package_code
string

Code identifying the package type

Example:

"flat_rate_envelope"

weight
object
dimensions
object

Response

Shipment created successfully

id
integer

Unique identifier for the shipment

sales_order_id
integer

ID of the associated sales order

ship_date
string<date>

Date when the shipment was or will be sent

tracking_number
string

Tracking number for the shipment

bol_number
string

Bill of Lading Number for logistics tracking

Example:

"BOL-123456789"

pro_number
string

Progressive Rotating Order Number (common in LTL shipping)

Example:

"PRO-987654321"

partner_reference_number
string

General reference number from/for the shipping partner

Example:

"PARTNER-REF-001"

is_return
boolean

Whether this is a return shipment

carrier_code
string

Code identifying the carrier (e.g., ups, fedex)

service_code
string

Code identifying the shipping service

package_code
string

Code identifying the package type

shipment_cost
number<float>

Cost of shipping

insurance_cost
number<float>

Cost of insurance

warehouse_id
integer

ID of the warehouse shipping from

status
integer

Status of the shipment

ship_to
object
weight
object
dimensions
object
items
object[]

Items included in this shipment

created_at
string<date-time>

Timestamp when the shipment was created

updated_at
string<date-time>

Timestamp when the shipment was last updated