Log a Sale
If you want to automatically archive applicants in Approve Owl after they've been sold, you can do so by logging a sale.
Request
Requires Authorization
POST: https://sandbox.approveowl.com/api/v1/logged_sales/
Required Parameters:
| Parameter | Type | Description |
|---|---|---|
| sale_id | string | The id of the sale used in your DMS |
| phone_number | string | The phone number for the applicant in Approve Owl |
| sale_date | string | The date of the sale in YYYY-MM-DD format |
Optional Parameters:
| Parameter | Type | Description |
|---|---|---|
| full_name | string | The name of the customer. For notation purposes only. |
| customer_id | string | If your DMS tracks customers with a different id from the sales id. |
| sale_status | string | If you want to categorize the sale a certain way. This should match your DMS. Examples: "Pending", "Wholesale", "Complete" |
| sale_value | number | For life-time value (LTV) calculations. You can send whatever value you want Examples: the down payment amount, the retail amount or the total financed amount. |
| sales_rep_username | string | If you want to attribute the sale to a user in Approve Owl. It should be the email address of the user. |
Example Request Body
{
"sale_id": "A1007",
"phone_number": "254-555-1111",
"sale_date": "2021-03-11",
"full_name": null,
"customer_id": null,
"sale_status": null,
"sale_value": null,
"sales_rep_username": null
}Example Response
You will receive back Approve Owl's internal representation of the sale.
{
"organization_id": "f67b7f05-e0c8-40db-a539-c286236fc12e",
"phone_number": "+12545551111",
"sale_date": "2021-03-11",
"customer_id": null,
"full_name": null,
"sale_status": null,
"sale_value": null,
"sales_rep_username": null,
"id": "f5a8f1cd-3d42-4e0f-9b53-5f318c6f6ab3",
"sale_id": "A1007",
"created_at": "2021-03-11T10:10:53.908-05:00",
"updated_at": "2021-03-11T10:10:53.908-05:00"
}