View the carrier integration profile details

  • Release version: Yokohama
  • Updated January 30, 2025
  • 1 minute to read
  • View the details of the carrier API used to connect your ServiceNow instance to the third-party shipping carrier application.

    Before you begin

    Role required: admin, domain_admin, asset, or inventory_admin

    Procedure

    1. Navigate to All > Hardware Asset Workspace > Asset operations.
    2. From the Shipment list, select Carrier integration profiles.
      The third-party carrier application automatically inserts records into the Carrier integration profiles list. You can also create a carrier integration profile.
    3. Select the carrier integration profile of your carrier.
      Table 1. Carrier Integration Profile Details form
      Field Description
      Name Name of the integration profile.
      Connection details Reference to the Connection and Credentials Aliases table that stores the credentials of the customer.
      Note:
      Your credentials must be updated in the Connection and Credentials Aliases table so that you’re authenticated to connect to the carrier API.
      API Name of the script that has the integration business logic.
      Job Name of the scheduled job that invokes the carrier API to fetch the shipments details.

      This job is created by a job that runs daily, The ITAM: Process integration profiles and stale shipment job.

      Active Option that indicates the status of the integration profile.
      Note:
      Only users with the admin or domain_admin role can deactivate the integration profile but they can’t delete the integration profile. When an integration profile is deactivated, the associated job that invokes the carrier API is deactivated automatically.