Versions Compared

Version Old Version 27 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 UpdateOrder" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/parts/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.partNumber

PartSequencestringYesThe sequence of the parts ordered.partSequence

OrderDatestringYesThe date the part was ordered.orderDate

StatusstringYesThe status of the order.status

BackorderQuantitystringNoThe quantity of the parts currently under backordered.partBackorderQuantity

BackorderDatestringNoThe expected date of the back orderbackorderDate

StatusShipQuantitystringYesThe status of the quantity being shipped.statusShipQuantity

ShipDatestringYesThe ship date of the part.shipDate

ShipMethodstringYesThe type of shipping used to deliver the part.shipMethod

ShipCarrierstringYesThe service provider that is shipping the part.shipCarrier

TrackingNumberstringYesThe tracking number for the shipping of the part.trackingNumber

HTTP Response

Success

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

UpdateOrder Response Object Format

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

UpdateOrder Response Object Properties

PropertyTypeDescriptionServiceDispatch Field Mapping
SuccessbooleanPass through parameter from the ServiceClaim "UpdateOrder" API.Success  
CodeintegerPass through parameter from the ServiceClaim "UpdateOrder" API.Code
MessagestringPass through parameter from the ServiceClaim "UpdateOrder" API.Message
PayloadobjectPass through parameter from the ServiceClaim "UpdateOrder" API.Payload

Error

On error, a JSON-formatted version of the ServiceDispatch "Update 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, there are ServiceDispatch Error codes.