Shipment Statuses
=================

A shipment status is basically a wrapper to combine and structure information from different sources, without losing valuable information.
It consists of one of our generic :doc:`statuses </api/resources/statuses>` in most cases combined with one or more of the many carrier specific statuses.

Please read the page on :doc:`retrieving shipment statuses </api/retrieve-shipment-statuses>` for a detailed explanation and example of this resource.

.. seealso::
    `<https://api-specification.myparcel.com/#tag/Shipments/paths/~1shipments~1{shipment_id}~1statuses/get>`_

Shipment Status
---------------

================  ===========
Attribute         Description
================  ===========
carrier_statuses  an array of `carrier-statuses </api/resources/shipment-statuses.html#carrier-status>`_ (empty when the shipment is not yet registered)
errors            an array of `error objects <http://jsonapi.org/format/#errors>`_ when the carrier returned errors during shipment registration
================  ===========

============  ===========================================  ===========
Relationship  Type                                         Description
============  ===========================================  ===========
shipment      :doc:`shipments </api/resources/shipments>`  The shipment having this status.
status        :doc:`statuses </api/resources/statuses>`    Our generic status belonging to this carrier specific status.
============  ===========================================  ===========

Carrier Status
______________

==============  ===========
Attribute       Description
==============  ===========
category        The category code of this status update. If the value is not ``default``, some action might be required by the sender or recipient.
code            Status code we received from the carrier.
description     Description of the status code we received from the carrier.
assigned_at     Unix timestamp of the status update according to the carrier.
tracking_code   The tracking code that was used to get this carrier status.
==============  ===========