Use this request to pull lead or order data for your records out of MoversSuite.
You will need to the following to process this request:
•Your unique vendor name (YourVendorName) and Connector Identifier (YourConnectionIdentifier) provided by EWS Group.
•Bearer token from a VendorConnect Token Request.
•Understanding of the schema (refer to VendorConnect Schema and Sample Files).
|
RESTful Order Request | |
|
Request URI |
https://www.moversconnect.net/api/integration/{YourVendorName} |
|
Request Method |
GET |
|
Authorization |
“Bearer” followed by a space and the “access_token” from VendorConnect Token Request. |
|
Information |
true |
|
Content-Type |
application/json |
|
Payload: |
|
|
{ "ApiServiceAction": "GET", "ConnectorIdentifier": "YourConnectionIdentifier", "Order": { "OrderNumber": { "ExternalID": "YourUniqueRecordIdentifier" } } }
| |
|
Notes: |
|
|
“ExternalID” is your identifier for this record. This maps to a varchar(60) value in the MoversSuite database. You can search using Order Number and Shipper Last Name. However, the application only returns a record if it linked to your vendor interface. Below is a sample search by Order Number and Shipper Last Name.
"ApiServiceAction": "GET", "ConnectorIdentifier": "YourConnectionIdentifier", "Order": { "OrderNumber": { "LastName": "Smith", “OrderSegment”: “1623-235-23” } } }
OrderSegment cannot exceed 16 characters. LastName cannot exceed 26 characters. | |
|
Response: |
|
|
Returned is a MessageUploadResponse object in XML and include four properties including an ErrorCode value. “0” is a successful request. | |
|
{ "ErrorCode": 0, "ProcessingMessage": null, "DestinationMessage": “Successfully queued”, "ProcessingTimeUtc": “2023-12-23 15:38:08” } | |
|
Notes: |
|
|
ErrorCode Returns “0” upon a successful request. Otherwise, an error code returns along with an error description in one or more of the message properties.
ProcessingMessage Messages from the processing system, i.e., MoversConnect, display for this returned property.
DestinationMessage Messages from the calling system display for this returned property.
ProcessingTimeUtc Date and timestamp of the response (in “CCYY-MM-DD HH:MM:SS format)
| |