Reports
=======

Reports are user generated collections of their shipments, generated based on a set of filters.

.. seealso::
    https://api-specification.myparcel.com/#tag/Reports

Report
------

==========  =======  ===========
Attribute   Type     Description
==========  =======  ===========
name        string   User defined name to identify the report.
filters     object   List of filter criteria to determine the shipments represented in the CSV. Required properties are ``date_from`` and ``date_to``. All filter properties can be found in the `API specification <https://api-specification.myparcel.com/#tag/Reports/paths/~1reports/post>`_.
created_at  integer  Unix timestamp when the report was created.
==========  =======  ===========

============  =========================================  ===========
Relationship  Type                                       Description
============  =========================================  ===========
status        :doc:`statuses </api/resources/statuses>`  Our generic status indicating if the report has been completed.
file          :doc:`files </api/resources/files>`        The CSV file once it is available.
============  =========================================  ===========

Report statuses
_______________

==================  ===========
Status code         Description
==================  ===========
report-queued       The initial status of a report.
report-in-progress  The CSV file is currently being created.
report-finished     The CSV file is available.
report-failed       An error has occurred.
==================  ===========

.. note::
    Only reports with the status ``report-finished`` or ``report-failed`` can be deleted.