Skip to main content
GET
/
sales-orders
/
{salesOrderId}
/
shipments
Get shipments for a sales order
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/{salesOrderId}/shipments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

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

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100

Response

Successful response

data
object[]
meta
object