POST

Customer.Orders.List

List orders_for_cust rows for the logged-in customer (same as client/orders). Joins catalog orders for order_name. Columns follow org order_fields_on_dashboard. Staff Order.List is unchanged.

Permissions

  • User must be logged in with a valid bearer token.
  • The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Runs the Customer.Orders.List function and returns JSON.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
  • Requires Customer.Login token and client module_orders enabled.
  • cust_id is always JWT c_id — do not send customer_id.
  • Read-only for customers. Staff add/edit/delete stay on Order.Add / Order.Edit / Order.Delete.
  • paid_status: 0=Unpaid, 1=Paid, 2=Partly PAID (paid_status_label included).

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
search
post
stringMonthlySearch order name, notes, or order number.
paid_status
post
int0Filter by paid_status. Alias: paid_val.
order_status_id
post
json12Filter by all_status id(s). Alias: order_status.
from_date
post
date2026-01-01Optional date from (Y-m-d). Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
to_date
post
date2026-12-31Optional date to (Y-m-d). Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
start
post
int0Row offset.
limit
post
int25Page size, capped at 25.
lang
post
stringenStatus label language (en|he). Alias: site_lang.

Authentication

Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Customer.Orders.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Orders.List",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Orders.List"
}

Endpoint

POST /app/Customer.Orders.List
POST https://{user}.bull36.com/app/Customer.Orders.List
POST https://{domain}/app/Customer.Orders.List

Sample Output

{
    "success": 1,
    "count": 1,
    "columns": [
        "order_id",
        "date",
        "notes",
        "total_price",
        "paid_status",
        "order_status"
    ],
    "data": [
        {
            "id": 267974,
            "orders_for_cust_id": 267974,
            "order_name": "Monthly plan",
            "total_price": "100",
            "paid_status": 0,
            "paid_status_label": "Unpaid",
            "order_status_label": "Open"
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Customer.Orders.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Orders.Count",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Orders.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use the matching count route when available, or count returned rows.",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

const res = await fetch('https://{domain}/app/Customer.Orders.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('limit', '25');

const res = await fetch('/app/Customer.Orders.List', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "error": "customer_login_required"
}