Api Products

Knowledge Hub Listing

Knowledge Hub

In the Knowledge Hub, you will find useful information to aid in selecting the appropriate product for your use case. As well, the information shared here will help you adopt the API by providing detailed technical specifications as well as support contacts.

API ProductsAccount ManagementAftermarket Prioritized Service Events UniteAPI Management Enterprise Cat Com DevelopmentAPI Management Enterprise Cat Com DevelopmentAPI Usage MetricsApigee Cache InvalidationApigee Cache InvalidationAsset ConfigurationsAuthorization Management SystemAuthorization Management System - InternalAuthorizations Management System (External)Basic DailyBDTCase IntegrationCat Calculator Web - Partner APICat Calculator Web - Quick EstimatorCat Certified RebuildCat Diagnostic ServicesCat Digital - Restricted AssetsCat Digital Retail Mobile API ServiceCat Foresight RecommendationCat Gateway AdhocCat InspectCat InspectCat InteractCAT Interact - InternalCAT IP - Error TrackingCAT IP - Error TrackingCAT IP - ProformaCAT IP - ProformaCAT IP - ResponseCAT IP - ResponseCAT IP - Rule SequenceCAT IP - Shopping SessionCAT IP - Shopping SessionCAT IP - TransactionCAT IP - TransactionCAT IP - Transaction TypeCAT IP - VendorCAT QRCat Wear Management SystemCat Wear Management System Used InspectcatDiagnosticServices-DevelopmentCATGatewaycatUsed-Development-CICDCCDS Asset Start ModesCCDS Asset StructuresCCDS Dealer Action ItemsCCDS Device Reg TeamCCDS GatewayCCDS GroupsCCDS Groups v2CCDS SitesCCDS SubscriptionsCCDS-Gateway-DevelopmentCDandT ExplorationCDID - AgreementCDID - CustomerCDID - Dealer HierarchyCDID-DevelopmentCore TelematicsCRMI CasesCRMI ECRM Accounts and OpportunitiesCRMI FilesCUPA Used Equipment Valuations and PredictionsCurrency Exchange RatesCustomer Value Agreements (CVAs)Customer Value Agreements (CVAs) - OnboardingDealer Asset ManagementDealer ERP Customer MasterDealer Location Management ServicesDealer Location ServicesDealer Service Portal BillingDealer Service Portal BillingDealer Service Portal SubscriptionsDealer Service Portal User RolesDiagnostic Services - BundlesDiagnostic Services - Possible CausesDiagnostic Services - Service InformationsDiagnostic Services - SessionsDomestic TransportationDSP-DevelopmentDSP-Developmente Commerce DealerIntegrationseCommerce CustomerseCommerce Parts AvailabilityeCommerce User AffiliationseCommerce User Management v1Equipment Processing Center Work OrdersEquipment Service HistoryFinance CLMFinance CVAFleet Assessment ServicesForm Publishing V2FPD Call CenterFPD POS - InternalFPD POS Cat CardFPD POS Cat CreditsFPD-POS-Development-CICDHelios APIs for ChinaHelios Assets SubscriptionsHelios AuthorizationHelios BAASHelios Commercial OffersHelios Condition MonitoringHelios CustomerHelios CVAHelios DealerHelios Dealer Customer InformationHelios Dealers ECM ReportsHelios EquipmentHelios Equipment - deprecatedHelios Equipment HistoryHelios InspectionHelios IntegratorHelios IoT Gateway Asset Device ProvisioningHelios IoT Gateway CarriersHelios IoT Gateway CommandsHelios IoT Gateway Config FilesHelios IoT Gateway ConfigsHelios IoT Gateway Device Comm TestingHelios IoT Gateway FOTAHelios IoT Gateway HomingHelios IoT Gateway IngestionHelios IoT Gateway Passthrough ConfigsHelios IoT Gateway StreamingHelios IoT Gateway SubscriptionsHelios IoT Gateway Supplier ProvisioningHelios IoT Gateway System FlashHelios IoT Gateway Testing-CICDHelios IoT Gateway TransactionsHelios IoT Gateway VIMS SFTP User OnboardingHelios NotificationsHelios OMSHelios Planned MaintenanceHelios PreferencesHelios QR CodeHelios ReportsHelios Service RequestHelios Third Party OEM ConsumptionHelios UserHelios UtilitiesHelios VimsIAM - Azure UtilitiesIAM - B2C ServicesIAM-Development-CICDIAM-v1 - Customers - Full AccessIAM-v1 - Customers - Read OnlyIAM-v1 - Users & Groups - Full AccessIAM-v1 - Users & Groups - Read OnlyIdentifier ManagementISO 15143 API - High Quota ProductISO 15143-3 (AEMP 2.0) APIMyUsed.cat.comOcean Sailing ScheduleOcean Sailing ScheduleOEM Machine DataONE Configuration FeedOneHarvesterOperator FeedbackOther APIsParts Visibility Order StatusParts.cat.com - Address ValidationParts.cat.com - AuthenticationParts.cat.com - CartParts.cat.com - Cart ImportParts.cat.com - CategoriesParts.cat.com - DealersParts.cat.com - Dealers v2Parts.cat.com - EquipmentParts.cat.com - Equipment ListParts.cat.com - Equipment List v2Parts.cat.com - LocationsParts.cat.com - MeParts.cat.com - Order Tracking V3Parts.cat.com - ProductsParts.cat.com - QuoteOrdersParts.cat.com - SearchParts.cat.com - Shopping Cart V2Parts.cat.com - Shopping ListParts.cat.com - User RegistrationPartStore-Development-CICDPlanned MaintenancePlanned Maintenance - InternalPlanned Maintenance DevelopmentPrime Product+ Sales Lead API (PP+ Lead API)Product Link Config Tool Signing V1Product Link Config Tool Stand Alone V4Productivity Site ManagementRaw VIMS FilesRegistration ServiceRemote ServiceSCIM DealersSCIM GroupsSCIM UsersService Option Collaborator Web ServicesService Option Collaborator Web ServicesService Tool Product InterfaceSIMSi IntegrationSIS2 AsShipped BOMSIS2 Content GraphicsSIS2 Content IESIS2 DevelopmentSIS2 Graphics LocationSIS2 Media BundlesSIS2 Media StructureSIS2 Part Where UsedSIS2 Parts CompatibilitySIS2 Parts ConsistsSIS2 Product ConfigurationSIS2 Product FamiliesSIS2 Product Structure PartsSIS2 Profile PermissionsSIS2 Related PartsSIS2 SearchSIS2 Service MediaSIS2 User ProfilesSIS2 User RegistrationSiteSolutionsSolar Digital Connected FleetSolar Digital InSight Machine DataSolar Digital Insight Machine Data-Development-CICDSolar Digital Insight Machine Data-Development-CICDSolar Turbines Lube Oil Measurement SampleSolar Turbines Lube Oil Measurement SampleSolardigital Downtime SummarySolarDigital-Development-CICDsolarDigital-Development-TA3-CICDsolarDigital-Development-TA3-CICDSOS Sample OutsourcingSOS Testing-CICDSupplier DevicesSupplier DevicesTelematics ContinuityTelemetryTest ProductUCIDVimsVIMS Transmitter APIVisionLink
APIsAccount ManagementAction ItemsAEX IntegrationAftermarket Prioritized Service Event APIAftermarket Prioritized Service Event Unite APIAI TranslationsAPI Usage MetricsApplication SubscriptionsAsset Component Template ManagementAsset ComponentsAsset ConfigurationsAsset ConfigurationsAsset Details HistoryAsset Entitlements ManagementAsset Fence HistoryAsset IconAsset IntegratorAsset Management V1Asset MetadataAsset Operation FeedAsset Operation History v2Asset OperationsAsset Start ModesAsset StructureAsset StructuresAsset StructuresAsset SummaryAsset, Device and Battery Status HistoryAssetsAssets V2Authorizations Management System - AgreementsAuthorizations Management System - AuthorizationsAuthorizations Management System - ConsentsAuthorizations Management System - Consents ManagementAuthorizations Management System - Digital Authorization LinksAuthorizations Management System - DocumentsAuthorizations Management System - HostAppEntryAuthorizations Management System - Mass Email ManagementAuthorizations Management System - User AuthorizationsAzure Entra ID UtilitiesBaaSS V2Basic Daily - Diagnostic - V6Basic Daily - Fuel - V5Basic Daily - SMULOC - V6Battery AssetsBDT OperatorBDT ProductBill of MaterialsBlock Data Transfer - v2Cache ControllerCache ControllerCalculator Web - Partner APICat Card POS - CommerceCat Card POS - DealerCat Credits POS - CommerceCat Credits POS - DealerCAT Diagnostic - ModelsCAT Diagnostic ServicesCat Digital Support - CasesCat eCommerce Address ValidationCat eCommerce AuthenticationCat eCommerce calSync (Customer Authority Level) v1Cat eCommerce CategoriesCat eCommerce Categories v2Cat eCommerce Dealer ManagementCat eCommerce Dealer Management v2Cat eCommerce Equipment CatalogCat eCommerce Equipment Catalog v2Cat eCommerce Equipment ListCat eCommerce Equipment List V2Cat eCommerce GeographicCat eCommerce IntegrationCat eCommerce LocationsCat eCommerce Locations V2Cat eCommerce Marketing Data InformationCat eCommerce Me (Current User Information) V2Cat eCommerce Me (Current User Information) V3Cat eCommerce Me API (Current User Information)Cat eCommerce Order InformationCat eCommerce Order Management v2Cat eCommerce Product SearchCat eCommerce Product Search V2Cat eCommerce ProductsCat eCommerce Products V2Cat eCommerce Quote OrdersCat eCommerce Shopping CartCat eCommerce Shopping Cart v2Cat eCommerce Shopping ListCat eCommerce User RegistrationCat eCommerce User Registration V2Cat InspectCat InspectCat Integrated Procurement - ProFormasCat Integrated Procurement - ProFormasCat Integrated Procurement - Rule SequenceCat Integrated Procurement - Transaction TypesCat Integrated Procurement - VendorsCat Interact Dealer IntegrationCAT OS AssetsCAT OS CPMListCat OS FilesCAT OS HarmosCAT OS SafetyCat OS Safety V2Cat OS Safety V3Cat OS Site Device CommsCAT OS SitesCAT OS Sites V2Cat Planned Maintenance AssetsCat Planned Maintenance IntervalCat Planned Maintenance OccurrenceCat Planned Maintenance ReportsCat Wear Management SystemCat Wear Management System Cat Used APICatchall-v1Catchall-v1Caterpillar Directory Services SCIM DealersCaterpillar Directory Services SCIM GroupsCaterpillar Directory Services SCIM UsersCaterpillar Financial - CLMCaterpillar Financial - CVACCR - Plate GenerationCDID Customer AgreementsChannelsCommercial OffersCondition Monitoring - Asset Level TemplatesCondition Monitoring - Templates Provisioning & Analytics Metadata v2Condition Monitoring Asset EnrollmentCondition Monitoring V2Condition Monitoring V3ConsentsContractsCountriesCumulativesCUPA Used Equipment Valuations and PredictionsCurrency ExchangeCustomer Asset AuthorizationCustomer Asset WorkflowCustomer DetailsCustomer MasterCustomer Value AgreementsCustomer Value AgreementsCustomer Value Agreements v2Customer Value Agreements v2CyclesDealer ActionsDealer Currency ConverterDealer Customer AssetsDealer Customer LookupDealer DetailsDealer ECM Reports V1Dealer ERP Customer MasterDealer HierarchyDealer HierarchyDealer Locations Management v2Dealer Locations Management v3Dealer Locator v2Dealer Locator v3Dealer Locator v4Dealer Service RequestsDealer Service Requests V2Device CapabilitiesDevice Configuration AuditDevice RadiosDevicesDiagnostic Services - EventsDiagnostic Services - ParagraphsDiagnostic Services - PossibleCausesDiagnostic Services - ProceduresDiagnostic Services - ReportsDiagnostic Services - Service InformationsDiagnostic Services - SessionsDiagnostic Services - TablesDiagnostic Services BundlesDiagnostic Services Bundles - v2DOCS Case IntegrationDSP CatalogDSP Users v1.E-Customer RegistrationsECM Reports V2eCommerce - Customer ConfigurationeCommerce - CustomerseCommerce - Dealer ConfigurationeCommerce - Dealer SettingseCommerce - Locations SettingseCommerce - User Affiliations v1eCommerce Dealer IntegrationseCommerce UCID Management v1eCommerce User Management v1Electronic Control ModulesElectronic TechnicianEnterprise Quick EstimatorEntitlement Role ManagementEntitlementsEntry-Exit Events HistoryEquipment Processing Center Work OrdersEquipment Protection PlansExport Compliance v1Fault CodesFault CodesFaults HistoryFile APIFiltersFinance Call Center TwilioFlash Modem FirmwareFluids HistoryForesight Dealer AppForm Publishing V2Fuel LevelsGeo-fencesGeocodingGlobal Search v2Global Search v3GroupsGroupsGroupsGTOC - Domestic TransportationHelios SNR WrapperHistogramsIdentifier ManagementIdentity Access Management (IAM) - B2CIdentity Access Management (IAM) - IdentitiesIngestionInSight Machine DataInSight Machine DataInspections HistoryInstances V2Integration of Second Level Dealer(SLD) to Customer & Dealer Indicative Data(CDID) systemInvalidate CacheInvalidate CacheInvoicesIOT Asset APIsIOT AssetsISO15143 (AEMP 2.0)JoltSetting ConfigurationLead Management V2Lead Management V3LoadsLocationsLocationsLowPowerWakeUp ConfigurationManufacturer MetadataMaterialsMyUsed Equipment Data Feed v2MyUsed Equipment Import v2MyUsed Inspections v2NextGen ISO15143 (AEMP 2.0)NotesNotification SubscriptionsNotification Subscriptions v2Notification Subscriptions v3Ocean TransportationOcean TransportationOneHarvesterOperator Coaching V2Operator Management SystemOrg PreferencesOriginal Equipment ManufacturerParts Service HistoryParts Visibility Order Info Transportation ServiceParts.Cat.Com - Cart ImportParts.cat.com – Order Tracking v3Partstore - Parts AvailabilityParty Selection v1PayloadsPlanned MaintenancePlanned MaintenancePlanned Maintenance AssetsPlanned Maintenance Assets V4Planned Maintenance IntervalPlanned Maintenance Interval V4Planned Maintenance OccurrencePlanned Maintenance Occurrence V4Planned Maintenance Outage NotificationPlanned Maintenance ReportsPlanned Maintenance Status Flag V4Prioritized Service EventsProduct ConfigurationsProduct Link Config SyncProduct Link Config Tool File SignProductivity OperatorsProductivity Site ManagementProductivity UtilizationProfile IntegrationProfiles ManagementProxy Template Echo ExampleProxy Template Echo ExamplePush Notifications V1QR Code - AssociationsQR Code - AssociationsQRP Work OrderRaw VIMS FilesRDE Dealer Sales ModelsRecommendationsRecommendations V2Registration Catalog ManagementRemote Service - Flash Capability APIRemote Service - Troubleshoot Capability APIReport CommunicationsReport DownloadsReportsRestricted AssetsRetail Digital IntegrationRetail Digital Integration V2Safety LettersSegmentsService HistoryService Meter ReadingsService Meter ReadingsSessions ManagementSessions Reference ManagementShared AssetsShopping Cart History ServiceShort URLSIMSi IntegrationSIS 2.0 – SOC WrapperSIS2 - Search for Parts and Services.SIS2.0 - Lists details on Media - InformationType, Sections and IEs.SIS2.0 - Parts And Services - AsShipped Invoice.SIS2.0 - Parts And Services - Graphics Content.SIS2.0 - Parts And Services - Graphics Locations.SIS2.0 - Parts And Services - IE Content AttributeSIS2.0 - Parts And Services - MediaBundle.SIS2.0 - Parts And Services - PartIEConsistSIS2.0 - Parts And Services - PartWhereUsedSIS2.0 - Parts And Services - ProductFamily.SIS2.0 - Parts And Services - Profile Permissions.SIS2.0 - Parts And Services - Related PartsSIS2.0 - Parts And Services - Service IE where usedSIS2.0 - Parts And Services - TechDoc IE ContentSIS2.0 - Parts And Services - User Profile.SIS2.0 - Parts Compatibility.SIS2.0 - Product Configuration.SIS2.0 - productstructure - parts and outline.SIS2.0 - Service MediasSIS2.0 - User RegistrationSitesSitesSOC Web ServicesSOC Web ServicesSolar Digital Connected FleetSolar Turbines Asset Downtime SummarySolar Turbines Lube Oil Measurement SampleSolar Turbines Lube Oil Measurement SampleSOS 2.0 Sample OutsourcingStorageSubscriptionsSupplier DevicesSurface Management Design InformationSurface Management FilesSurface Management Job Site Metadata MappingSurface Management Job Site MetricsSurface Management Job Site VolumeSurface Management TilesTask ManagementTelematics MetadataTelematics Metadata v2Telematics SubscriptionsTelemetry BillingTelemetry BillingTest Data ManagementThird Party Service EventsTime SeriesTranslationsUniversal CustomersUser Action RecordsUser ActivityUser Application DataUser Entered RecordsUser IdentityUser Identity ManagementUser LeadsUser ManagementUser ManagementUser OnboardingUser Onboarding RequestsUser PermissionsUser Preferences V2User Specified Device ConfigurationUtilizationUtilization HistoryVIMSVIMS Channel GroupsVIMS Channel ThresholdsVIMS EventsVIMS FilesVIMS HistogramVIMS MetadataVIMS TimeSeriesWarranty InformationWork Orders
Apply
ISO 15143-3 (AEMP 2.0) API Developer Guide ISO 15143-3 (AEMP 2.0) API Developer Guide

Overview

More Details
3rd Party API Integrations Tool Is Available 3rd Party API Integrations Tool Is Available
Caterpillar’s Equipment Management can also ingest and visualize data from other OEM and 3rd party telematics providers through integration with their APIs. This allows you to visualize your full fleet data in a single asset management application.
More Details
Using Caterpillar GIS-Approved API Testing Tools Using Caterpillar GIS-Approved API Testing Tools

The following API testing tools are GIS-approved for use by Caterpillar developers:

More Details
ISO 15143-3 (AEMP 2.0) API
/apis/products/prod/iso-15143-3-aemp-20-api