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.

Attributes

Attribute	Type	Required	Description
name	string	✓	User defined name to identify the manifest.
address	Address object.	✓	The address to print on the manifest PDF.
created_at	integer	✓	Unix timestamp when the manifest was created.

Relationship	Type	Required	Description
shop	shop	✓	The shop to create the manifest for.
shipments	array of shipments	✓	The shipments that are to be manifested.
files	array of files		The files that are attached to the manifest.
contract	contract		A contract if you want to limit this manifest to a single carrier.