Applies to integrated customers using the RecoveryConnect APIGet Order Address Details
Description: Retrieves all address details associated with a specific order by its unique ID.
URL: /api/v130/orders/{order_id}/addresses
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders/16644411/addresses |
Request Body: NA
Response:
{{ "data": [ { "id": 23, "lpr_hit_id": null, "company_id": 10001, "parent_id": null, "orders_id": 22, "address_id": 56712, "order_person": null, "category": 3, "dwelling": null, "object_id": 10, "dwelling_type": 1, "employee": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 0, "is_pickup": 0, "is_reference": null, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 56712, "name": "0", "address_1": "730 Paradise Lane", "address_2": null, "unit": null, "zip": 48336, "type": 1, "latitude": 33.65031449, "longitude": -117.24815155, "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-10-29 19:01:18", "updated_at": "2017-12-13 01:21:33", "deleted_at": null, "migration": null, "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ], "zip_code_details": { "zip_code_id": 48336, "zip_code": "92507", "zip_code_city_id": 48330, "city_name": "Riverside", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-Riverside", "zip_code_county_id": 47953, "county_name": "Riverside", "latitude": 33.976325, "longitude": -117.330414, "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.274844\",\"34.004654\",\"0.0\"],[\"-117.268245\",\"33.940869\",\"0.0\"],[\"-117.289141\",\"33.924923\",\"0.0\"],[\"-117.37657\",\"33.968912\",\"0.0\"],[\"-117.339179\",\"34.0195\",\"0.0\"],[\"-117.336429\",\"34.0195\",\"0.0\"],[\"-117.305637\",\"34.0195\",\"0.0\"],[\"-117.274844\",\"34.004654\",\"0.0\"]]" } }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null }, "dwelling_details": { "id": 3, "name": "unverified", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null } } ] }
} |
Update Order Address Details
Description: Updates the details of a specific address associated with an order, identified by order_id and address_id.
URL: /api/v130/orders/{order_id}/addresses/{address_id}
Method: PUT
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| is_accepted | Boolean flag (0 = No, 1 = Yes) indicating whether the address update is accepted | Yes | 1 |
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders/16644246/addresses/17664959 |
Request Body: NA
Response:
{ "data": { "id": 23, "lpr_hit_id": null, "company_id": 10001, "parent_id": null, "orders_id": 22, "address_id": 56712, "order_person": null, "category": 3, "dwelling": null, "object_id": 10, "dwelling_type": 1, "employee": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 0, "is_pickup": 0, "is_reference": null, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 56712, "name": "0", "address_1": "730 Paradise Lane", "address_2": null, "unit": null, "zip": 48336, "type": 1, "latitude": 33.65031449, "longitude": -117.24815155, "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-10-29 19:01:18", "updated_at": "2017-12-13 01:21:33", "deleted_at": null, "migration": null, "phones": [ { "id": 11314, "type": 6, "mobile_carrier_id": null, "number": "123456", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-06-10 10:53:41", "updated_at": "2020-06-10 10:53:41", "migration": null, "address_with_number": "No Address" } ], "zip_code_details": { "zip_code_id": 48336, "zip_code": "92507", "zip_code_city_id": 48330, "city_name": "Riverside", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-Riverside", "zip_code_county_id": 47953, "county_name": "Riverside", "latitude": 33.976325, "longitude": -117.330414, "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.274844\",\"34.004654\",\"0.0\"],[\"-117.268245\",\"33.940869\",\"0.0\"],[\"-117.289141\",\"33.924923\",\"0.0\"],[\"-117.37657\",\"33.968912\",\"0.0\"],[\"-117.339179\",\"34.0195\",\"0.0\"],[\"-117.336429\",\"34.0195\",\"0.0\"],[\"-117.305637\",\"34.0195\",\"0.0\"],[\"-117.274844\",\"34.004654\",\"0.0\"]]" } }, "category_details": { "id": 3, "name": "borrower_home", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null }, "dwelling_details": { "id": 3, "name": "unverified", "friendlyname": "Borrower - Home", "created_at": "2020-06-02 16:44:26", "updated_at": "2020-06-02 16:44:26", "deleted_at": null } } } |