Versions Compared

Version Old Version 7 New Version 8
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.4.0

A pass-through API to Claims (when configured) which allows the Claims' "Part Update Order" API to be called.     


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to Claims "Parts UpdateOrder" API

POST /up/v5/parts/updateOrder

Include Page
_Default HTTP Headers
_Default HTTP Headers

Enablements

To enable this feature, the tenant's sysconfig needs to be updated:

Code Block
languagejs
{
    "Providers": {
        "Claims": {
            "Features": {
                "queryEntitlement": {
                    "Endpoint": "services/product/v1/checkentitlement"
                },
                "queryCustomerApptInfo": {
                    "Endpoint": "services/customer/v2/newcallnumber"
                },
                "updatePartsOrder": {
                    "Endpoint": "services/part/v1/updateorder"
                }
            },

            "UserId": "CASEYSHSAP",
            "Password": "--Redacted--",
            "ManufacturerNumber": "S900"
        },
    }
}

API Specifics


Panel
borderColor#D3D3D3

Pass Through Call to Claims "Parts UpdateOrder" API

This RESTified API will perform a pass-through call to the Claims sub-system's "Part Update Order" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/claims

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceDispatch "Submit ClaimUpdate Order" APi.

SubmitClaim Object

Parts Update Object Format

Code Block
languagejs
{
    "ClaimsCallNumber": "0007084-97757435",
[    "OrderSequence": 0,
   { "Parts": [
        {
 "RequiredParts": [          "PartNumber": "285442",
     {       "PartSequence": 0,
            "ProdNumOrderDate": "PARTNUM120231114",
            "Status": "Shipping",
      "Qty": 1,        "BackorderQuantity": 1,
            "ProdAttrsBackorderDate": {"20231117",
                        "Desc": "PART DESC 1",
                        "SchematicLocation": "SL",
                        "InvoiceNumber": "INVNUMBER1",
                        "UnitCost": 12.15,
                        "Returned": "N",
                        "DistributorNumber": "PRTDIST1",
                        "FaultCode": "FC1",
                        "JobCode": "JC1"
                    }
                },
				// ...
            ],
            "Asset": {
                "MfgId": "DEMO",
                "Mfg": "SONY",
                "Model": "NHT915AUC",
                "SerialNum": "SERIAL",
                "PurchaseDate": 20101001
            },
            "Booking": {
                "ServiceOrgInfo": {
                    "ServiceOrg": "11154",
                    "LocationId": "",
                    "Name": "LOCNAME"
                }
            },
            "Location": {
                "Type": "",
                "Address": {
                    "AddrLine1": "SOME STREET",
                    "AddrLine2": "APT B",
                    "City": "COSTA MESA",
                    "Region": "CA",
                    "Country": "USA",
                    "PostalCode": "92626"
                },
                "Contacts": [
                    {
                        "FirstName": "JANE",
                        "LastName": "FLOUNDER",
                        "ContactPoint": [
                            {
                                "Mode": "Phone",
                                "Value": 7145551000
                            },
                            {
                                "Mode": "Email",
                                "Value": "JANEF@HOTMAIL.COM"
                            }
                        ]
                    }
                ]
            },
            "ClaimNumber": "XYZ1SD422F_",
            "DistributorNumber": "DISTNBR",
            "DemographicCode": "",
            "EiaDefectOrComplaintCode": "DFC",
            "DefectOrComplaintDescription": "DEFECT DESCRIPTION",
            "ServicePerformedDescription": "SERVICE PERFORMANCE DESCRIPTION",
            "EiaRepairCode1": "RC1",
            "EiaRepairCode2": "RC2",
            "EiaRepairCode3": "RC3",
            "EiaRepairCode4": "RC4",
            "LaborSchematicLocation1": "SL1",
            "LaborSchematicLocation2": "SL2",
            "LaborSchematicLocation3": "SL3",
            "LaborSchematicLocation4": "SL4",
            "LaborSchematicLocation5": "SL5",
            "LaborSchematicLocation6": "SL6",
            "ReworkNumberOrPolicy": "RWNUMB",
            "WarrantyType": 1,
            "SoftwareVersion": "V1",
            "RepairCategory": "RC",
            "StockRepairFlag": "F",
            "Type": "CT",
            "ExistingClaimBatchNumber": 0,
            "ExistingClaimSequenceNumber": 0,
            "ProductSalesReceipt": "Y",
            "GlAccountNumber": "GLACCTNB",
            "ValidationFlag": "Y",
            "DebitNumber": "DEBIT",
            "KeypunchOperator": "KEYP",
            "DateReceived": 20181002,
            "DateRequested": 20181003,
            "DateStarted": 20181004,
            "TimeStarted": 1100,
            "DateCompleted": 20181005,
            "TimeCompleted": 1611,
            "TotalRepairMinutes": 23,
            "ServiceHours": 2,
            "TravelHours": 3,
            "TravelTime": 30,
            "TripCount": 2,
            "CallNumber": "CALLNBR",
            "DealerNumber": "DLRNBR",
            "DealerName": "SOME DEALER",
            "DealerAddress": "ANOTHER STREET",
            "DealerCity": "FOUNTAIN VALLEY",
            "DealerState": "CA",
            "DealerZipCode": "92728",
            "LaborAmount": 50.75,
            "PartsAmount": 125.25,
            "OtherAmount": 45.33,
            "TaxFederalAmount": 15.23,
            "TaxStateAmount": 7.27,
            "ShippingChargeAmount": 11.17,
            "CodOrFreightAmount": 12.93,
            "TravelChargeAmount": 13.24,
            "MileageAmount": 14.18,
            "TravelMiles": 15,
            "StickerType": "S",
            "StickerNumber": "STICKNUMB",
            "ServiceContractNumber": "SVCCONTRACTNBR",
            "DistributorTransmittalNumber": "DISTTRANS",
            "Refurbished": "Y",
            "Reference": "REFERENCER",
            "PurchasedOverseasFlag": "N",
            "AuthorizationNumber": "AUTHORIZATIONNUMBER",
            "PartMarkupPercentage": 15,
            "MicrowaveBefore": "MICBEF",
            "MicrowaveAfter": "MICAFT",
            "SpecialCode": "SPECCODE",
            "DefectivePartNumber": "DEFPARTNUMBR",
            "DefectivePartSerialNumber": "DEFSERIALNBR",
            "SpecialCustomerNote": "SPECIAL CUSTOMER NOTE",
            "ServiceSignedBy": "SERVICE SIGNED BY",
            "AlternateStoreNumber": "ALTS",
            "ProductSKU": "PRODUCTSKU",
            "WarrantySKU": "WARRANTYSKU",
            "ServiceBusinessUnit": "SBU",
            "PspSourceType": "PSPSOURCET",
            "FoodSpoilageCode": "FOODSC",
            "TpaContractNumber": "TPACONTRACTXXXXTPACONTRAC",
            "TpaClaimNumber": "TPACLAIMNBR""ShipQuantity": 1,
            "TpaContractErrorShipDate": "CE20231119",
            "TpaProductPurchaseDateShipMethod": 20181010"Ground",
            "TpaLaborWarrantyDaysShipCarrier": 365"UPS",
            "TpaPartsWarrantyDaysTrackingNumber": 365,"1ZTESTING12345"
            "TpaSubProgram": "P"},
            "TpaRuleSet": "RS",{
            "TpaEquipmentRetailPricePartNumber": 15.75"285999",
            "TpaProductCodePartSequence": "TPAPRODTCD"0,
            "TpaResubmittedFlagOrderDate": "Y",
            "TpaResubmittedClaimNumberStatus": "RSBCLAIMNBRShipped",
            "TpaClaimTypeBackorderQuantity": "TCT"0,
            "TpaContractStartDateBackorderDate": 20181011"",
            "TpaContractEndDateShipQuantity": 201810121,
            "TpaProductDescriptionShipDate": "TPA PRODUCT DESCRIPTION20231125",
            "TpaContractSKUDescriptionShipMethod": "TPA CONTRACT SKU DESCRIPTIONExpress",
            "TpaProgramTypeShipCarrier": "TPAPROGRAMTYPFEDEX",
            "TpaRemarkIdTrackingNumber": "TPAREMARKID1ZTESTING12346"
        }
    ]
}

SubmitClaim Object Properties

PropertyTypeRequired?DescriptionServiceDispatch Field Mapping
ClaimsarrayNo

Pass through parameter to the ServiceDispatch "Submit Claim" API.

Claims

RequiredPartsarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.RequiredParts


ProdNumstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProdNum


QtyintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.Qty


ProdAttrsobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProdAttrs



DescstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Desc



SchematicLocationstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SchematicLocation



InvoiceNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.InvoiceNumber



UnitCost

floatNoPass through parameter to the ServiceDispatch "Submit Claim" API.UnitCost



ReturnedstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Returned



DistributorNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorNumber



FaultCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FaultCode



JobCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.JobCode

AssetobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.Asset


MfgIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MfgId


MfgstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Mfg


ModelstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Model


SerialNumstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SerialNum


PurchaseDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.PurchaseDate

BookingobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.Booking


ServiceOrgInfoobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceOrgInfo



ServiceOrgstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceOrg



LocationIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LocationId



NamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Name

LocationobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.Location


TypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Type


AddressobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.Address



AddrLine1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AddrLine1



AddrLine2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AddrLine2



CitystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.City



RegionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Region



CountrystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Country



PostalCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PostalCode


ContactsarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.Contacts



FirstNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FirstName



LastNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LastName



ContactPointarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.ContactPoint




ModestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Mode




ValuestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Value

ClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ClaimNumber

DistributorNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorNumber

DemographicCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DemographicCode

EiaDefectOrComplaintCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaDefectOrComplaintCode

DefectOrComplaintDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectOrComplaintDescription

ServicePerformedDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServicePerformedDescription

EiaRepairCode1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode1

EiaRepairCode2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode2

EiaRepairCode3stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode3

EiaRepairCode4stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode4

LaborSchematicLocation1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation1

LaborSchematicLocation2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation2

LaborSchematicLocation3stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation3

LaborSchematicLocation4stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation4

LaborSchematicLocation5stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation5

LaborSchematicLocation6stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation6

ReworkNumberOrPolicystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ReworkNumberOrPolicy

WarrantyTypeintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.WarrantyType

SoftwareVersionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SoftwareVersion

RepairCategorystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.RepairCategory

StockRepairFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StockRepairFlag

TypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Type

ExistingClaimBatchNumberintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ExistingClaimBatchNumber

ExistingClaimSequenceNumberintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ExistingClaimSequenceNumber

ProductSalesReceiptstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProductSalesReceipt

GlAccountNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.GlAccountNumber

ValidationFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ValidationFlag

DebitNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DebitNumber

KeypunchOperatorstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.KeypunchOperator

DateReceivedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateReceived

DateRequestedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateRequested

DateStartedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateStarted

TimeStartedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TimeStarted

DateCompletedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateCompleted

TimeCompletedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TimeCompleted

TotalRepairMinutesintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TotalRepairMinutes

ServiceHoursintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceHours

TravelHoursintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelHours

TravelTimeintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelTime

TripCountintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TripCount

CallNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.CallNumber

DealerNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerNumber

DealerNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerName

DealerAddressstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerAddress

DealerCitystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerCity

DealerStatestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerState

DealerZipCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerZipCode

LaborAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborAmount

PartsAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.PartsAmount

OtherAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.OtherAmount

TaxFederalAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TaxFederalAmount

TaxStateAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TaxStateAmount

ShippingChargeAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.ShippingChargeAmount

CodOrFreightAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.CodOrFreightAmount

TravelChargeAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelChargeAmount

MileageAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.MileageAmount

TravelMilesintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelMiles

StickerTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StickerType

StickerNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StickerNumber

ServiceContractNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceContractNumber

DistributorTransmittalNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorTransmittalNumber

RefurbishedstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Refurbished

ReferencestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.Reference

PurchasedOverseasFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PurchasedOverseasFlag

AuthorizationNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AuthorizationNumber

PartMarkupPercentageintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.PartMarkupPercentage

MicrowaveBeforestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MicrowaveBefore

MicrowaveAfterstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MicrowaveAfter

SpecialCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SpecialCode

DefectivePartNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectivePartNumber

DefectivePartSerialNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectivePartSerialNumber

SpecialCustomerNotestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SpecialCustomerNote

ServiceSignedBystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceSignedBy

AlternateStoreNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AlternateStoreNumber

ProductSKUstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProductSKU

WarrantySKUstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.WarrantySKU

ServiceBusinessUnitstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceBusinessUnit

PspSourceTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PspSourceType

FoodSpoilageCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FoodSpoilageCode

TpaContractNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractNumber

TpaClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaClaimNumber

TpaContractErrorstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractError

TpaProductPurchaseDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductPurchaseDate

TpaLaborWarrantyDaysintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaLaborWarrantyDays

TpaPartsWarrantyDaysintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaPartsWarrantyDays

TpaSubProgramstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaSubProgram

TpaRuleSetstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaRuleSet

TpaEquipmentRetailPricefloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaEquipmentRetailPrice

TpaProductCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductCode

TpaResubmittedFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaResubmittedFlag

TpaResubmittedClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaResubmittedClaimNumber

TpaClaimTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaClaimType

TpaContractStartDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractStartDate

TpaContractEndDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractEndDate

TpaProductDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductDescription

TpaContractSKUDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractSKUDescription

TpaProgramTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProgramType

TpaRemarkIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaRemarkId

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Submit Claim" API response will be returned.

SubmitClaim Response Object Format

Code Block
languagejs
{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "TotalClaimsReceived": 1,
        "TransactionId": "2021040713411526232528DMWSTEST02",
        "ResponseCode": "OK",
        "TotalClaimsProcessedSuccessfully": 1,
        "Claims": [
            {
                "ClaimTransactionId": "100_32362",
                "ClaimResponseCode": "OK",
                "ServiceCenterNumber": "11154",
                "ClaimStatusDescription": "Incomplete",
                "ManufacturerName": "DEMO",
                "ServiceCenterLocationCode": "LOCNAME",
                "Type": "CT",
                "ClaimBatchNumber": 300001,
                "ClaimSequenceNumber": 109,
                "ClaimStatusCode": "I",
                "ClaimNumber": "XYZ1SD422F_01",
                "Errors": [
                    {
                        "ErrorDescription": "Invalid Dispatch#",
                        "PartNumber": ""
                    }
                ]
            }
        ],
        "TotalClaimsNotProcessedSuccessfully": 0
    }
}

SubmitClaim Response Object Properties

PropertyTypeDescriptionServiceDispatch Field Mapping
SuccessbooleanPass through parameter from the ServiceDispatch "Submit Claim" API.Success  
CodeintegerPass through parameter from the ServiceDispatch "Submit Claim" API.Code
MessagestringPass through parameter from the ServiceDispatch "Submit Claim" API.Message
PayloadobjectPass through parameter from the ServiceDispatch "Submit Claim" API.Payload

TotalClaimsReceivedintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsReceived

TransactionIdstringPass through parameter from the ServiceDispatch "Submit Claim" API.TransactionId

ResponseCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ResponseCode

TotalClaimsProcessedSuccessfullyintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsProcessedSuccessfully

ClaimsarrayPass through parameter from the ServiceDispatch "Submit Claim" API.Claims


ClaimTransactionIdstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimTransactionId


ClaimResponseCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimResponseCode


ServiceCenterNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.ServiceCenterNumber


ClaimStatusDescriptionstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimStatusDescription


ManufacturerNamestringPass through parameter from the ServiceDispatch "Submit Claim" API.ManufacturerName


ServiceCenterLocationCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ServiceCenterLocationCode


TypestringPass through parameter from the ServiceDispatch "Submit Claim" API.Type


ClaimBatchNumberintegerPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimBatchNumber


ClaimSequenceNumberintegerPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimSequenceNumber


ClaimStatusCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimStatusCode


ClaimNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimNumber


ErrorsarrayPass through parameter from the ServiceDispatch "Submit Claim" API.Errors



ErrorDescriptionstringPass through parameter from the ServiceDispatch "Submit Claim" API.ErrorDescription



PartNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.PartNumber

TotalClaimsNotProcessedSuccessfullyintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsNotProcessedSuccessfully

Error

On error, a JSON-formatted version of the ServiceDispatch "Submit Claim" API response will be returned.

Code Block
languagejs
{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}


Return Codes

In addition to the Standard Return Codes, and the ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.