1.11.0

The Parts Ordering REST API provides the ability to check for parts availability and estimated delivery dates, place an order, and cancel and order.

This API is designed to be called directly from the mobile application.

The typical flow for parts ordering is as follows:

Technician determines that parts are required.
Technician creates a parts order.
Technician makes a requests to the back-end to check for parts availability.
If the customer accepts the price and estimated delivery date for the parts, then the order will be completed.
If the customer decides that they do not want to proceed with the order, then the technician will remove the ordered items from the work order.

Before the Parts Ordering REST API can be used for a given entity, it will be necessary to use the REST Configuration REST APIs Entity System Configuration REST API to update the entity's REST Object Definitions Configuration Related Objects Entity System Configuration Object and configure the PartsOrdering.EntityServiceURI property, to define the REST Endpoint URI of an API that implements the REST Interfaces Parts Ordering REST API Interface.

On this page:

Resource URL Summary

Submit a Parts Order

POST /seiapi/v3/mobile/PartsOrdering

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

API Specifics

Submit a Parts Order

This REST API will create a new parts order in the system.

URL

POST /seiapi/v3/mobile/PartsOrdering

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Parts Ordering Object.

HTTP Response Body

The HTTP response body, on success, will contain a REST Object Definitions Work Order Activity Related Objects Parts Ordering Response Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

JSON Format

{
	"Orders": [{
		"EstimatedDelivery": "2014-12-18T10:00:00.000Z",
		"PartOrderNum": "",
		"Parts": [{
			"ProdNum": "",
			"PartStatus": "{free text}",
			"ProdAttrs": {
				"Desc": "",
				"IsBatch": false,
				"IsInvCtrl": false,
				"IsSerialized": false,
				"Price": 0.0,
				"ProdType": "1001"
			},
			"ShipToLocation": "",
			"SupersededParts": [{
				"ProdNum": "",
				"PartStatus": "{free text}",
				"ProdAttrs": {
					"Desc": "",
					"IsBatch": false,
					"IsInvCtrl": false,
					"IsSerialized": false,
					"Price": 0.0,
					"ProdType": "1001"
				},
				"Qty": 10.0
			}],
			"Urgency": ""
		}],
		"TrackingNumber": ""
	}],
	"Status": "",
	"StatusMsg": ""
}

REST Standard REST APIs Parts Ordering REST API