{"id":7613,"date":"2026-09-25T13:47:41","date_gmt":"2026-09-25T06:47:41","guid":{"rendered":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/?p=7613"},"modified":"2026-09-25T13:47:41","modified_gmt":"2026-09-25T06:47:41","slug":"apitms_shop","status":"publish","type":"post","link":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/apitms_shop\/","title":{"rendered":"TMS Shop Module"},"content":{"rendered":"
SKYBIZ API \u2014 TMS Module<\/strong><\/h5>\n

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

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

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

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

Primary Key:<\/strong> LocationCode<\/code> \u2014 unique per shop, 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 shop_data<\/code>.<\/p>\n

\n

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

These are the only fields recognized by this module \u2014 for reading, creating, and updating. Any other field name sent in a create<\/code> or update<\/code> request is rejected. Every field in tms_shop<\/code> is a string \u2014 there are no numeric columns on this module.<\/p>\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
LocationCode<\/code><\/td>\nstring<\/td>\nUnique shop\/outlet location code. Primary key. Required for every action. Fixed<\/strong> \u2014 cannot be changed once created<\/td>\n<\/tr>\n
LocationName<\/code><\/td>\nstring<\/td>\nShop\/outlet name<\/td>\n<\/tr>\n
Address<\/code><\/td>\nstring<\/td>\nShop address<\/td>\n<\/tr>\n
PostCode<\/code><\/td>\nstring<\/td>\nPostal code<\/td>\n<\/tr>\n
City<\/code><\/td>\nstring<\/td>\nCity<\/td>\n<\/tr>\n
State<\/code><\/td>\nstring<\/td>\nState<\/td>\n<\/tr>\n
Area<\/code><\/td>\nstring<\/td>\nGeneral area\/region the shop falls under<\/td>\n<\/tr>\n
ContactNo<\/code><\/td>\nstring<\/td>\nShop contact phone number<\/td>\n<\/tr>\n
MallID<\/code><\/td>\nstring<\/td>\nIdentifier of the mall the shop is located in, if applicable<\/td>\n<\/tr>\n
MallName<\/code><\/td>\nstring<\/td>\nName of the mall the shop is located in, if applicable<\/td>\n<\/tr>\n
ShopAreaCode<\/code><\/td>\nstring<\/td>\nRetail zone\/cluster code this shop belongs to<\/td>\n<\/tr>\n
ShopAreaName<\/code><\/td>\nstring<\/td>\nRetail zone\/cluster name this shop belongs to<\/td>\n<\/tr>\n
MnemonicCode<\/code><\/td>\nstring<\/td>\nShort mnemonic code used to reference the shop<\/td>\n<\/tr>\n
ShopCategory<\/code><\/td>\nstring<\/td>\nCategory classification for the shop<\/td>\n<\/tr>\n
BoutiqueGroup<\/code><\/td>\nstring<\/td>\nBoutique group classification for the shop<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

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

Retrieves shop location 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\": [\"LocationCode\", \"LocationName\", \"City\", \"State\", \"ShopCategory\"],\r\n  \"filters\": {\r\n    \"State\": \"Selangor\"\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. Any name not in the Allowed Fields list is silently dropped. Omit or leave empty to return all allowed 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 keys in the Allowed Fields list are applied; other keys are ignored<\/td>\nNo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Read Rules<\/h4>\n