The Advanced Integrated Visibility Account Number Subscription is designed for the Advanced Integrated Visibility subscribers to manage their account number based Advanced Integrated Visibility projects and perform project related operations such as edit or view details using API endpoints.

Note:

• You must have admin access for your API project where this API is enabled.
• For more information on Advanced Integrated Visibility and its features, visit the Advanced Integrated Visibility documentation page.

The benefits of Advanced Integrated Visibility Account Number Subscription are:

• You can easily update and manage your Advanced Integrated Visibility project using the API endpoints.
• This API enables you to associate multiple accounts to your project in a single API transaction, instead of selecting each account one by one.

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

Update Advanced Integrated Visibility Project

Use this endpoint to update any Advanced Integrated Visibility project details under your organization.

The input information for this request is:

• requestType: Specify the type of update request. 
  • ADD_ACCOUNTS: Use this option to add new accounts in the existing project if the organization is already associated with Advanced Integrated Visibility project for all accounts.
  • DELETE_ACCOUNTS: Use this option to delete any account from the project.
  • UPDATE_ALL: Use this option for regular project updates.
Note: This is an optional element and UPDATE_ALL is selected by default, if not specified by the user.
• category: Specify the category of the feature you want to update for the project. Example: RETRY_POLICY, PROOF_OF_DELIVERY etc.
• subCategories: Specify the individual features for the selected feature category. Example: BASIC_HRS, PPOD, SPOD, SHIP, TRAN etc.

The successful response to this request will return the subscription Id, an indicator if the project has been updated for all the accounts in the organization, and a timestamp for the updated project.

Retrieve Project Detail

Use this endpoint to retrieve the project details for a specified Advanced Integrated Visibility project in a paginated format.

The required input information for this request is:

• authorization: Specify the authorization token.
• subscriptionId: Specify the subscription Id for the Advanced Integrated Visibility project to retrieve the details.

The successful response to this request will generate the specified webhooks project details in a paginated format or will return an alert or error details in case of any failures.

• A maximum of 30,000 shipping account numbers can be associated with an Advanced Integrated Visibility project in a given request.