Callback on visit level

If a callbackUrl is provided in the triggering request, Trax Mobile application will return a callback after ending or cancelling a visit with the session resolution in the following format:  

{callbackUrl}://sessionEnded?{param}={value}&{param}={value}...

​

Parameters provided in the callback:

clientSessionID

If provided while starting a visit, the Trax app will return the same value. The value can be null

​

status

The status fo the visit can be one of the following fields. Please note it can not be null

• "completed" (The 'Finish' button has been pressed by the user)

• "canceled" (The session has been canceled by the user)

• "canceledWithTasks" (The session has been canceled by the user after tasks were performed)

• "endOfDay" (The session was left open by the user, trax closes it at the end of day, 12:00 AM)

​

Recognition Results

In addition to clientSessionID and status, the visit-level callback can now include a recognitionResults parameter carrying task-level product recognition output. This is intended to support offline order-taking flows in the client application, letting it interpret recognition results per task and per scan. Available only for Augmented Reality tasks on Android.
Format: {callbackUrl}://sessionEnded?clientSessionID={id}&status={status}&recognitionResults={percent-encoded-JSON-array}

​

​

iOS Callback Example without Recognition Results

// in AppDelegate

func application(_ app: UIApplication, open url: URL, options:[UIApplicationOpenURLOptionsKey : Any]) -> Bool {

// parse the url params here, for exampe for this url:

// "www.foo.com?a=\(1)&b=\(2)&c=3"

let queryItems = URLComponents(string: url)?.queryItems

let params:[[String: String?]]? = queryItems?.map({[$0.name: $0.value]})

print(params?) // will output [["a": "1"], ["b": "2"], ["c": "3"]] }

​

​

Android Callback Example without Recognition Results

private void handleDeepLink(Intent intent) {

String action = intent.getAction();

if (action.equals(Intent.ACTION_VIEW)){

Uri data = intent.getData();

if (data != null) {

UrlQuerySanitizer sanitizer = new UrlQuerySanitizer(data.toString());

String status = sanitizer.getValue("status");

String clientSessionUID = sanitizer.getValue("clientSessionID");

handleDeepLink(status, clientSessionUID);

}

}

}

​

For more info, please refer to Googles deeplink documentation:

https://developer.android.com/training/app-links/deep-linking.html

https://developer.android.com/training/app-links/index.html

​

​

​

Recognition Results Object

Business rules:

• Maximum of 500 result objects per callback payload. If more than 500 SKUs qualify, only the first 500 are included.

• Only own-manufactured products are included; SKUs with no EAN are excluded.

• Results are task-level only — there is no aggregated visit-level recognition result.

• The same SKU can appear multiple times if it was seen in more than one task or scan; each occurrence is returned as its own object with its own taskID and arScanID.

• recognitionResults is returned alongside the same visit statuses already documented above (completed, canceled, canceledWithTasks, endOfDay).

• Recognition results are only returned when the visit was started from the client app via deeplink and ended in the Trax Mobile app. If the visit is opened directly in Trax (not via the expected deeplink flow), no callback is fired at all.

• If no eligible AR scan tasks were completed during the visit, recognitionResults is simply omitted — the existing status-only callback still fires normally.

• Data retention: Trax holds recognition data only until the visit ends; once the End Visit callback is sent, the data is cleared on the Trax side. The callback is a point-in-time handoff, not a retrievable record — plan for the client app to persist anything it needs locally

​

​

Object model example 

[
  {
    "skureference": "7290012345678",
    "result": 0,
    "taskID": 12,
    "arScanID": "5dc8b3f4-17a4-4dd4-94d5-2d89b8c7b111"
  },
  {
    "skureference": "7290012345678",
    "result": 1,
    "taskID": 18,
    "arScanID": "5dc8b3f4-17a4-4dd4-94d5-2d89b8c7b222"
  }
]

​

Field reference:

• recognitionResults — array, conditional Present only for visit-level deeplink sessions started from the client app via startSession, and only when eligible recognition output exists. Omitted entirely otherwise — the callback still fires with clientSessionID/status only.

• skureference — string, required Product identifier (sourced from the EAN field in Trax Products & Brands). SKUs without an EAN are excluded from the payload.

• result — integer, required Recognition result: 0 or 1.

• taskID — integer, required Trax task identifier for the task that produced this result.

• arScanID — string, required Unique identifier for the AR scan event that produced this result.

​

​

Callback on the task level 

If both a taskNumber and a taskCallbackURL are provided in the triggering request, Trax Mobile application will return a callback with the task resolution in the following format:  

{taskCallbackURL}://taskEnded?{param}={value}&{param}={value}...

​

Parameters provided in the callback:

clientSessionID

 

taskNumber

​

status

The status fo the task can be one of the following fields. Please note it can not be null

• "completed" (The 'Complete' button has been pressed by the user)

• "canceled" (The task has been canceled by the user without image capturing, ie. tha BACK button has been pressed by the user.)

• "canceledWithImages" (The task has been canceled by the user after capturing images, ie. the BACK button has been pressed by the user after taking images)

​

​

​

Triggering the Trax application within another application to END A VISIT

You can pass parameters through deeplink in the below format:

com.traxretail.traxretail://endSession?{my_param}={some_value}&{my_param}={some_value}...

​

The following are the available parameters. Please note that these params are case-senstive! Mandatory fields indicated by ＊  

clientSessionID*

The session id as it appears in the customer's system. When combined with the Trax session id it provides a link between the Trax and the customer data for a given session​

​

callbackUrl

URI of your app that the user will be redirected when ending the visit

​

​

Callback on visit level

If a callbackUrl is provided in the triggering request, Trax Mobile application will return a callback after ending or cancelling a visit with the session resolution in the following format:  

{callbackUrl}://sessionEnded?{param}={value}&{param}={value}...

​

Parameters provided in the callback:

​

​

clientSessionID

If provided while starting a visit, the Trax app will return the same value. The value can be null

​

status

The status fo the visit can be one of the following fields. Please note it can not be null

• "completed" (The 'Finish' button has been pressed by the user)

• "canceled" (The session has been canceled by the user)

• "canceledWithTasks" (The session has been canceled by the user after tasks were performed)

• "endOfDay" (The session was left open by the user, trax closes it at the end of day, 12:00 AM)

​

error message if the visit could not be ended 

​

​

Please note, that

• after triggering the Trax RE App to end a visit via deeplinking,

  • the visit will be automatically ended only if all the requirements at Trax end for ending the visit are met (eg. all mandatory tasks are completed, no incomplete optional tasks are in the task list etc.) - otherwise the user will be navigated to the Trax RE App and asked to do the necessary actions and manually end the visit,

  • similarly, the visit will not be ended automatically if there is an ongoing task, ie. a capture task which was previously started but not completed or cancelled by the user - in this case, the user is asked to complete the task and end the visit manually,

• after ending the visit, the user will only be navigated back to the hosting app if the deeplink contains a callbackURL.

​

​

​

​

​

​

​

​

​