Skip to main content
GET
/
purchase-orders
/
{purchaseOrderId}
/
shipments
List shipments for a purchase order
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/shipments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "reference_number": "<string>",
      "total_shipping_cost": 123,
      "shipping_date": "2023-11-07T05:31:56Z",
      "warehouse_id": 123,
      "shipment_status_id": 123,
      "sync_status": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "last_synced_status": "<unknown>",
      "shipment_status": {
        "id": 123,
        "name": "<string>"
      },
      "warehouse": {
        "id": 123,
        "status": "<string>",
        "name": "<string>",
        "parent_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "shipment_items": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "supplier_purchase_order_shipment_id": 123,
          "supplier_purchase_order_id": 123,
          "supplier_purchase_order_item_id": 123,
          "quantity": 123,
          "unit_of_measure_id": 123
        }
      ],
      "shipment_extra_costs": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "supplier_purchase_order_shipment_id": 123,
          "name": "<string>",
          "quantity": 123,
          "unit_price": 123,
          "line_total": 123,
          "cost_allocation_type": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 10,
    "to": 10,
    "total": 50
  }
}

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

purchaseOrderId
integer
required

Purchase order ID

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
updated_at
string<date-time>

Filter by last update date (YYYY-MM-DD HH:mm:ss)

reference_number
string

Filter by reference number

Response

Successful response

data
object[]
meta
object