Versions Compared

Old Version 3

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title1.11.0

The Parts Ordering REST API provides the ability to place an order for parts.

Warning

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

The typical flow for parts ordering is as follows:

  1. Technician determines that parts are required.
  2. Technician creates a parts order.
  3. Technician makes a requests to the back-end to check for parts availability.
  4. If the customer accepts the price and estimated delivery date for the parts, then the order will be completed.
  5. 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. 
Note

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.



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Submit a Parts Order

POST /seiapi/v3/mobile/PartsOrdering

Include Page
_Default HTTP Headers
_Default HTTP Headers


 

API Specifics


Panel
borderColor#D3D3D3

Submit a Parts Order

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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. 

Include Page
_Parts Ordering Response Object Formats
_Parts Ordering Response Object Formats