POST

Categories.Get

Return one product category by id from ec_categories.

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 Categories information as JSON for the UI.

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

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

NameTypeSampleExplanation
category_id
post
int4Category id. Aliases: id, update_id, data_id, cat_id.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Categories.Get",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "category_id": "4"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Categories.Get",
    "url_domain": "https:\/\/{domain}\/app\/Categories.Get"
}

Endpoint

POST /app/Categories.Get
POST https://{user}.bull36.com/app/Categories.Get
POST https://{domain}/app/Categories.Get

Sample Output

{
    "success": 1,
    "data": {
        "id": "4",
        "category_id": "4",
        "category": "Membership",
        "name": "Membership",
        "description": "Membership products",
        "parent": "0",
        "type": "products",
        "in_stock": "1",
        "team_member": [],
        "custom_field_list": []
    }
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ category_id: '4' });
const res = await fetch('/app/Categories.Get', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "Category was not found."
}