Applies to integrated customers using the RecoveryConnect API
Update Operations
The Update Operations section contains endpoints used to retrieve and create updates associated with orders and order addresses. Updates are used to record important activities, notes, or status information related to an order or a specific address.
All requests must include a valid Bearer token in the request header.
Retrieve Order Address Updates
Description: This endpoint retrieves the list of updates associated with a specific address within an order.
This endpoint helps integrators track historical updates and communications related to an address within an order.
URL: /api/v140/orders/{order_id}/addresses/{address_id}/updates
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/92606168/addresses/156605950/updates |
Request Body: NA
Response:
{ "data": [ { "id": 720224184, "type": 7, "order_id": 92606168, "parent_id": null, "employee_id": 543222, "company_id": 10001, "transferred_by": null, "updateable_id": 156605950, "updateable_type": "Address", "details": "<p>Testing</p>", "priority": 0, "visibility": 0, "date": "2026-03-09 12:52:00", "is_hit": 0, "is_invalid": 0, "is_incorrect": 0, "created_at": "2026-03-09 12:52:43", "updated_at": "2026-03-09 12:52:43", "deleted_at": null, "migration": null, "sync_to_mmi": 1 } ], "links": { "first": "https://api.mbsisystems.com/api/v140/orders/92606168/addresses/156605950/updates?q=%2Fapi%2Fv140%2Forders%2F92606168%2Faddresses%2F156605950%2Fupdates&page=1", "last": "https://api.mbsisystems.com/api/v140/orders/92606168/addresses/156605950/updates?q=%2Fapi%2Fv140%2Forders%2F92606168%2Faddresses%2F156605950%2Fupdates&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://api.mbsisystems.com/api/v140/orders/92606168/addresses/156605950/updates", "per_page": "20", "to": 1, "total": 1, "fixme": { "message": "GenericCollectionResource: create specific resource collection object", "source": { "file": "/var/www/mobile_dev/releases/20210115001451/versions/v140/app/Http/Controllers/Api/Mixins/Helper/ReturnsOrderableCollections.php", "line": 66, "function": "__construct", "class": "App\\Http\\Resources\\GenericCollectionResource", "type": "->" } } } } |
Create Order Address Update
Description: This endpoint creates a new update record associated with a specific address within an order.
Address updates are used to record status updates, notes, or communications related to the address. These updates can be used to communicate with clients, agents, or internal teams and may include information such as update type, message content, priority level, and visibility settings.
URL: /api/v140/orders/{order_id}/addresses/{address_id}/updates
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
type | Identifier representing the update type (refer to Update Type IDs reference table) | Yes | 3 |
message | Message or description of the update | Yes | Example update |
shift_id | Identifier representing the shift associated with the update | No | 1 |
is_private | Indicates whether the update is private (true = Private, false = Public) | No | FALSE |
priority | Priority level of the update (refer to Update Priority Levels reference table) | No | 2 |
client_visible | Indicates whether the update is visible to the client | No | TRUE |
agent_visible | List of agent IDs who can view this update | No | [10001] |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073422/addresses/120093701/updates |
Request Body:
{ "type": 3, "message": "Example update", "shift_id": 1, "is_private": false, "priority": 2, "client_visible": true, "agent_visible": [ 10001 ] } |
Response:
{ "data": { "id": 534079054, "private": false, "priority": 0, "details": "Example update", "address": { "id": 120093701, "name": "Home Address", "address_1": "A_789 Euclid Avenue, Cleveland,89", "address_2": "", "unit": "", "zip": "44103", "city_name": "Cleveland", "state_name": "Ohio", "type": 1, "latitude": "41.50018400", "longitude": "-81.68763600", "priority": 0, "hits": 0, "no_contact": 0, "self": "http://stg-api.mbsisystems.com/api/address/120093701", "expand": "runsheet_address" }, "created_at": "2026-03-09 13:11:54", "company_orderno": "103200-1", "order_id": 57073422, "added_by": "sunil Forwarder", "type": "Address", "update_type_id": 3, "author": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "self": "http://stg-api.mbsisystems.com/api/updates/534079054", "expand": "update" }, "status": "success" } |
Retrieve Order Updates
Description: This endpoint retrieves the list of updates associated with a specific order.
Order updates represent activity logs, notes, or communications related to the order. These updates may include status updates, internal notes, client communications, or operational updates created by agents or system users.
Optional query parameters can be used to filter updates or include additional related update history.
URL: /api/v140/orders/{order_id}/updates
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
exclude_own | When present, this optional parameter excludes updates created by the company’s own employees. The value is ignored; only the presence of the parameter is evaluated. | No | ?exclude_own=true |
include_related | When present, this optional parameter includes related or previous updates associated with the order. The value is ignored; only the presence of the parameter is evaluated. | No | ?include_related=true |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073422/updates |
Request Body: NA
Response:
{ "data": [ { "id": 534079054, "private": false, "priority": 0, "details": "Example update", "address": { "id": 120093701, "name": "Home Address", "address_1": "A_789 Euclid Avenue, Cleveland,89", "address_2": "", "unit": "", "zip": "44103", "city_name": "Cleveland", "state_name": "Ohio", "type": 1, "latitude": "41.50018400", "longitude": "-81.68763600", "priority": 0, "hits": 0, "no_contact": 0, "self": "http://stg-api.mbsisystems.com/api/address/120093701", "expand": "runsheet_address" }, "created_at": "2026-03-09 13:11:54", "company_orderno": "103200-1", "order_id": 57073422, "added_by": "sunil Forwarder", "type": "Address", "update_type_id": 3, "author": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "self": "http://stg-api.mbsisystems.com/api/updates/534079054", "expand": "update" } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/orders/57073422/updates?q=%2Fapi%2Fv140%2Forders%2F57073422%2Fupdates&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/orders/57073422/updates?q=%2Fapi%2Fv140%2Forders%2F57073422%2Fupdates&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/orders/57073422/updates", "per_page": "20", "to": 1, "total": 1, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
Create Order Update
Description: This endpoint creates a new update record associated with a specific order.
Order updates are used to record status updates, notes, or communications related to the order. These updates may include internal notes, client communications, or operational updates created by agents or system users.
Each update can include a message, update type, priority level, and visibility settings to control whether the update is visible to clients or specific agents.
URL: /api/v140/orders/{order_id}/updates
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
type | Identifier representing the update type (refer to Update Type IDs reference table) | Yes | 3 |
message | Message or description of the update | Yes | Example update |
shift_id | Identifier representing the shift associated with the update | No | 1 |
is_private | Indicates whether the update is private (true = Private, false = Public) | No | FALSE |
priority | Priority level of the update (refer to Update Priority Levels reference table) | No | 2 |
client_visible | Indicates whether the update is visible to the client | No | TRUE |
agent_visible | List of agent IDs who can view this update | No | [10001] |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073422/updates |
Request Body:
{ "type": 3, "message": "Example update", "shift_id": 1, "is_private": false, "priority": 2, "client_visible": true, "agent_visible": [ 10001 ] } |
Response:
{ "data": { "id": 534079142, "private": false, "priority": 2, "details": "Example update", "address": null, "created_at": "2026-03-09 17:27:51", "company_orderno": "103200-1", "order_id": 57073422, "added_by": "sunil Forwarder", "type": "Misc", "update_type_id": 3, "author": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "self": "http://stg-api.mbsisystems.com/api/updates/534079142", "expand": "update" }, "status": "success" } |
Retrieve Order Update
Description: This endpoint retrieves the details of a specific update associated with an order.
Order updates represent activity logs, notes, or communications related to the order. By providing the order ID and update ID, this endpoint returns the detailed information for the specified update, including message content, update type, priority level, and visibility settings.
URL: /api/v140/orders/{order_id}/updates
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073422/updates |
Request Body: NA
Response:
{ "data": { "id": 534079142, "private": false, "priority": 2, "details": "Example update", "address": null, "created_at": "2026-03-09 17:27:51", "company_orderno": "103200-1", "order_id": 57073422, "added_by": "sunil Forwarder", "type": "Misc", "update_type_id": 3, "author": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "self": "http://stg-api.mbsisystems.com/api/updates/534079142", "expand": "update" } } |