{"id":7626,"date":"2026-09-25T16:44:50","date_gmt":"2026-09-25T09:44:50","guid":{"rendered":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/?p=7626"},"modified":"2026-09-25T16:44:50","modified_gmt":"2026-09-25T09:44:50","slug":"apitms_brand","status":"publish","type":"post","link":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/apitms_brand\/","title":{"rendered":"TMS Brand Module"},"content":{"rendered":"
SKYBIZ API \u2014 TMS Module<\/strong><\/h5>\n

TMS Brand<\/strong><\/h3>\n

The TMS Brand module allows you to retrieve, create, update, and delete brand records in your SKYBIZ TMS master data. Supports read<\/strong>, create<\/strong>, update<\/strong>, and delete<\/strong> operations.<\/p>\n

Endpoint:<\/strong> \/apiv2\/modules\/tms_brand.php<\/code><\/p>\n

Required Permissions:<\/strong> TMS Brand \u2014 Read, TMS Brand \u2014 Create, TMS Brand \u2014 Update, TMS Brand \u2014 Delete (as applicable to the action used)<\/p>\n

Primary Key:<\/strong> Code<\/code> \u2014 unique per brand, and fixed<\/strong> once created (cannot be changed via update<\/code>).<\/p>\n

Batch Limit:<\/strong> Maximum 500 documents<\/strong> per request for create<\/code>, update<\/code>, and delete<\/code>.<\/p>\n

Data Wrapper Key:<\/strong> Documents for this module are wrapped under brand_data<\/code>.<\/p>\n

\n

Allowed Fields<\/strong><\/h3>\n

This are the field name that sent in a create<\/code> or update<\/code> request.<\/p>\n

\n\n\n\n\n\n\n
Field<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Code<\/code><\/td>\nstring<\/td>\nUnique brand code. Primary key. Required for every action. Fixed<\/strong> \u2014 cannot be changed once created<\/td>\n<\/tr>\n
Name<\/code><\/td>\nstring<\/td>\nBrand name<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Read TMS Brand<\/strong><\/h3>\n

Retrieves brand records. No date range is required for this module. You may optionally select specific fields and\/or filter by exact field values.<\/p>\n

Base Request Structure<\/h4>\n
{\r\n  \"api_key\": \"your-api-key\",\r\n  \"api_secret\": \"your-api-secret\",\r\n  \"action\": \"read\",\r\n  \"fields\": [\"Code\", \"Name\"],\r\n  \"filters\": {\r\n    \"Code\": \"BR001\"\r\n  }\r\n}<\/pre>\n
Request Parameters<\/h4>\n
\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\nRequired<\/th>\n<\/tr>\n<\/thead>\n
api_key<\/code><\/td>\nYour API key<\/td>\nYes<\/td>\n<\/tr>\n
api_secret<\/code><\/td>\nYour API secret<\/td>\nYes<\/td>\n<\/tr>\n
action<\/code><\/td>\nMust be \"read\"<\/code><\/td>\nYes<\/td>\n<\/tr>\n
fields<\/code><\/td>\nArray of field names to return (Code<\/code> and\/or Name<\/code>). Any other name is silently dropped. Omit or leave empty to return both fields<\/td>\nNo<\/td>\n<\/tr>\n
filters<\/code><\/td>\nObject of field: value<\/code> pairs. Each is applied as an exact-match (=<\/code>) condition, combined with AND. Only Code<\/code> and Name<\/code> are recognized; other keys are ignored<\/td>\nNo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Read Rules<\/h4>\n