The Advanced Integrated Visibility Tracking Number Subscription is designed for the Advanced Integrated Visibility subscribers to manage their tracking number based webhook projects and perform project related operations such as add new tracking numbers, edit or view job details using API endpoints.

Note:

• You must have admin or contributor access for your Advanced Integrated Visibility project
• For more information on Advanced Integrated Visibility and its features, visit the Advanced Integrated Visibility documentation page.

The benefits of Advanced Integrated Visibility Tracking Number Subscription are:

• You can easily update and manage tracking numbers of your Advanced Integrated Visibility project using the API endpoints.
• This API enables you to associate multiple tracking numbers to your project in a single API transaction, instead of associating each tracking number one by one.
• You can submit API requests consecutively and view log details of success/failures of these requests.

Use the below endpoints to manage your Advanced Integrated Visibility project:

This API can be accessed only through your project overview as depicted in above screenshot.

Use this endpoint to trigger an asynchronous job to associate one or multiple tracking numbers to a specific Advanced Integrated Visibility project.

The required input information for this request is:

• Action – Specify the action to be performed when you submit the request. Example: ADD
• Tracking number Details – Specify the tracking number

You can associate maximum of 1000 tracking numbers in a single request. The successful response for this request will return the jobID, current job status, and job creation and job completion timestamp. This jobId can be used later to check the status of the asynchronous job.

Use this endpoint to get the status of an asynchronous job (one or more consecutive requests in queue) or status of all the jobs submitted.

The required input information for this request is:

• Job ID – Specify the job ID for which you intend to retrieve status.

Note: Job ID is an optional input for this endpoint. If you do not specify the job ID, then you will get the status of all the submitted jobs.

The successful response for this request will return the jobID, current job status, and job creation and job completion timestamp. The response will show the current status of the jobs. In addition, the response will also contain success messages, errors, or warnings for users to view and troubleshoot them as applicable.

• If the job status is displayed as COMPLETED, it means that all the tracking numbers have been validated and processed successfully.
  • The COMPLETED status implies the tracking numbers are validated and processed successfully. It does not imply that all the tracking numbers have been successfully added to the Advanced Integrated Visibility project. 
  • If you attempt to associate multiple tracking numbers and only some of them get associated and rest of them fail to associate, even then the job status will be updated as COMPLETED. To confirm the status of each tracking number in the associate request the batch-report must be downloaded.

Note:

• If the job status is displayed as FAILED, it implies that due to various reasons/hard failures, the request could not be processed, and user must retry it again.

Following are the status and their respective descriptions:

Use this endpoint to download JSON report for an asynchronous job that is in COMPLETED status.

The required input information associated with this request is:

• Job ID – Specify the job ID for which you intend to retrieve status.

Note:

• Job ID is a mandatory input for this endpoint.
• You can download the report of only one asynchronous job at a time.
• If the job is not COMPLETED and you try to download the report, then an error message is displayed.

The successful response for this request provides you the report of the job in JSON format.

• A maximum of 1,000 shipping tracking numbers can be associated with a Advanced Integrated Visibility project in each request.
• There is no limit on maximum tracking numbers that you can associate with a given Advanced Integrated Visibility project.
• Any associated tracking number(s) will be dissociated after 40 number of days from a given Advanced Integrated Visibility project.
• Any created Job Id status & details will not be available after 90 number of days for a given Advanced Integrated Visibility project.
• Secured tracking information such as recipient address, recipient signature will not be available via Advanced Integrated Visibility Tracking Number Subscription.