Export sales orders (incremental)

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "order_id": 1001,
      "order_number": "ORD-2024-001",
      "status": "Active",
      "order_status": "awaiting_shipment",
      "total_amount": 128.23,
      "total_tax": 15.75,
      "total_shipping": 12.5,
      "total_paid": 128.23,
      "customer_id": 42,
      "customer_username": "johndoe",
      "customer_email": "john@example.com",
      "order_date": "2024-01-15",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "items": [
        {
          "order_item_id": 5001,
          "sku": "WIDGET-001",
          "name": "Premium Widget",
          "quantity": 2,
          "price": 49.99,
          "tax": 7.5,
          "quantity_ordered": 2,
          "quantity_shipped": 0,
          "quantity_cancelled": 0,
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "shipments": [],
      "fulfillment_orders": [
        {
          "fulfillment_order_id": 9001,
          "order_number": "ORD-2024-001-A",
          "status": "pending",
          "warehouse_group_id": 3,
          "created_at": "2024-01-15T10:31:00Z",
          "updated_at": "2024-01-15T10:31:00Z"
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123",
  "has_more": true,
  "meta": {
    "rows": 1000,
    "cutoff": "2024-01-16T00:00:00Z"
  }
}

Sales Orders

Export sales orders (incremental)

Incrementally export active sales orders updated within a given time window, with cursor-based pagination. Designed for real-time syncing and data pipelines.

How it works

Each export run is anchored to a fixed cutoff time (set at the start of the first request), so pages are stable even if records are updated mid-export.

Starting a run — provide since with a UTC datetime. The endpoint returns up to limit orders updated on or after that time, up to the cutoff.

Continuing a run — use the next_cursor value from the previous response. The cursor encodes the run’s position and is cryptographically signed; do not modify it.

Run complete — when has_more is false, you have received all orders in the window. Store the cutoff time (available in the first response’s meta.cutoff) as your next since value to pick up changes on the following sync.

Pagination parameters

Parameter	Description
`since`	Start of the time window (UTC). Required when starting a new run. Cannot be combined with `cursor`.
`cursor`	Continuation token from a previous response. Required when continuing a run. Cannot be combined with `since`.
`limit`	Max records per page. Default and maximum: 1000.

Example flow

# 1. Start a run from a known point in time
GET /sales-orders/export?since=2024-01-01T00:00:00Z&limit=1000

# 2. If has_more is true, continue with the cursor
GET /sales-orders/export?cursor=<next_cursor from previous response>

# 3. Repeat until has_more is false
# 4. Save meta.cutoff as your next since value

Notes

Only active sales orders are returned.
Results are ordered by updated_at ascending, then by id ascending, ensuring a stable and consistent traversal order.
since accepts any parseable UTC datetime string (e.g. 2024-01-01, 2024-01-01T00:00:00Z, 2024-01-01 00:00:00).

GET

sales-orders

export

Export sales orders (incremental)

curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/sales-orders/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "order_id": 1001,
      "order_number": "ORD-2024-001",
      "status": "Active",
      "order_status": "awaiting_shipment",
      "total_amount": 128.23,
      "total_tax": 15.75,
      "total_shipping": 12.5,
      "total_paid": 128.23,
      "customer_id": 42,
      "customer_username": "johndoe",
      "customer_email": "john@example.com",
      "order_date": "2024-01-15",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "items": [
        {
          "order_item_id": 5001,
          "sku": "WIDGET-001",
          "name": "Premium Widget",
          "quantity": 2,
          "price": 49.99,
          "tax": 7.5,
          "quantity_ordered": 2,
          "quantity_shipped": 0,
          "quantity_cancelled": 0,
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "shipments": [],
      "fulfillment_orders": [
        {
          "fulfillment_order_id": 9001,
          "order_number": "ORD-2024-001-A",
          "status": "pending",
          "warehouse_group_id": 3,
          "created_at": "2024-01-15T10:31:00Z",
          "updated_at": "2024-01-15T10:31:00Z"
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123",
  "has_more": true,
  "meta": {
    "rows": 1000,
    "cutoff": "2024-01-16T00:00:00Z"
  }
}

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

since

string<date-time>

UTC datetime marking the start of the export window. Required when starting a new run. Cannot be combined with cursor.

Example:

"2024-01-01T00:00:00Z"

cursor

string

Signed continuation token from a previous export response. Required when continuing a run. Cannot be combined with since.

Example:

"eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123"

limit

integer

default:1000

Maximum number of orders to return per page.

Required range: 1 <= x <= 1000

Response

Successful export page

data

object[]

Show child attributes

next_cursor

string | null

Signed cursor token to fetch the next page. Null when the export is complete.

Example:

"eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123"

has_more

boolean

Whether more pages exist in this export run.

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Export sales orders (incremental)

How it works

Pagination parameters

Example flow

Notes

Authorizations

Query Parameters

Response