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 Usage MetricsApigee Cache InvalidationAsset ConfigurationsAuthorization Management SystemBasic DailyCat Calculator Web - Partner APICat Calculator Web - Quick EstimatorCat Certified RebuildCat Digital Entitlements Role ManagementCat Digital Marketplace Testing - internalCat Digital Marketplace Testing4 - internalCat Digital Marketplace Testing7 - cws group and internalCat Digital Retail Mobile API ServiceCat Foresight RecommendationCat InspectCat InteractCAT QRCat Wear Management SystemCat Wear Management System Used InspectcatDiagnosticServices-DevelopmentCCDS Asset Start ModesCCDS Asset StructuresCCDS Dealer Action ItemsCCDS Device Reg DevelopmentCCDS Devices and ECMsCCDS GroupsCCDS Groups v2CCDS SubscriptionsCDID-DevelopmentCore TelematicsCRMI CasesCRMI ECRM Accounts and OpportunitiesCRMI FilesCUPA Used Equipment Valuations and PredictionsCustomer Value Agreements (CVAs)Dealer ERP Customer MasterDealer Location ServicesDealer Service Portal BillingDealer Service Portal SubscriptionsDealer Service Portal User RolesDealerLocator-DevelopmentDiagnostic Services BundlesDiagnostic Services ReportsDiagnosticServices - SessionsDigitalCatCom Test 1e Commerce DealerIntegrationseCommerce Customer DetailseCommerce CustomerseCommerce Parts AvailabilityeCommerce UCID Management v1eCommerce User AffiliationsEquipment Processing Center Work OrdersFinance CLMFinance CVAFinance: Currency DataFleet Assessment ServicesFPD Call CenterFPD POS - InternalFPD POS Cat CardFPD POS Cat CreditsFPD-POS-Development-CICDHelios Customer MasterHelios Dealers ECM ReportsHelios ECM ReportsHelios EquipmentHelios IngestionHelios InternalHelios 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 Device MigrationHelios 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 OnboardingIAM - B2C ServicesIAM-Development-CICDIAM-v1 - Customers - Full AccessIAM-v1 - Customers - Read OnlyIAM-v1 - Users & Groups - Full AccessIAM-v1 - Users & Groups - Read OnlyIdentifier ManagementISO 15143-3 (AEMP 2.0) APIISO 15143-3 API (Field Follow)MyUsed.cat.comOcean Sailing ScheduleOEM Machine DataOneHarvesterOther APIsParts.cat.com - Address ValidationParts.cat.com - AuthenticationParts.cat.com - CartParts.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 - MarketingParts.cat.com - MeParts.cat.com - Order Tracking V3Parts.cat.com - OrderManagement v2Parts.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 MaintenancePlanned Maintenance TeamPrime Product+ Sales Lead API (PP+ Lead API)Product Link Config Tool Signing V1Product Link Config Tool Stand Alone V4Productivity Site ManagementRaw VIMS FilesRegistration ServiceRemote ServiceRemoteServices-Development-CICDRetailDigitalEnablement-Development-CICDSalesforce CatUsed Inspection ReportSCIMSCIM DealersSCIM GroupsSCIM UsersSecond Level DealersSecondary Dealer InfoService Option Collaborator Web ServicesService Tool Product InterfaceServiceDataStandards-Development-CICDSIS2 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 Service Where UsedSIS2 User ProfilesSIS2 User RegistrationSiteSolutionsSolar Digital Insight Machine Data-Development-CICDsolarDigital-Development-CICDSolarDigital-TA3-Development-CICDSOS Sample Barcode ReservationSOS Sample InterpretationsSupplier DevicesTelematics ContinuityTelematics Fault Code DescTelemetryTest Product - APIUser OnboardingVisionLink
APIsAccount ManagementAccuWeatherAction ItemsAftermarket Prioritized Service Event APIAftermarket Prioritized Service Event Unite APIAPI Cat check non APIGEE API Product- ModifyAPI Usage MetricsApplication LoggingApplication SubscriptionsAsset Component Template ManagementAsset ComponentsAsset ConfigurationsAsset ConfigurationsAsset Details HistoryAsset Device ConfigurationAsset Entitlements ManagementAsset Fence HistoryAsset IconAsset IntegratorAsset MetadataAsset Operation HistoryAsset Operation History v2Asset OperationsAsset Start ModesAsset StructureAsset StructuresAsset SummaryAsset, Device and Battery Status HistoryAssetsAssets V2Authorizations Management System - AgreementsAuthorizations Management System - AuthorizationsAuthorizations Management System - ConsentsBasic Daily - Diagnostic - V6Basic Daily - Fuel - V5Basic Daily - SMULOC - V6Cache ControllerCalculator Web - Partner APICalculator Web Partner V2Carrier Management Communication LayerCat Card POS - CommerceCat Card POS - DealerCat Content DeliveryCat Credits POS - CommerceCat Credits POS - DealerCAT Diagnostic - ModelsCAT Diagnostic ServicesCat Digital Support - CasesCat eCommerce Address ValidationCat eCommerce AuthenticationCat eCommerce CategoriesCat eCommerce Categories v2Cat eCommerce Dealer ManagementCat eCommerce Dealer Management v2Cat eCommerce Equipment CatalogCat eCommerce Equipment ListCat eCommerce Equipment List V2Cat eCommerce GeographicCat eCommerce LocationsCat 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 Interact Dealer IntegrationCAT Management APICAT OS AssetsCAT OS CPMListCat OS FilesCAT OS HarmosCAT OS SafetyCAT OS Safety V2Cat OS Site Device CommsCAT OS SitesCat Planned Maintenance AssetsCat Planned Maintenance IntervalCat Planned Maintenance OccurrenceCat Planned Maintenance ReportsCat Wear Management SystemCat Wear Management System Cat Used APICatchall-v1Caterpillar Directory Services SCIM DealersCaterpillar Directory Services SCIM GroupsCaterpillar Directory Services SCIM UsersCaterpillar Financial - CLMCaterpillar Financial - CVACatUsed Inspection ReportCCR - Plate GenerationCDID Customer AgreementsChannel ConfigurationsChannel MetadataClient Credental v1Client Entitlements ManagementCommand SnapshotCommercial OffersCondition Monitoring - Asset Level TemplatesCondition Monitoring - Templates Provisioning & Analytics Metadata v2Condition Monitoring Asset EnrollmentCondition Monitoring V2Condition Monitoring V3Config CapabilityConfiguration FilesConfiguration Files LibraryConfiguration Files LibraryCountriesCRMI-Heroku-Developers-enterpriseCRM-AccountsCRMI-Heroku-Developers-enterpriseCRM-OpportunitiesCUPA Used Equipment Valuations and PredictionsCurrency ExchangeCustomer Asset AuthorizationCustomer Asset WorkflowCustomer Data QualityCustomer DetailsCustomer MasterCustomer Value AgreementsCustomer Value Agreements v2Dealer ActionsDealer API Usage MetricsDealer Contact DataDealer Currency ConverterDealer Customer AssetsDealer Customer LookupDealer DataDealer DetailsDealer ECM Reports V1Dealer ERP Customer MasterDealer HierarchyDealer HierarchyDealer Locations Management v2Dealer Locations Management v3Dealer Locator v2Dealer Locator v3Dealer ManagementDealer Service RequestsDevice CapabilitiesDevice CommandsDevice Configuration AuditDevice ConfigurationsDevice MigrationDevice RadiosDevice Wakeups and Connectivity Checks v2DevicesDevicesDiagnostic Services - EventsDiagnostic Services - ParagraphsDiagnostic Services - ProceduresDiagnostic Services - ReasonerDiagnostic Services - ReportsDiagnostic Services - Service InformationsDiagnostic Services - SessionsDiagnostic Services - TablesDiagnostic Services BundlesDiagnostic Services Bundles - v2Disable Fault Code ConfigurationsDSP SubscriptionsDSP Users v1.E-Customer Governance InstaPollE-Customer RegistrationsECM Reports V2ECMseCommerce - CustomerseCommerce - Dealer SettingseCommerce - Locations SettingseCommerce - SIS Customer Details v2eCommerce - User Affiliations v1eCommerce Dealer IntegrationseCommerce UCID Management v1eCommerce User Management v1Electronic TechnicianEnterprise Quick EstimatorEntitlement Catalog ManagementEntitlement Data Domain ManagementEntitlement Role ManagementEntitlement Service CatalogEntitlementsEntry-Exit Events HistoryEquipment Processing Center Work OrdersEquipment Protection PlansExport Compliance v1External Application User ProvisioningFault Code DescriptionsFault CodesFault CodesFaults HistoryFile APIFile Type ConfigurationFiltersFinance Call Center TwilioFinance: Currency DataFlash CommandsFlash LogFlash Modem FirmwareFleet Assessments ServicesFleet Management GraphQLFluids HistoryForesight Dealer AppFuel LevelsFuelsGeo-Fence ConfigurationsGeo-fencesGeocodingGlobal Search v2Global Search v3GroupsGroupsGroupsHomingIdentifier ManagementIdentity Access Management (IAM) - B2CIdentity Access Management (IAM) - IdentitiesIngestionInSight Machine DataInspections HistoryInstances V2Integration of Second Level Dealer(SLD) to Customer & Dealer Indicative Data(CDID) systemInvalidate CacheIOT Asset APIsIOT AssetsIOT Harvester AssetsISO15143 (AEMP 2.0)JoltSetting ConfigurationLanguage IdentifierLast Message TransmissionLead Management V2LocationsLocationsLocator CommandsLowPowerWakeUp ConfigurationMaintenance Mode ConfigurationsManufacturer MetadataMass FOTA (Flash Over The Air) Campaign File SubmissionMessage ParserMessages & Files IngestionMeter Value ConfigurationModified new sample apiModified sample test apiMyUsed Equipment Data Feed v2MyUsed Equipment Import v2MyUsed Inspections v2NextGen ISO15143 (AEMP 2.0)NonApigeeRegressionCheck02May2024NotesNotification SubscriptionsNotification Subscriptions v2Notification Subscriptions v3Ocean TransportationOneHarvesterOrg PreferencesOrganizations V2Original Equipment ManufacturerParts Service HistoryParts.Cat.Com - Cart ImportParts.cat.com – Order Tracking v3Partstore - Parts AvailabilityPing CommandsPing Config APIPipeline Metadata and Executions for PLM Application UIPlanned MaintenancePlanned Maintenance AssetsPlanned Maintenance Assets V4Planned Maintenance IntervalPlanned Maintenance Interval V4Planned Maintenance OccurrencePlanned Maintenance Occurrence V4Planned Maintenance Outage NotificationPlanned Maintenance ReportsPlanned Maintenance Status Flag V4Preferred Network and OTASPProduct ConfigurationsProduct Link Config SyncProduct Link Config Tool File SignProductivity Site ManagementProductivity UtilizationProfile IntegrationProfiles ManagementProxy Template Echo ExamplePush Notifications V1QR Code - AssociationsQR Code - AssociationsQR Code AssociationsQRP Work OrderRadiosRaw VIMS FilesRDE Dealer Sales ModelsReboot CommandsRecommendationsRecommendations V2Registration Catalog ManagementRemote FlashRemote Service - Flash Capability APIRemote Service - Troubleshoot Capability APIReport CommunicationsReport DownloadsReportsRestricted AssetsRetail Digital IntegrationRetail Digital Integration V2Role ManagementSaber RekeySafety LettersService HistoryService Meter ReadingsService Meter ReadingsSessions ManagementShared AssetsShipping DetailsShopping Cart History ServiceShort CommandsShort Message Request ConfigurationsShort URLSIS2 - Search for Parts and Services.SIS2.0 - Lists details on Media - InformationType, Sections and IEs.SIS2.0 - Part History V3SIS2.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 RegistrationSitesSOC Web ServicesSolar Digital Connected Fleet APISolar Turbines Lube Oil Measurement SampleSOS 2.0 Sample InterpretationStorageSubscription ConfigSubscription Configuration V2SubscriptionsSubscriptionsSupplier DevicesSupplier Track SensorsSupportSurface Management Design InformationSurface Management Elevation DifferenceSurface Management FilesSurface Management Job Site Metadata MappingSurface Management Job Site MetricsSurface Management Job Site VolumeSurface Management Surface TilesSurface Management Tag File IngestionSwitch ConfigurationTask ManagementTelematics MetadataTelematics SubscriptionsTelemetry BillingTest API All visibility check remove publicTest Data ManagementTest july 17Test Non APigee API _ 2808 (Updated)Third Party IntegratorTokensTrack WearsTransaction MetadataTransfer Override ConfigurationsTranslationsUser ActivityUser Application DataUser Entered RecordsUser IdentityUser Identity ManagementUser ManagementUser OnboardingUser Preferences V2User Specified Device ConfigurationUtilizationUtilization HistoryVIMS Channel GroupsVIMS Channel ThresholdsVIMS EventsVIMS FilesVIMS HistogramVIMS MetadataVIMS SFTP UserVIMS TimeSeriesWarranty InformationWiFi Configuration
Apply
Art05065Art05065Modified

testtest modifiedArt05065

More Details
Art05064

test

More Details
Art05064

test

More Details
PP+ Lead API V2 Developer Guide

The PP+ Lead API V2 enables dealer access to the leads generated in the Caterpillar marketing ecosystem.

More Details
asdf Art294

QR Code Associations API Developer Guide

Overview

More Details
Testing Image Testing for the Articles 01032024

Testing

More Details
Test Article - Karthik

Text description . 

More Details
testing

QR Code Associations API Developer Guide

Overview

More Details
Testing Image# QR Code Associations API Developer Guide ## Overview The QR Code Associations API provides the functionality to retrieve asset information based on the QR code assigned to an asset. **Important!** QR code associations are created by Caterpillar. Non-Caterpillar users (for example, dealers) can use the API to retrieve the asset information that can then be consumed by their applications. ## Workflow Each manufactured machine is assigned a QR code. The QR code is associated with the basic Testing 20022024

QR Code Associations API Developer Guide

Overview

testing20022024

More Details
sdvsdv asafdvsdebfd

df bdf b

More Details
Testing Image Testing for the Articles 04012024

ISO 15143-4 (AEMP 2.0) API Access Guide

ISO 15143-3 (AEMP 2.0) API

More Details
Testing Testing purpose for Create Articles 
{
  "faults": [
    {
      "equipmentHeader": {
        "make": "CAT",
        "model": "368B",
        "serialNumber": "FA12345L-2D",
More Details
Viewing 1 - 12 of 67
121824
CAT QR
/apis/products/qa/cat-qr