Order Assignments

Orders flow consists in assign appraisers to do the inspections. Once an assignment is made, it can be accepted or rejected by them.

Appraiser's endpoints

Accept assignment

This endpoint allows appraisers to accept their orders assignments.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Form attributes

  • Name
    fee_condition
    Type
    decimal
    Description

    If the appraiser has a fee condition to accept the assignment, it can be informed on this field.

  • Name
    due_date_condition
    Type
    date
    Description

    If the appraiser has a due date condition to accept the assignment, it can be informed on this field.

  • Name
    comments
    Type
    string
    Description

    If the appraiser has any comment as a condition to accept the assignment, it can be informed on this field.

Request

PUT
/api/v1/orders/{order_id}/accept_assignment
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/accept_assignment' \
  --header 'X-API-KEY: {api_key}'
  --form 'comments="I will need one more day"' \

Response

{
  "success": true
}

Reject assignment

This endpoint allows appraisers to reject their orders assignments.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Form attributes

  • Name
    reason
    Type
    string required
    Description

    The assignment rejection reason.

Request

PUT
/api/v1/orders/{order_id}/reject_assignment
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/reject_assignment' \
  --header 'X-API-KEY: {api_key}'
  --form 'reason="I am on vacation"' \

Response

{
  "success": true
}

Staff's endpoints

Approve assignment condition

This endpoint allows staff users to approve the appraiser's conditions for an assignment.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Request

PUT
/api/v1/orders/{order_id}/approve_assignment_condition
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/approve_assignment_condition' \
  --header 'X-API-KEY: {api_key}'

Response

{
  "success": true
}

Reject assignment condition

This endpoint allows staff users to reject the appraiser's conditions for an assignment.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Request

PUT
/api/v1/orders/{order_id}/reject_assignment_condition
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/reject_assignment_condition' \
  --header 'X-API-KEY: {api_key}'

Response

{
  "success": true
}