Versions Compared

Version Old Version 20 New Version Current
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' "PartsUpdate 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 "PartsUpdateOrder" 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 OrderUpdateOrder" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/claimsparts/updateOrder

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 Claims Field Mapping
callNumberstringYes

Pass through parameter to the ServiceClaims Claims "UpdateOrder " API.

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

PartNumberstringYesThe part number ordered.PartNumberpartNumber

PartSequencestringYesThe sequence of the parts ordered.PartSequencepartSequence

OrderDatestringYesThe date the part was ordered.OrderDateorderDate

StatusstringYesThe status of the order.Statusstatus

BackorderQuantitystringNoThe quantity of the parts currently under backordered.PartBackorderQuantitypartBackorderQuantity

BackorderDatestringNoThe expected date of the back orderBackorderDatebackorderDate

StatusShipQuantitystringYesThe status of the quantity being shipped.StatusstatusShipQuantity

ShipDatestringYesThe ship date of the part.ShipDateshipDate

ShipMethodstringYesThe type of shipping used to deliver the part.ShipMethodshipMethod

ShipCarrierstringYesThe service provider that is shipping the part.ShipCarriershipCarrier

TrackingNumberstringYesThe tracking number for the shipping of the part.TrackingNumbertrackingNumber

HTTP Response

Success

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

SubmitClaim Response

UpdateOrder Response Object Format

Code Block
languagejs
{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "ResponseCode": "OK"
    }
}
SubmitClaim Response

UpdateOrder Response Object Properties

TotalClaimsProcessedSuccessfully
PropertyTypeDescriptionServiceDispatch Field Mapping
SuccessbooleanPass through parameter from the ServiceDispatch ServiceClaim "Submit ClaimUpdateOrder" API.Success  
CodeintegerPass through parameter from the ServiceDispatch ServiceClaim "Submit ClaimUpdateOrder" API.Code
MessagestringPass through parameter from the ServiceDispatch ServiceClaim "Submit ClaimUpdateOrder" API.Message
PayloadobjectPass through parameter from the ServiceDispatch ServiceClaim "Submit ClaimUpdateOrder" API.PayloadTotalClaimsReceivedintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsReceivedTransactionIdstringPass through parameter from the ServiceDispatch "Submit Claim" API.TransactionIdResponseCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ResponseCodeintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsProcessedSuccessfullyClaimsarrayPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimsClaimTransactionIdstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimTransactionIdClaimResponseCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimResponseCodeServiceCenterNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.ServiceCenterNumberClaimStatusDescriptionstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimStatusDescriptionManufacturerNamestringPass through parameter from the ServiceDispatch "Submit Claim" API.ManufacturerNameServiceCenterLocationCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ServiceCenterLocationCodeTypestringPass through parameter from the ServiceDispatch "Submit Claim" API.TypeClaimBatchNumberintegerPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimBatchNumberClaimSequenceNumberintegerPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimSequenceNumberClaimStatusCodestringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimStatusCodeClaimNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.ClaimNumberErrorsarrayPass through parameter from the ServiceDispatch "Submit Claim" API.ErrorsErrorDescriptionstringPass through parameter from the ServiceDispatch "Submit Claim" API.ErrorDescriptionPartNumberstringPass through parameter from the ServiceDispatch "Submit Claim" API.PartNumberTotalClaimsNotProcessedSuccessfullyintegerPass through parameter from the ServiceDispatch "Submit Claim" API.TotalClaimsNotProcessedSuccessfully

Error

On error, a JSON-formatted version of the ServiceDispatch "Submit ClaimUpdate Order" 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 there are ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.