POST

Products.Count

Return the number of products matching optional filters. Optional active filter: 1 = active only, 0 = inactive only. When active is omitted, counts both active and inactive products. Product Type filter (type): product, subscription, service, or donation.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Returns only the count for Products using the same filters as the list function.

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

  • Product type filter (type) allowed values: product (Physical Product), subscription, service, donation.

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
search
post
stringmembershipCounts only products matching this text.
type
post
stringproductCount by Product Type. Allowed: product (Physical Product), subscription, service, donation. Omit to count all types.
active
post
int1Optional active filter: 1 = active only, 0 = inactive only. When omitted, counts both.
cat_id
post
int4Counts products by category id when stored.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Products.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "search": "membership"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Products.Count",
    "url_domain": "https:\/\/{domain}\/app\/Products.Count"
}

Endpoint

POST /app/Products.Count
POST https://{user}.bull36.com/app/Products.Count
POST https://{domain}/app/Products.Count

Sample Output

{
    "success": 1,
    "count": 9
}

Count Only

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

{
    "url": "\/app\/Products.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Products.Count",
    "url_domain": "https:\/\/{domain}\/app\/Products.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "search": "membership"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Total matching products before paging."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('search', 'membership');

const res = await fetch('https://{domain}/app/Products.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();
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/Products.Count', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}