Last updated 9 months ago
Was this helpful?
Perform various operations for Symitar parameters.
Symitar eDocs References: Coming soon.
No description available.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/parameter/getTrackingCode HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 145 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "TrackingCodeCode": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "TrackingCode": { "Description": "text", "Code": 1 } }
POST /nexum/627/2022.01/parameter/getTrackingCodeSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 256 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "TrackingCodeCode": 1, "SelectableFields": { "IncludeAllTrackingCodeFields": true, "TrackingCodeFields": { "Code": true, "Description": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getTrackingCodePagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 218 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "TrackingCode": [ { "Description": "text", "Code": 1 } ], "Token": "text" }
POST /nexum/627/2022.01/parameter/getTrackingCodeListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 235 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllTrackingCodeFields": true, "TrackingCodeFields": { "Code": true, "Description": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "TrackingCodeList": { "hasReachedMaximumListSize": true, "TrackingCode": [ { "Description": "text", "Code": 1 } ] } }
Fields available for selecting when retrieving Tracking Code data
POST /nexum/627/2022.01/parameter/searchTrackingCodeSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 267 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "SelectableFields": { "IncludeAllTrackingCodeFields": true, "TrackingCodeFields": { "Code": true, "Description": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/parameter/getTrackingCodePagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 329 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllTrackingCodeFields": true, "TrackingCodeFields": { "Code": true, "Description": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Fields available for selecting when retrieving paginated Tracking Code data
POST /nexum/627/2022.01/parameter/searchTrackingCodePagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 344 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllTrackingCodeFields": true, "TrackingCodeFields": { "Code": true, "Description": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Update tracking codes by ID
POST /nexum/627/2022.01/parameter/updateTrackingCodeByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 198 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "TrackingCodeCode": 1, "TrackingCodeUpdatableFields": { "Description": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
