While the MoversSuite application integrates directly with the API Service, you can access this service for the purposes of third-party integration and development. The following information is provided to assist you in developing third party integrations to the API Service.
Request Information
There are three request types available through the API Service. The following table lists the request available through the MoversSuite API Service.
|
Request |
Description |
|
Identify the primary key for a MoversSuite order by specifying either an entire Order Number or its components. | |
|
Retrieve the entire MoversConnect order object for the provided primary key and data type. | |
|
Retrieve basic order information for the provided primary key. |
Return Information
Data returned by each of the three requests include the primary key for an order, the entire MoversConnect order object, and the basic order information, as detailed within Pass Thru Connector Upload Format.
MoversSuite tracks errors received by API Service requests through the Third Party Application Error Management.
Setup Information
There is no specific setup needed for the MoversSuite API Service. Setup may be needed for processes that interact with the service, such as specific setup for Document Management and Electronic and Online Payments.
Also, refer to specific API setup within each sub-process of the MoversSuite API Service. Refer to the MoversSuite API Service topic for a listing.