POST

Customer.Orders.FormData

Return order_fields_on_dashboard columns, order_custom_fields, and order_statuses for building the client orders table. Optionally include one owned row when orders_for_cust_id is sent. read_only=true (customers cannot add/edit on this page).

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.FormData 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 module_orders.
  • Staff Order.FormData (with catalog products for Add modal) is unchanged.

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
orders_for_cust_id
post
int267974Optional owned row to include in data.
lang
post
stringenStatus label language when data is returned.

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.FormData",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Orders.FormData",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Orders.FormData"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "read_only": true,
    "columns": [
        "order_id",
        "date",
        "notes",
        "total_price",
        "paid_status",
        "order_status"
    ],
    "order_statuses": [
        {
            "id": 12,
            "name_en": "Open",
            "color": "#fff"
        }
    ]
}

JavaScript Example

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

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

Error Example

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