Document toolboxDocument toolbox

Parts Ordering REST API Interface

Owned by Mickey Bushman
Last updated: Oct 03, 2024 by Jason Andrew

3.18.0

The Parts Ordering REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to create parts orders via their own systems.

By implementing an API which matches the Parts Ordering REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that part orders made via the Parts Ordering REST API are passed through to their system.

On this page:

Related pages:

Resource URL Summary

Submit a Parts Order

POST <REST Endpoint URI>

HTTP Headers

ServiceMobility will set both of the Standard HTTP Headers when calling this REST API Interface.

That is:

  • The Content-Type header will be set to application/json; and
  • The x-access-token header will be set to the JWT that was used in the call to the API that triggered ServiceMobility to call the configured endpoint that implements this interface.

The x-access-token header will either be the JWT issued by ServiceMobility, or by the endpoint that implements the Authentication REST API Interface that ServiceMobility has been configured to use.

Implementations of this interface may evaluate the JWT supplied, if required, but please note that ServiceMobility will have already authenticated the JWT in the initial API call before passing the call on to the configured endpoint.

API Specifics

Submit a Parts Order

This REST API must accept a parts order requested via the Parts Ordering REST API, and order the required parts (when possible).

URL

POST <REST Endpoint URI>

HTTP Request Body

The HTTP request body will contain a valid Parts Ordering Object.

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The parts order has been processed. (Does not necessarily mean parts have been ordered - see possible response object Status values.)
401Invalid Logon.
500Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause.

On success, an HTTP response code of 200 must be returned, and the response body must contain a valid response body that is the same as would be returned from the Parts Ordering REST API.

ServiceMobility will return the response code (and response body, if present) as the response to the initiating Parts Ordering REST API call.