Skip to main content
GET
/
reports
/
edi
EDI documents (paginated)
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/reports/edi \
  --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

​
edi_type
string

Comma-separated EDI transaction types (e.g. 850,856)

​
transaction_status
string

Filter by transaction status

​
direction
string

Filter by direction

​
order_id
integer

Filter by order ID

​
control_number
string

Filter by control number

​
has_received_997
enum<string>

Filter by 997 acknowledgement status

Available options:
true,
false
​
date_from
string<date-time>

Start of date range

​
date_to
string<date-time>

End of date range

​
sort_field
string
default:created_at

Field to sort by

​
sort_direction
string
default:desc

Sort direction (asc or desc)

​
per_page
integer
default:100

Page size (max 100)

Required range: x <= 100
​
limit
integer

Alias for per_page

Response

Paginated EDI documents

​
data
object[]
​
meta
object