Warranty Claims SOAP API

  • Freigeben Version: Australia
  • Aktualisiert 13. März 2026
  • 9 Minuten Lesedauer
  • The Warranty Claims SOAP API handles incoming repair orders from dealer systems and converts them into warranty claims within the Oracle Enterprise Manager (OEM)’s platform.

    This API follows SOAP 1.1 conventions and uses STAR XML schemas to ensure interoperability across automotive service systems. The API supports the following high-level use cases:

    This API enables the exchange of warranty and repair claim information between ServiceNow Manufacturing Connected Operations (MCO) and a Dealer Management System (DMS). Specifically, it allows users to:
    • Create and validate warranty claims in the DMS directly from ServiceNow MCO.
    • Query the status of submitted claims, including adjudication and approval outcomes, and retrieve those results back into ServiceNow.
    • Manage repair claim data across three core MCO tables:
      • Repair Claim Case [sn_repair_claim_mgmt_case]
      • Repair Claim Case Line [sn_repair_claim_mgmt_case_line]
      • Repair Claim Case Line Charge [sn_repair_claim_mgmt_case_line_charge]
    • Support STAR XML message formats through configuration‑driven adapters, enabling standards‑based integrations without custom code.

    This documentation is intended for developers, system integrators, and partners implementing a standards-based SOAP integration.

    Standards and conventions

    The API adheres to widely used, publicly documented standards:

    Item Standard
    SOAP Version SOAP 1.1 (default); 1.2 supported for select partners
    WSDL WSDL 1.1
    XML Schema XSD 1.0 (STAR XML)
    STAR Schema Version 5.13.4
    Character Encoding UTF-8
    Message Format text/xml
    Protocols HTTPS over TLS 1.2+; optional Mutual TLS for STAR partners

    Access and authentication

    • Basic Auth (username/password)
    • Configurable per endpoint for every DMS

    Granular roles and entities

    This SOAP API requires granular roles to access certain MCO features and responsibilities, provide CRU permissions without custom ACLs, and map directly to supported entities. Please see Granular roles and entities for information about supported granular roles.

    Endpoint details

    The Warranty Claims SOAP API is exposed as a scripted SOAP web service in ServiceNow MCO.

    https://<instance_name>.service-now.com/sn_mco_integ_RepairClaimSOAPHandler.do?SOAP

    WSDL:

    https://<instance_name>.service-now.com/sn_mco_integ_RepairClaimSOAPHandler.do?WSDL

    The instance name is fixed per OEM environment (sandbox, test, production).

    URL part Description
    <instance_name> The ServiceNow instance hosting MCO (OEM‑specific, fixed per OEM)
    sn_mco_integ_ MCO integration namespace
    RepairClaimSOAPHandler.do Scripted SOAP Web Service entry point
    ?SOAP SOAP invocation
    ?WSDL WSDL contract for client generation

    API operation

    Operation Name: ProcessRepairOrder

    Processes a repair order payload. The operation performs either a create or update action depending on whether a matching business identifier already exists.

    This operation:
    • Validates the request against the STAR schema
    • Validates that values in XML are valid in MCO
    • Determines whether the repair claim (document ID) already exists
    • Creates a new record if no match is found
    • Updates an existing record if a match is found
    • Returns a processing status and reference identifier

    Request structure

    The request body contains a STAR-compliant ProcessRepairOrder message wrapped in a SOAP envelope. Key logical elements include:
    • Application metadata (sender, creation time, destination)
    • Process verb indicating the requested action
    • Repair order header information
    • Vehicle details
    • Job, labor, parts, and pricing details
    • Warranty claim information

    All elements must conform to the STAR XML schema version indicated in the payload.

    Request parameters

    Tabelle : 1. Inbound request parameters
    Name Label Type Required Description
    Activity status activity_status Choice Yes Indicates the current lifecycle status of the repair claim case line and drives playbook execution.

    Table: Repair Claim Case Line [sn_repair_claim_mgmt_case_line]

    Valid values:
    • Claim details completed [claim_details_completed]
    • Claim jobs completed [claim_jobs_completed]
    • Claim under review completed [claim_under_review_completed]
    • Claim job edit completed [claim_job_edit_completed]
    • Claim summary completed [claim_summary_completed]
    • Close case completed [close_case_completed]
    Actual end actual_end DateTime No Date and time when the repair activity was completed.

    Format: YYYY-MM-DDThh:mm:ss

    Actual start actual_start DateTime No Date and time when the repair activity started.

    Format: YYYY-MM-DDThh:mm:ss

    Asset asset Reference Yes Serial number or asset tag of the claim.

    Table: Asset [alm_asset]

    Causal part product_model Reference Yes Model number of the part identified as the root cause of the issue.

    Table: Product model [cmdb_model]

    Claimed amount claimed_amount Currency No Claimed cost amount for this specific repair claim case line.
    Consumer consumer Reference No Consumer or vehicle owner. If consumer ID is unavailable, phone number or email may be provided.

    Table: Consumer [csm_consumer]

    Correlation ID correlation_id String No External correlation identifier used to link this request with upstream or downstream systems.
    Dealer requesting_service_organization Reference Yes Reference to the service organization (dealer) submitting the request.

    Internally resolves to a Service Organization [sn_customer_service_organization] record, matched by Number.

    Deductible amount deductible_amount Currency No Deductible amount applicable to the repair claim.
    External Repair order number external_ro_number String Yes Repair order number from the external dealer or service system.
    Fault code fault_code String No Fault or diagnostic code associated with the reported issue.
    Install base install_base Reference No Identifies the product or asset being serviced and is resolved by matching the provided value to an existing Install Base Item in ServiceNow.

    Table: Install base [sn_install_base_item]

    Valid values:
    • asset number
    • serial number
    • name
    Part in warranty in_warranty Boolean Yes Flag that indicates whether the affected part is under warranty.
    Valid values:
    • true: Affected part is under warranty.
    • false: Affected part isn't under warranty.
    Vehicle in warranty vehicle_in_warranty Boolean Yes Flag that indicates whether the vehicle is under warranty.
    Valid values:
    • true: Vehicle is under warranty.
    • false: Vehicle isn't under warranty.
    Issue Description short_description String Yes Brief summary of the issue.
    Parent task parent_task Reference Yes Identifier of an existing parent repair claim case or parent task associated with the request.

    Table: Task [task]

    Pre-auth case line pre_auth_case_line Reference No Corresponding pre‑authorization repair request, if applicable.

    Table: Pre‑Auth Repair Request Job [sn_pre_auth_repair_request_job], Field: Number

    Product Usage product_usage Decimal Yes Usage reading of the vehicle at time of repair (for example, kilometers or miles driven).
    Quantity quantity Integer Yes Number of affected or replaced parts.
    Repair action repair_action Choice Yes Action performed to resolve the issue.
    Valid values:
    • Repair [REPAIR]
    • Replacement [REPLACEMENT]
    • Software update [SOFTWARE_UPDATE]
    Repair Claim case parent_case Reference Yes Repair claim case associated with this case line.

    Table: Customer case [sn_customerservice_case]

    Repair Details details Translated HTML Yes Detailed description of the issue, diagnostics, and repair performed.
    Replacement part replacement_part Reference Conditional If repair_action = replacement, specifies the name or model number of the replaced part.

    Table: Product model [cmdb_model]/Name/Model Number

    Reported date reported_date DateTime Yes Date and time the vehicle arrived at the dealer or service center.

    Format: YYYY-MM-DDThh:mm:ss

    Source source String No Originating system or channel that submitted the repair claim request.
    Submitted submitted_at DateTime Yes Date and time the claim was submitted.

    Format: YYYY-MM-DDThh:mm:ss

    Total claimed amount total_claimed_amount Currency Yes Total claimed amount for the entire repair claim case.
    Type type Choice Yes Type of claim being submitted.
    Valid values:
    • Warranty [Warranty]
    • Goodwill [Goodwill]
    • Service contract [Servicecontract]
    Unit of measure unit_of_measure Reference Yes Unit of measurement for the product usage. For example, kms or miles.

    Table: Unit of Measure [sn_prd_pm_uom]

    Work notes work_notes String No Internal notes or comments related to claim processing.

    Example SOAP request

    Hinweis:
    Namespaces used in examples follow standard SOAP and STAR conventions.
    <?xml version="1.0" encoding="UTF-8"?>
    <soap:Envelope
        xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:oagis="http://www.openapplications.org/oagis/9"
        xmlns:star="http://www.starstandard.org/STAR/5"
        xmlns:tran="http://www.starstandards.org/webservices/2009/transport"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
        <soap:Header>
            <!-- Optional header -->
            <tran:payloadManifest>
                <tran:manifest
                    contentID="A0"
                    element="ProcessRepairOrder"
                    namespaceURI="http://www.starstandard.org/STAR/5"
                    version="5.13.4.0.0" />
            </tran:payloadManifest>
        </soap:Header>
    
        <soap:Body>
            <ProcessRepairOrder xmlns="http://www.service-now.com/ProcessRepairOrder">
                <payload>
                    <![CDATA[
    <star:ProcessRepairOrder
        xmlns:star="http://www.starstandard.org/STAR/5"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        releaseID="5.13.4.0.0"
        systemEnvironmentCode="Production">
    
        <!-- APPLICATION AREA -->
        <star:ApplicationArea>
            <star:Sender>
                <star:CreatorNameCode>DealerManagementSystem</star:CreatorNameCode>
                <star:SenderNameCode>DEALER001</star:SenderNameCode>
                <star:URI>https://dealer-system.example.com</star:URI>
                <star:DealerNumberID>98765</star:DealerNumberID>
                <star:StoreNumber>ST-001</star:StoreNumber>
                <star:AreaNumber>REGION-01</star:AreaNumber>
                <star:DealerCountryCode>US</star:DealerCountryCode>
                <star:LanguageCode>en-US</star:LanguageCode>
                <star:SystemVersion>DMS_v6.1.0</star:SystemVersion>
            </star:Sender>
    
            <star:CreationDateTime>2026-01-09T14:30:45</star:CreationDateTime>
            <star:BODID>a1b2c3d4-e5f6-7890-abcd-ef1234567890</star:BODID>
    
            <star:Destination>
                <star:DestinationNameCode>OEM_MANUFACTURER</star:DestinationNameCode>
            </star:Destination>
        </star:ApplicationArea>
    
        <!-- DATA AREA -->
        <star:ProcessRepairOrderDataArea>
            <star:Process>
                <star:ActionCode>ADD</star:ActionCode>
            </star:Process>
    
            <star:RepairOrder>
                <star:RepairOrderHeader>
                    <star:DocumentIdentificationGroup>
                        <star:DocumentIdentification>
                            <star:DocumentID>RO-2026-987654qwert</star:DocumentID>
                        </star:DocumentIdentification>
                    </star:DocumentIdentificationGroup>
    
    Example SOAP Response (Success)
    <?xml version="1.0" encoding="UTF-8"?>
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
      <SOAP-ENV:Body>
        <ProcessRepairOrderResponse>
          <status>success</status>
          <message>Repair order processed successfully</message>
          <data>{"reference":"RPC0001005"}</data>
        </ProcessRepairOrderResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
    Example SOAP Response (Validation Error)
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
      <SOAP-ENV:Body>
        <ProcessRepairOrderResponse>
          <status>error</status>
          <message>
            VALIDATION ERRORS
            payload="[{\"field\":\"asset\",\"message\":\"Reference value not found\"}]"
          </message>
        </ProcessRepairOrderResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    

    Error handling

    The API uses standard SOAP and HTTP mechanisms to report errors like SOAP faults, custom business errors, and HTTP status codes.

    SOAP faults are returned when the request can't be parsed or processed at the protocol level, such as when:
    • XML is malformed
    • Namespace is incorrect
    • Required SOAP envelope structure missing
    • Authentication failure
    • System-level processing error
    Example SOAP Fault:
    <soap:Fault>
      <faultcode>soap:Client</faultcode>
      <faultstring>Invalid SOAP message</faultstring>
    </soap:Fault>
    

    Custom business errors

    Business validation errors occur after successful SOAP parsing and indicate issues with request data, such as:
    • Missing or invalid references
    • Duplicate repair orders
    • Invalid code values
    • Schema or version mismatches
    These occur after successful SOAP parsing but during business validation. Errors are returned in the operation response with a status of error and a descriptive message. For example:
    • MANDATORY_FIELD_MISSING
    • MIN_VALUE MAX_VALUE INVALID_REFERENCE
    • UNSUPPORTED_VALIDATION_TYPE
    • SOAP_ENVELOPE_EMPTY
    • IN_WARRANTY_TRANSFORM_FAILED
    • VALIDATION_ERRORS
    • INVOKE_PROCESSOR_FAILED
    • INVALID_DATE_FORMAT
    • INVALID_DATE_VALUE
    • INVALID_DATETIME_FORMAT
    • XML_TO_JSON_FAILED
    • INVALID_DATETIME_VALUE
    • PAYLOAD_PARSING_FAILED
    • EMPTY_PARSED_PAYLOAD
    • INVALID_TRANSLATED_HTML_TYPE
    • MAX_LENGTH_EXCEEDED
    • MAIN_PART_MISSING
    • MULTIPLE_MAIN_PARTS
    Sample error code:
    <ProcessRepairOrderResponse> 
    <status>error</status> 
    <message>VALIDATION ERRORS | payload="[{\"field\":\"asset\",\"message\":\"Reference value not found\"}]"</message> 
    </ProcessRepairOrderResponse> 
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

    HTTP Status Codes

    HTTP Code Meaning Description
    200 OK Request processed successfully
    400 Bad Request Invalid or malformed request
    401 Unauthorized Authentication failure
    403 Forbidden Access not permitted
    500 Internal Server Error Unexpected processing failure

    Outbound STAR Integration

    This outbound integration sends claim adjudication and payment results from the OEM Now ServiceNow instance to a Dealer Management System (DMS) using STAR‑compliant XML messages.

    The integration is triggered by a ServiceNow Business Rule on the Repair Claim Case table (sn_repair_claim_mgmt_case) when:
    • The claim source is DMS, and
    • The claim state is one of the following:
      • Approved
      • Partially Approved
      • Rejected
      • Awaiting Information
    Tabelle : 2. Outbound parameters
    Name Label Type Required Description
    Approved amount approved_amount Currency Yes Approved amount for this specific repair claim case line after adjudication.
    Correlation ID correlation_id String Yes Unique identifier used to correlate the outbound response with the original inbound repair claim request.
    External repair order number external_ro_number String Yes External repair order number associated with the Repair Claim case, as provided by the dealer system.
    Dealer ID dealer_number String Yes Unique identifier of the dealer or service organization that submitted the repair claim.
    Review action review_action Choice Yes Action took by the claims agent during the claim review.
    Possible values:
    • Approve all [approve_all]
    • Reject all [reject_all]
    • Partially approved [partially_approved]
    • Send back [send_back]
    Review comments review_comments Translated Text No Comments entered by the claims agent during the review and adjudication process.
    Service organization service_organization String Yes Name of the dealer or service organization associated with the repair claim.
    State state Choice Yes Overall adjudication state of the Repair Claim case at the time of response.
    Possible values:
    • Draft [0]
    • New [1]
    • Open [2]
    • Pending review [5]
    • Awaiting info [6]
    • Approved [8]
    • Partially approved [9]
    • Rejected [10]
    • Closed complete [3]
    • Closed incomplete [7]
    • Closed cancelled [4]
    Total approved amount total_approved_amount Currency Yes Total approved amount for the entire Repair Claim case, aggregated across all case lines.
    Tabelle : 3. Claim Status Mapping
    STAR status code Decision indicator
    AWAITING_INFO 6 R (Rejected)
    APPROVED 8 A (Approved)
    PARTIALLY_APROVED 9 A (Approved)
    REJECTED 10 D (Denied)
    When these conditions are met, ServiceNow generates and sends a STAR ProcessServiceProcessingAdvisory message to the DMS. The outbound STAR message communicates claim adjudication outcomes, not claim submission data. It includes:
    • The repair order or claim reference
    • Overall claim status
    • Total payable or approved amounts
    • Approved amounts at the individual job or operation level

    The message conforms to the STAR ProcessServiceProcessingAdvisory structure and enables the DMS to synchronize claim status and financial reconciliation data.

    Outbound sample payload:
    <ns:ProcessServiceProcessingAdvisory
        xmlns:ns="http://www.starstandard.org/STAR/5"
        xmlns:ns1="http://www.openapplications.org/oagis/9"
        languageCode="en-US"
        releaseID="1.0"
        systemEnvironmentCode="Production"
        versionID="1.0">
        <ns:ApplicationArea>
            <ns:Sender>
                <ns:CreatorNameCode>Beta Consulting Group Orlando</ns:CreatorNameCode>
                <ns:SenderNameCode>DLR0001001</ns:SenderNameCode>
            </ns:Sender>
            <ns:CreationDateTime>2026-02-26T11:54:25</ns:CreationDateTime>
            <ns:Destination />
        </ns:ApplicationArea>
        <ns:ProcessServiceProcessingAdvisoryDataArea>
            <ns:Process />
            <ns:ServiceProcessingAdvisory>
                <ns:ServiceProcessingAdvisoryHeader>
                    <ns:DocumentIdentificationGroup>
                        <ns:DocumentIdentification>
                            <ns:DocumentID>RO-2026-987654qwe1111</ns:DocumentID>
                        </ns:DocumentIdentification>
                    </ns:DocumentIdentificationGroup>
                    <ns:Payments>
                        <ns:RepairOrderReconciliation>
                            <ns:WarrantyClaimReconciliation>
                                <ns:ToBePaidAmount currencyID="INR">342744.29</ns:ToBePaidAmount>
                                <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                                <ns:WarrantyNotes />
                                <ns:DispositionReason>
                                    <ns:DispositionReasonCode />
                                </ns:DispositionReason>
                            </ns:WarrantyClaimReconciliation>
                            <ns:JobReconciliation>
                                <ns:ApprovedAmount currencyID="INR">342744.29</ns:ApprovedAmount>
                                <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                                <ns:OperationID>DIAG-ENG-01A1A1</ns:OperationID>
                            </ns:JobReconciliation>
                            <ns:JobReconciliation>
                                <ns:ApprovedAmount currencyID="INR">0.00</ns:ApprovedAmount>
                                <ns:ClaimStatusCode>Pending review</ns:ClaimStatusCode>
                                <ns:OperationID>DIAG-ENG-011</ns:OperationID>
                            </ns:JobReconciliation>
                        </ns:RepairOrderReconciliation>
                    </ns:Payments>
                </ns:ServiceProcessingAdvisoryHeader>
            </ns:ServiceProcessingAdvisory>
        </ns:ProcessServiceProcessingAdvisoryDataArea>
    </ns:ProcessServiceProcessingAdvisory>

    Logging and diagnostics

    Requests and responses are logged by the service for diagnostic and troubleshooting purposes in accordance with standard ServiceNow operational practices.

    Related specifications

    • STAR XML Specifications
    • SOAP 1.1 Specification
    • WSDL 1.1 Specification

    Refer to the official STAR and W3C documentation for detailed schema and protocol definitions.