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

TMS GDN (Goods Delivery Note)<\/strong><\/h3>\n

The TMS GDN module allows you to retrieve, create, update, and delete Goods Delivery Note documents in SKYBIZ TMS. Each GDN has a header<\/strong> (document-level details such as origin\/destination and dates) and a nested items<\/strong> array (the line items being delivered). Supports read<\/strong>, create<\/strong>, update<\/strong>, and delete<\/strong> operations.<\/p>\n

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

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

Primary Key:<\/strong> Doc1No<\/code> \u2014 unique per GDN document, 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 gdn_data<\/code>.<\/p>\n

\n

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

These are the only document-level (header) fields recognized by this module. Any other field name sent at the header level in a create<\/code> or update<\/code> request is rejected.<\/p>\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
Doc1No<\/code><\/td>\nstring<\/td>\nUnique GDN document number. Primary key. Required for every action. Fixed<\/strong> \u2014 cannot be changed once created<\/td>\n<\/tr>\n
DocDate<\/code><\/td>\nstring<\/td>\nDocument date. Recommended format YYYY-MM-DD<\/code> \u2014 also used by the date_from<\/code>\/date_to<\/code> read filters<\/td>\n<\/tr>\n
DelivMode<\/code><\/td>\nstring<\/td>\nDelivery mode\/method for this GDN<\/td>\n<\/tr>\n
FromLocCode<\/code><\/td>\nstring<\/td>\nOrigin location code (e.g. warehouse\/shop the goods ship from)<\/td>\n<\/tr>\n
FromLocName<\/code><\/td>\nstring<\/td>\nOrigin location name<\/td>\n<\/tr>\n
ToLocCode<\/code><\/td>\nstring<\/td>\nDestination location code (e.g. warehouse\/shop the goods ship to)<\/td>\n<\/tr>\n
ToLocName<\/code><\/td>\nstring<\/td>\nDestination location name<\/td>\n<\/tr>\n
DocumentType<\/code><\/td>\nstring<\/td>\nDocument type classification for this GDN<\/td>\n<\/tr>\n
OriginalDocNo<\/code><\/td>\nstring<\/td>\nReference to an original\/source document, if any<\/td>\n<\/tr>\n
AccountingDate<\/code><\/td>\nstring<\/td>\nAccounting date associated with this GDN<\/td>\n<\/tr>\n
Remarks<\/code><\/td>\nstring<\/td>\nHeader-level remarks\/notes<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

Line Fields (items<\/code>)<\/strong><\/h3>\n

Each document carries a nested items<\/code> array. These are the only fields recognized at the line level. A line’s internal sequence number is assigned automatically and is never sent or returned.<\/p>\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
ItemCode<\/code><\/td>\nstring<\/td>\nItem code for this line<\/td>\n<\/tr>\n
ItemName<\/code><\/td>\nstring<\/td>\nItem name for this line<\/td>\n<\/tr>\n
Qty<\/code><\/td>\nfloat<\/td>\nQuantity being delivered on this line. Returned as a float on read<\/td>\n<\/tr>\n
ColorCode<\/code><\/td>\nstring<\/td>\nColour code of the item variant on this line<\/td>\n<\/tr>\n
ColorName<\/code><\/td>\nstring<\/td>\nColour name of the item variant on this line<\/td>\n<\/tr>\n
Size<\/code><\/td>\nstring<\/td>\nSize of the item variant on this line<\/td>\n<\/tr>\n
UnitPrice<\/code><\/td>\nfloat<\/td>\nUnit price for this line. Returned as a float on read<\/td>\n<\/tr>\n
Amount<\/code><\/td>\nfloat<\/td>\nLine amount (total for this line). Returned as a float on read<\/td>\n<\/tr>\n
Remarks<\/code><\/td>\nstring<\/td>\nLine-level remarks\/notes<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

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

Retrieves GDN documents, each returned with its header fields plus a nested items<\/code> array. A document with no lines is still returned, with items<\/code> as an empty array.<\/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\": [\"Doc1No\", \"DocDate\", \"FromLocCode\", \"ToLocCode\"],\r\n  \"filters\": {\r\n    \"ToLocCode\": \"SHOP001\"\r\n  },\r\n  \"date_from\": \"2026-09-01\",\r\n  \"date_to\": \"2026-09-30\",\r\n  \"doc_nos\": [\"GDN-0001\", \"GDN-0002\"]\r\n}<\/pre>\n
Request Parameters<\/h4>\n
\n\n\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 header<\/strong> field names to return. Any name not in the Header Fields list is silently dropped. Omit or leave empty to return all header fields. Does not affect which line fields are returned \u2014 line fields are always returned in full<\/td>\nNo<\/td>\n<\/tr>\n
filters<\/code><\/td>\nObject of field: value<\/code> pairs, applied to header fields only. Each is an exact-match (=<\/code>) condition, combined with AND. Keys outside the Header Fields list are ignored<\/td>\nNo<\/td>\n<\/tr>\n
date_from<\/code><\/td>\nReturn documents with DocDate >=<\/code> this date. Format YYYY-MM-DD<\/code><\/td>\nNo<\/td>\n<\/tr>\n
date_to<\/code><\/td>\nReturn documents with DocDate <=<\/code> this date. Format YYYY-MM-DD<\/code><\/td>\nNo<\/td>\n<\/tr>\n
doc_nos<\/code><\/td>\nArray of specific Doc1No<\/code> values to limit the read to. Combined with AND alongside any other filters\/date range<\/td>\nNo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
Read Rules<\/h4>\n