Use this request to add your records to 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 Update Request | |
|
Request URI |
https://www.moversconnect.net/api/integration/{YourVendorName} |
|
Request Method |
POST |
|
Authorization |
“Bearer” followed by a space and the “access_token” from VendorConnect Token Request. |
|
Information |
true. |
|
Content-Type |
application/json |
|
Payload: |
|
|
{ "ApiServiceAction": "POST", "ConnectorIdentifier": "YourConnectionIdentifier", "Order": { "OrderNumber": { "EstimateNo": "VNDC0000001", "ExternalID": "VND1598435705" }, "AllowEmptyOrderCreate": true, "KeepExistingDates": false, "IsLead": true, "IsForeignOrder": false, "Commodity": "HHG", "LastName": "Doe", "FirstName": "John" } } | |
|
Note: |
|
|
The payload above is a very simple one that provides the absolute minimum needed information to push a lead into MoversSuite. You can include more data as outlined within the Pass Thru Connector Content topic and VendorConnect Schema and Sample Files. We recommend that the “EstimateNo”, if using for lead entry, be unique within MoversSuite. | |
|
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)
| |