Skip to main content
GET
/
purchase-orders
Purchase orders
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "order_numbers": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "order_status": "active",
      "order_date": "2023-12-25",
      "invoice_date": "2023-12-25",
      "arrival_due_date": "2023-12-25",
      "requested_ship_date": "2023-12-25",
      "order_type": 123,
      "incoterm": "<string>",
      "tracking_info": "<string>",
      "payment_terms": "<string>",
      "supplier_id": 123,
      "item_count": 123,
      "total_qty_ordered": 123,
      "total_qty_received": 123,
      "total_qty_remaining": 123,
      "order_cost": 123,
      "total_tax": 123,
      "total_shipping_cost": 123,
      "total_cost": 123,
      "total_paid": 123,
      "total_due": 123,
      "down_payment": 123,
      "public_note": "<string>",
      "private_note": "<string>",
      "starred": true,
      "items": [
        {
          "id": 123,
          "purchase_order_id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "quantity": 123,
          "unit_price": 123,
          "unit": "<string>",
          "tax": 123,
          "discount_amount": 123,
          "line_total": 123,
          "received_quantity": 123,
          "source_sku": "<string>",
          "product": {
            "id": 123,
            "name": "<string>",
            "description": "<string>",
            "retail_price": 123,
            "wholesale_price": 123,
            "variant_attributes": {},
            "sku": "<string>",
            "upc": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "supplier": {
        "id": 123,
        "status": 123,
        "name": "<string>",
        "description": "<string>",
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "contact_name": "<string>",
        "contact_email": "<string>",
        "contact_phone": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "payments": [
        {
          "id": 123,
          "payment_date": "2023-12-25",
          "payment_type": "cash",
          "paid_amount": 123,
          "remarks": "<string>",
          "external_id": "<string>",
          "created_by": {
            "id": 123,
            "name": "<string>"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "ship_to": {
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "default_ship_to_address": "ship_to_address"
      },
      "warehouse": {
        "id": 123,
        "name": "<string>"
      },
      "location": {
        "id": 123,
        "name": "<string>"
      },
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "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]

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
​
order_numbers
string

Filter by purchase order numbers (alternate IDs). Searches across all order numbers associated with the purchase order.

​
public_note
string

Filter by public note content

​
private_note
string

Filter by private note content

​
tag
string

Filter by tags

​
order_date
string<date>

Filter by order date (YYYY-MM-DD)

​
invoice_date
string<date>

Filter by invoice date (YYYY-MM-DD)

​
requested_ship_date
string<date>

Filter by requested ship date (YYYY-MM-DD)

​
arrival_due_date
string<date>

Filter by arrival due date (YYYY-MM-DD)

​
created_at
string<date-time>

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

​
updated_at
string<date-time>

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

​
order_quantity
number

Filter by total number of items ordered

​
total_qty_ordered
number

Filter by total quantity of line items ordered (sum of ordered_qty from all items)

​
total_qty_received
number

Filter by total quantity of line items received

​
total_qty_remaining
number

Filter by total quantity of line items remaining to be received (ordered - received)

​
order_cost
number

Filter by order cost

​
total_cost
number

Filter by total cost (including tax and shipping)

​
total_tax
number

Filter by tax amount

​
total_shipping_cost
number

Filter by shipping cost

​
total_paid
number

Filter by amount paid

​
starred
boolean

Filter by starred status

​
supplier_id
integer

Filter by supplier ID

​
warehouse_id
integer

Filter by warehouse ID

​
location_id
integer

Filter by location ID

​
order_status
enum<string>

Filter by order status

Available options:
active,
inactive,
deleted

Response

Successful response

​
data
object[]
​
meta
object