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

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

js

UpdateOrder Object Properties

Property		Type	Required?	Description	Claims Field Mapping
`callNumber`		`string`	Yes	Pass through parameter to the Claims "UpdateOrder " API.	`callNumber`
`orderSequence`		`string`	Yes	Pass through parameter to the Claims "UpdateOrder " API.	`orderSequence`
`parts`		`string`	Yes	Pass through parameter to the Claims "UpdateOrder " API.	`parts`
	`PartNumber`	`string`	Yes	The part number ordered.	`partNumber`
	`PartSequence`	`string`	Yes	The sequence of the parts ordered.	`partSequence`
	`OrderDate`	`string`	Yes	The date the part was ordered.	`orderDate`
	`Status`	`string`	Yes	The status of the order.	`status`
	`BackorderQuantity`	`string`	No	The quantity of the parts currently under backordered.	`partBackorderQuantity`
	`BackorderDate`	`string`	No	The expected date of the back order	`backorderDate`
	`StatusShipQuantity`	`string`	Yes	The status of the quantity being shipped.	`statusShipQuantity`
	`ShipDate`	`string`	Yes	The ship date of the part.	`shipDate`
	`ShipMethod`	`string`	Yes	The type of shipping used to deliver the part.	`shipMethod`
	`ShipCarrier`	`string`	Yes	The service provider that is shipping the part.	`shipCarrier`
	`TrackingNumber`	`string`	Yes	The 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

js

UpdateOrder Response Object Properties

Property	Type	Description	ServiceDispatch Field Mapping
`Success`	`boolean`	Pass through parameter from the ServiceClaim "UpdateOrder" API.	`Success`
`Code`	`integer`	Pass through parameter from the ServiceClaim "UpdateOrder" API.	`Code`
`Message`	`string`	Pass through parameter from the ServiceClaim "UpdateOrder" API.	`Message`
`Payload`	`object`	Pass 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.

js

Return Codes

In addition to the Standard Return Codes, there are ServiceDispatch Error codes.

Browser not supported