Versions Compared

Version Old Version 16 New Version 17
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 "Update Order" APi.

Update Order Object Format

Code Block
languagejs
{
    "callNumber": "0007084-97757435",
    "OrderSequence": 0,
    "Parts": [
        {
            "PartNumber": "285442",
            "PartSequence": 0,
            "OrderDate": "20231114",
            "Status": "Shipping",
            "BackorderQuantity": 1,
            "BackorderDate": "20231117",
            "ShipQuantity": 1,
            "ShipDate": "20231119",
            "ShipMethod": "Ground",
            "ShipCarrier": "UPS",
            "TrackingNumber": "1ZTESTING12345"
        },
        {
            "PartNumber": "285999",
            "PartSequence": 0,
            "OrderDate": "",
            "Status": "Shipped",
            "BackorderQuantity": 0,
            "BackorderDate": "",
            "ShipQuantity": 1,
            "ShipDate": "20231125",
            "ShipMethod": "Express",
            "ShipCarrier": "FEDEX",
            "TrackingNumber": "1ZTESTING12346"
        }
    ]
}

UpdateOrder Object Properties

PropertyTypeRequired?DescriptionServiceDispatch Field MappingClaimsarrayNo

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

ClaimsRequiredPartsarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.RequiredPartsProdNumstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProdNumQtyintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.QtyProdAttrsobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProdAttrsDescstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DescSchematicLocationstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SchematicLocationInvoiceNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.InvoiceNumber

UnitCost

floatNoPass through parameter to the ServiceDispatch "Submit Claim" API.UnitCostReturnedstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ReturnedDistributorNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorNumberFaultCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FaultCodeJobCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.JobCodeAssetobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.AssetMfgIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MfgIdMfgstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MfgModelstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ModelSerialNumstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SerialNumPurchaseDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.PurchaseDateBookingobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.BookingServiceOrgInfoobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceOrgInfoServiceOrgstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceOrgLocationIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LocationIdNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.NameLocationobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.LocationTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TypeAddressobjectNoPass through parameter to the ServiceDispatch "Submit Claim" API.AddressAddrLine1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AddrLine1AddrLine2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AddrLine2CitystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.CityRegionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.RegionCountrystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.CountryPostalCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PostalCodeContactsarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.ContactsFirstNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FirstNameLastNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LastNameContactPointarrayNoPass through parameter to the ServiceDispatch "Submit Claim" API.ContactPointModestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ModeValuestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ValueClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ClaimNumberDistributorNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorNumberDemographicCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DemographicCodeEiaDefectOrComplaintCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaDefectOrComplaintCodeDefectOrComplaintDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectOrComplaintDescriptionServicePerformedDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServicePerformedDescriptionEiaRepairCode1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode1EiaRepairCode2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode2EiaRepairCode3stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode3EiaRepairCode4stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.EiaRepairCode4LaborSchematicLocation1stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation1LaborSchematicLocation2stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation2LaborSchematicLocation3stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation3LaborSchematicLocation4stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation4LaborSchematicLocation5stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation5LaborSchematicLocation6stringNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborSchematicLocation6ReworkNumberOrPolicystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ReworkNumberOrPolicyWarrantyTypeintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.WarrantyTypeSoftwareVersionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SoftwareVersionRepairCategorystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.RepairCategoryStockRepairFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StockRepairFlagTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TypeExistingClaimBatchNumberintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ExistingClaimBatchNumberExistingClaimSequenceNumberintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ExistingClaimSequenceNumberProductSalesReceiptstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProductSalesReceiptGlAccountNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.GlAccountNumberValidationFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ValidationFlagDebitNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DebitNumberKeypunchOperatorstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.KeypunchOperatorDateReceivedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateReceivedDateRequestedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateRequestedDateStartedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateStartedTimeStartedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TimeStartedDateCompletedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.DateCompletedTimeCompletedintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TimeCompletedTotalRepairMinutesintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TotalRepairMinutesServiceHoursintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceHoursTravelHoursintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelHoursTravelTimeintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelTimeTripCountintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TripCountCallNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.CallNumberDealerNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerNumberDealerNamestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerNameDealerAddressstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerAddressDealerCitystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerCityDealerStatestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerStateDealerZipCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DealerZipCodeLaborAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.LaborAmountPartsAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.PartsAmountOtherAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.OtherAmountTaxFederalAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TaxFederalAmountTaxStateAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TaxStateAmountShippingChargeAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.ShippingChargeAmountCodOrFreightAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.CodOrFreightAmountTravelChargeAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelChargeAmountMileageAmountfloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.MileageAmountTravelMilesintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TravelMilesStickerTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StickerTypeStickerNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.StickerNumberServiceContractNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceContractNumberDistributorTransmittalNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DistributorTransmittalNumberRefurbishedstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.RefurbishedReferencestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ReferencePurchasedOverseasFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PurchasedOverseasFlagAuthorizationNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AuthorizationNumberPartMarkupPercentageintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.PartMarkupPercentageMicrowaveBeforestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MicrowaveBeforeMicrowaveAfterstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.MicrowaveAfterSpecialCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SpecialCodeDefectivePartNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectivePartNumberDefectivePartSerialNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.DefectivePartSerialNumberSpecialCustomerNotestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.SpecialCustomerNoteServiceSignedBystringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceSignedByAlternateStoreNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.AlternateStoreNumberProductSKUstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ProductSKUWarrantySKUstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.WarrantySKUServiceBusinessUnitstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.ServiceBusinessUnitPspSourceTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.PspSourceTypeFoodSpoilageCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.FoodSpoilageCodeTpaContractNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractNumberTpaClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaClaimNumberTpaContractErrorstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractErrorTpaProductPurchaseDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductPurchaseDateTpaLaborWarrantyDaysintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaLaborWarrantyDaysTpaPartsWarrantyDaysintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaPartsWarrantyDaysTpaSubProgramstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaSubProgramTpaRuleSetstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaRuleSetTpaEquipmentRetailPricefloatNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaEquipmentRetailPriceTpaProductCodestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductCodeTpaResubmittedFlagstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaResubmittedFlagTpaResubmittedClaimNumberstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaResubmittedClaimNumberTpaClaimTypestringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaClaimTypeTpaContractStartDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractStartDateTpaContractEndDateintegerNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractEndDateTpaProductDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProductDescriptionTpaContractSKUDescriptionstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaContractSKUDescriptionTpaProgramTypestringNo

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 "Update Order" APi.

UpdateOrder Object Format

Code Block
languagejs
{
    "callNumber": "0007084-97757435",
    "orderSequence": 0,
    "parts": [
        {
            "PartNumber": "285442",
            "PartSequence": 0,
            "OrderDate": "20231114",
            "Status": "Shipping",
            "BackorderQuantity": 1,
            "BackorderDate": "20231117",
            "ShipQuantity": 1,
            "ShipDate": "20231119",
            "ShipMethod": "Ground",
            "ShipCarrier": "UPS",
            "TrackingNumber": "1ZTESTING12345"
        },
        {
            "PartNumber": "285999",
            "PartSequence": 0,
            "OrderDate": "",
            "Status": "Shipped",
            "BackorderQuantity": 0,
            "BackorderDate": "",
            "ShipQuantity": 1,
            "ShipDate": "20231125",
            "ShipMethod": "Express",
            "ShipCarrier": "FEDEX",
            "TrackingNumber": "1ZTESTING12346"
        }
    ]
}

UpdateOrder Object Properties

PropertyTypeRequired?DescriptionServiceClaims Field Mapping
callNumberstringYes

Pass through parameter to the ServiceClaims "UpdateOrder " API.

callNumber
orderSequencestringYesPass through parameter to the ServiceClaims "UpdateOrder " API.orderSequence
partsarrayYesPass through parameter to the ServiceClaims "UpdateOrder " API.parts

PartNumberarrayYesPass through parameter to the ServiceDispatch "Submit Claim" API.TpaProgramTypeTpaRemarkIdstringNoPass through parameter to the ServiceDispatch "Submit Claim" API.TpaRemarkIdRequiredParts

PartSequence




OrderDate




Status




BackorderQuantity




BackorderDate




StatusShipQuantity




ShipDate




ShipMethod




ShipCarrier




TrackingNumber



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": {
        "ResponseCode": "OK"
    }
}

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
{
    "name": "GeneralError",
    "message": "Error",
    "code": 400,
    "className": "general-error",
    "data": {
        "Success": false,
        "Code": 8,
        "Message": "BadRequest: Error ocurred while querying the Claim!"
    }
}


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.