Resource URL Summary

Pass Through Call to Claims "Parts UpdateOrder" API

POST /up/v5/parts/updateOrder

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

Enablements

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

{
    "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

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

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

{
    "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

Property		Type	Required?	Description	ServiceClaims Field Mapping
`callNumber`		`string`	Yes	Pass through parameter to the ServiceClaims "UpdateOrder " API.	`callNumber`
`orderSequence`		`string`	Yes	Pass through parameter to the ServiceClaims "UpdateOrder " API.	`orderSequence`
`parts`		`array`	Yes	Pass through parameter to the ServiceClaims "UpdateOrder " API.	`parts`
	`PartNumber`	`array`	Yes	Pass through parameter to the ServiceDispatch "Submit Claim" API.	`RequiredParts`
	`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

{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "ResponseCode": "OK"
    }
}

SubmitClaim Response Object Properties

Property				Type	Description	ServiceDispatch Field Mapping
`Success`				`boolean`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Success`
`Code`				`integer`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Code`
`Message`				`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Message`
`Payload`				`object`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Payload`
	`TotalClaimsReceived`			`integer`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`TotalClaimsReceived`
	`TransactionId`			`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`TransactionId`
	`ResponseCode`			`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ResponseCode`
	`TotalClaimsProcessedSuccessfully`			`integer`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`TotalClaimsProcessedSuccessfully`
	`Claims`			`array`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Claims`
		`ClaimTransactionId`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimTransactionId`
		`ClaimResponseCode`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimResponseCode`
		`ServiceCenterNumber`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ServiceCenterNumber`
		`ClaimStatusDescription`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimStatusDescription`
		`ManufacturerName`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ManufacturerName`
		`ServiceCenterLocationCode`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ServiceCenterLocationCode`
		`Type`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Type`
		`ClaimBatchNumber`		`integer`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimBatchNumber`
		`ClaimSequenceNumber`		`integer`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimSequenceNumber`
		`ClaimStatusCode`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimStatusCode`
		`ClaimNumber`		`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ClaimNumber`
		`Errors`		`array`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`Errors`
			`ErrorDescription`	`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`ErrorDescription`
			`PartNumber`	`string`	Pass through parameter from the ServiceDispatch "Submit Claim" API.	`PartNumber`
	`TotalClaimsNotProcessedSuccessfully`			`integer`	Pass 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.

{
    "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.

Parts UpdateOrder RESTified API