Document toolboxDocument toolbox

Required Parts Object

The required parts object contains all properties relevant to specifying required parts for a work order.  This is currently used within the Book Job REST API.

Required Parts Object Formats

JSON Format
 {
	"RequiredParts": [{
		"EstimatedDelivery": "2014-12-18T10:00:00.000Z",
		"ProdNum": "",
		"PartStatus": "{free text}",
		"Price": 0.0,
		"ShipToLocation": "",
		"SupersededParts": [{
			"ProdNum": "",
			"PartStatus": "{free text}",
			"ProdAttrs": {
				"Desc": "",
				"IsBatch": false,
				"IsInvCtrl": false,
				"IsSerialized": false,
				"ProdType": "1001"
			},
			"Qty": 10.0
		}],
		"Urgency": ""
	}]
}

HTTP Object Properties

Property
Type
Description
EstimatedDeliverydatetimeUTCSpecifies the estimated delivery date of the required part.
PartStatusstringSpecifies the part status (see Part Status system category)
PriceobjectSpecifies the price of the part.
SupersededPartsobject(see SupersededParts Object)
DistancedecimalThe maximum distance (search radius).
UnitstringThe unit of measure returned for the search. Use mi for miles or km for kilometers.

Book Job Object Properties

(info) Required properties are in bold

PropertyTypeDescription
EstimatedDeliverydatetime

This optional property specifies the estimate delivery date of the associated part.

This property is calculated and populated by the back end system if a connection is available at the time the part is ordered. Otherwise, this property will be left empty.

Partsobject

The parts object contains all parts whose availability is being requested.

See: Required Part Object