List Customers Import Results

URL : /api/v1/customers-import-results/

Method : GET

Query parameters

Pagination

Default pagination is 20 results per page.

• limit - Number of results to return per page.

  • Example: limit=20
• offset - The initial index from which to return the results.

  • Example: offset=21

Filtering

The results can be filtered by various attributes on customer or related to the customer.

Possible filters:

• status__iexact

  • Choices: pending, running, error, success

Success Response

Code : 200 OK

Content examples :

{
    "count": 9,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 10,
            "file_name": "customers_example.csv",
            "status": "success",
            "created_at": "2021-03-15T10:01:03.456388Z",
            "started_at": "2021-03-15T10:01:06.939592Z",
            "finished_at": "2021-03-15T10:01:07.632023Z",
            "result": {
                "total_row_count": 2,
                "valid_row_count": 2,
                "invalid_rows": [],
                "created_customers_count": 0,
                "existed_customers_count": 2
            }
        },
        ...
    ]
}