Manifests
=========

Manifests are used to group shipments together for administrative purposes and allow for a manifest PDF to be generated.

Our manifests support shipments from multiple carriers by default and have two PDF files generated by our system: one summarized and one itemized with all shipments listed separately. Some of the more advanced carriers have support for manifests in their API and generate their own manifest documents. To make a manifest for one specific carrier, you can assign a ``contract`` relationship to it.

With a ``contract`` relationship, the ``shipments`` relationship must only contain shipments registered with that contract. If the carrier supports manifests, we will send them the necessary information and include the documents they generate in the ``files`` relationship as well.

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

Attributes
----------

.. list-table::
   :header-rows: 1
   :width: 100%
   :widths: 20 20 10 50

   * - Attribute
     - Type
     - Required
     - Description
   * - name
     - string
     - ✓
     - User defined name to identify the manifest.
   * - address
     - :doc:`Address </api/resources/common-objects/addresses>` object.
     - ✓
     - The address to print on the manifest PDF.
   * - created_at
     - integer
     - ✓
     - Unix timestamp when the manifest was created.

.. list-table::
   :header-rows: 1
   :width: 100%
   :widths: 20 20 10 50

   * - Relationship
     - Type
     - Required
     - Description
   * - shop
     - :doc:`shop </api/resources/shops>`
     - ✓
     - The shop to create the manifest for.
   * - shipments
     - array of :doc:`shipments </api/resources/shipments>`
     - ✓
     - The shipments that are to be manifested.
   * - files
     - array of :doc:`files </api/resources/files>`
     -
     - The files that are attached to the manifest.
   * - contract
     - :doc:`contract </api/resources/contracts>`
     -
     - A contract if you want to limit this manifest to a single carrier.