Skip to main content
GET
/
reports
/
transaction-cogs
Transaction COGS (paginated, read-only)
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/reports/transaction-cogs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {}
  ],
  "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.

Query Parameters

​
from_date
string<date>

Start of date range

​
to_date
string<date>

End of date range

​
product_name
string

Filter by product name

​
sku
string

Filter by SKU

​
channel
string

Filter by sales channel

​
order_number
string

Filter by order number

​
cost_per_unit
number

Filter by cost per unit

​
is_missed_cogs
boolean

When true, selects the missed COGS query path

​
per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
sortField
string

Field to sort by

​
sortDirection
string

Sort direction (asc or desc)

Response

Paginated transaction COGS rows

​
data
object[]
​
meta
object