Skip to main content
GET
/
products
/
export
Export products (cursor pagination)
curl --request GET \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/products/export \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "retail_price": 123,
      "wholesale_price": 123,
      "unit_cost": 123,
      "sellable": true,
      "discontinued": true,
      "custom_fields": {},
      "sku": "<string>",
      "alternate_skus": [
        {
          "id": 123,
          "sku": "<string>",
          "unit_conversion_rule_id": 123
        }
      ],
      "upc": "<string>",
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      ],
      "substitutions": [
        {}
      ],
      "boms": [
        {
          "id": 123
        }
      ],
      "type": "PRODUCT",
      "kit_items": [
        {
          "id": 123,
          "product_id": 123,
          "quantity": 123,
          "uom_id": 123,
          "base_uom_quantity": 123,
          "price": 123,
          "original_price": 123,
          "total": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "landed_cost": 123,
      "product_length": 123,
      "product_width": 123,
      "product_height": 123,
      "box_length": 123,
      "box_width": 123,
      "box_height": 123,
      "carton_length": 123,
      "carton_width": 123,
      "carton_height": 123,
      "shipping_length": 123,
      "shipping_width": 123,
      "shipping_height": 123,
      "pallet_length": 123,
      "pallet_width": 123,
      "pallet_height": 123,
      "product_weight": {
        "unit": "lb",
        "value": 123
      },
      "product_weight_oz": 123,
      "product_weight_lb": 123,
      "box_weight": {
        "unit": "lb",
        "value": 123
      },
      "box_weight_oz": 123,
      "box_weight_lb": 123,
      "carton_weight": {
        "unit": "lb",
        "value": 123
      },
      "carton_weight_oz": 123,
      "carton_weight_lb": 123,
      "shipping_weight": {
        "unit": "lb",
        "value": 123
      },
      "shipping_weight_oz": 123,
      "shipping_weight_lb": 123,
      "pallet_weight": {
        "unit": "lb",
        "value": 123
      },
      "pallet_weight_oz": 123,
      "pallet_weight_lb": 123,
      "dimensional_weight": {
        "unit": "lb",
        "value": 123
      },
      "dimensional_weight_oz": 123,
      "dimensional_weight_lb": 123,
      "qty_low_alert": 123,
      "qty_reorder_threshold": 123,
      "qty_minimum": 123,
      "image_url": "<string>",
      "category": {
        "id": 123,
        "name": "<string>"
      },
      "subcategory": {
        "id": 123,
        "name": "<string>"
      },
      "variant_attributes": "<unknown>",
      "supplier": {
        "id": 123,
        "status": 123,
        "name": "<string>",
        "description": "<string>",
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "supplier_admin_id": 123,
        "contact_name": "<string>",
        "contact_email": "<string>",
        "contact_phone": "<string>",
        "created_by": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123",
  "has_more": true,
  "meta": {
    "rows": 1
  }
}

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

since
string<date-time>

Lower bound for updated_at (inclusive). Required on the first page; omit when using cursor.

Example:

"1970-01-01T00:00:00Z"

cursor
string

Signed continuation token from a previous response's next_cursor. Required on follow-up pages; cannot be combined with since.

Example:

"eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123"

limit
integer
default:100

Maximum number of products to return per page.

Required range: 1 <= x <= 1000

Response

Successful export page

data
object[]
required
next_cursor
string | null
required

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

Example:

"eyJ2IjoxLCJtb2RlIjoiZXhwb3J0In0.abc123"

has_more
boolean
required

true when the page is full (data.length === limit), indicating more rows may exist.

meta
object
required