ERP REST interfaces

Solution offers several REST interfaces to create, read and update data in/from internal database on demand of external system.  Communication is performed by calling Web API methods, data to create/update are transferred in JSON format in a body of a call.

API is prepared on specific URL where Admin Portal (AP) is listening for receiving messages. Authentication must be performed with user with API permissions. How to define such user is described in Manage user groups.

When message is received, system is updated with contained data or requested information is provided as result of the call. Following receiving interfaces are currently available:

• [AP_base_uri]/ERP/PurchaseOrder/Create – creates order
• [AP_base_uri]/ERP/PurchaseOrder/UpdateQuantity – updates ordered quantities on specific order, allows to update received quantities
• [AP_base_uri]/ERP/PurchaseOrder/UpdateOrder – updates information of existing order – send order to vendor by setting status to active or cancel active order; update shipping information, reference and notes
• [AP_base_uri]/ERP/PurchaseOrder/GetRequestResult – returns status of sent request to create or update purchase orders
• [AP_base_uri]/ERP/ServiceOrder/Create – creates order of type Service
• [AP_base_uri]/ERP/ServiceOrder/UpdateQuantity – updates ordered quantities on specific order of type Service, allows to update received quantities
• [AP_base_uri]/ERP/ServiceOrder/UpdateOrder – updates information of existing order of type Service – send order to vendor by setting status to active or cancel active order; update shipping information, reference and notes
• [AP_base_uri]/ERP/ServiceOrder/GetRequestResult – returns status of sent request to create or update purchase orders of type Service
• [AP_base_uri]/ERP/CostAllocation/Create – creates cost allocation definitions for specific cost allocation type. Valid for list and hierarchy cost allocation steps
• [AP_base_uri]/ERP/CostAllocation/UpdateHierarchy – allows to create new relations between cost allocation definitions of hierarchy steps
• [AP_base_uri]/ERP/CostAllocation/DeleteHierarchy – allows to remove existing relations between cost allocation definitions of hierarchy steps
• [AP_base_uri]/ERP/CostAllocation/UpdateItemRestrictions – updates restrictions to items in specific place in cost allocation hierarchy
• [AP_base_uri]/ERP/CostAllocation/GetHierarchy – returns complete hierarchy of currently defined in the system with all restrictions to items, users and user groups
• [AP_base_uri]/ERP/CostAllocation/GetRequestResult – returns status of sent request to create new cost allocation definitions
• [AP_base_uri]/ERP/ReceiveItems/Create – creates new items in the system
• [AP_base_uri]/ERP/ReceiveItems/Update – updates existing item information
• [AP_base_uri]/ERP/ReceiveItems/GetRequestResult – returns status of sent request to create new items
• [AP_base_uri]/ERP/Vendor/Create – creates new vendors in the system
• [AP_base_uri]/ERP/Vendor/GetRequestResult – returns status of sent request to create new vendor
• [AP_base_uri]/ERP/Manufacturer/Create – creates new manufacturers in the system
• [AP_base_uri]/ERP/Manufacturer/GetRequestResult – returns status of sent request to create new manufacturer
• [AP_base_uri]/ERP/PickList/Get – returns all pick lists in the system
• [AP_base_uri]/ERP/PickList/Create – creates new pick lists
• [AP_base_uri]/ERP/PickList/Update – update existing pick lists
• [AP_base_uri]/ERP/PickList/Delete – deletes existing pick lists
• [AP_base_uri]/ERP/PickList/GetRequestResult – returns status of sent request to create or update pick list

REST interfaces are always active.

Usage of received interface consists of following steps:

1. Authentication – obtain access token to authorize for using the interface
2. Send request to create, update or get data – for read (get) interfaces, requested information is send directly in response. For create and update interfaces, only ID of request is send in the response and request is added to queue to be performed based on server utilization
3. Get request status and data created/updated – obtain information about the request and get IDs of new objects created by the request. This step is valid only for create and update interfaces