Manage shipping documents
By the end of this page you will have set up the documents your shipments need. That covers the ones Carriyo generates at booking, the ones your team uploads, and the sets you print together.
The four kinds of document
All shipping documents are configured on one page, Settings > Administration > Documents. It has three sections, and you create a combined document in the first.
| Kind | Section | What it does |
|---|---|---|
| Auto-generated document | Auto Generated Documents | Carriyo generates it from a template when a shipment is booked. For example, a commercial invoice or a packing list. |
| Combined document | Auto Generated Documents | Merges two or more of a shipment's PDF documents into one file that is stored on the shipment. Integrations and webhooks get it as one link. |
| Uploadable document | Uploadable Documents | A document type your team uploads by hand and attaches to shipments, orders and returns. For example, a certificate. |
| Document group | Document Groups | A set of documents you print together from the Dashboard print menu. Carriyo merges whichever of them the shipment has at the moment you print. |
The Auto Generated Documents list always starts with Carriyo's built-in documents. These are the Default Label, the Carriyo and carrier PDF and ZPL labels, and the Carrier Commercial Invoice. You can't edit, delete or switch them off. You can turn their Quick Print on or off.
Before you start
- You need the admin role.
- Document groups depend on your plan. If your plan doesn't include them, a lock icon shows next to the Document Groups heading.
1. Open the documents page
In the Carriyo Dashboard, open Settings. Under Administration, click Documents.
Documents is under Administration in Settings.
2. Add an auto-generated document
Add an auto-generated document.
- In Auto Generated Documents, click Add Document.
- Enter a Document Name. Names are unique across your account.
- Pick a Shipment Type: All Shipments, Forward Shipment or Reverse Shipment.
- Pick a Document Type, such as Commercial Invoice or Packing List. Only types with a template for your account are listed.
- Pick a Template Name. For a commercial invoice, Carriyo offers a standard and a returns template.
- Leave Document quick print on to show the document in the Quick Print menu on the Shipments list.
- Leave Document auto generation on, then click Add Document.
Name the document, pick its type and template.
Carriyo generates the document for every booked shipment of that shipment type while auto generation is on.
3. Add an uploadable document (optional)
Use this when your team receives a document outside Carriyo and needs to attach it to shipments.
- In Uploadable Documents, click Add Uploadable Document.
- Enter a Document Name and pick a Shipment Type.
- Pick a Document Type. Uploadable documents can also be a Certificate or Other. They have no template.
- Set the quick print and status toggles, then click Add Uploadable Document.
Uploadable documents can also be a certificate or other.
To upload the file itself to a shipment, see Upload a carrier document.
4. Add a combined document (optional)
A combined document merges several of a shipment's documents into one PDF, in the order you choose. A packer opens one file and prints the label and invoice together.
- In Auto Generated Documents, click Add Document.
- Enter a Document Name.
- Pick a Shipment Type. Set it before picking members, because it decides which of your documents can be combined.
- Set Document Type to Combined. The Template Name field and the quick print toggle disappear, and Documents to combine appears.
- In Documents to combine, select two or more documents in the order they should be merged. Each selected document shows its position, such as 1. and 2.
- Leave Document auto generation on, then click Add Document.
Set Document Type to Combined.
Pick the members in the order they're merged.
You can combine these documents:
- Carriyo PDF Label, Carrier PDF Label and Carrier Commercial Invoice.
- Your active auto-generated documents. One set to All Shipments can join any combined document. One set to Forward Shipment or Reverse Shipment can only join a combined document with the same shipment type. Other documents are grayed out with the reason.
- Your active uploadable documents.
ZPL labels, document groups and other combined documents can't be combined.
A document generated for another shipment type is greyed out.
When the combined document appears on a shipment
Carriyo adds the combined document to a shipment once every document in it is on the shipment. Until then, it doesn't appear at all. It then shows in the shipment's Documents list, with the shipment's other documents.
A combined document that includes the Carrier Commercial Invoice is only added to cross-border shipments. Domestic shipments have no carrier commercial invoice, so all their other documents can be present and the combined document still won't appear.
Combined documents aren't offered in Quick Print, so their list row has no Quick Print toggle.
The combined document is listed with the generated documents.
Edit a combined document
You can rename it, change its members or shipment type, and switch it on or off. You can't change a combined document into another kind, or another document into a combined one. Delete it and add a new one instead.
5. Add a document group (optional)
A document group lets you print several documents with one click from the Dashboard print menu. Carriyo merges the group's PDFs into one print job when you print, using whichever of them the shipment has. Nothing is stored on the shipment.
Choose a group when only your team prints from the Dashboard. Choose a combined document when an integration or a print service needs one file from the shipment itself.
- In Document Groups, click Add Group Document.
- Enter a Name, such as
Domestic. - In Documents, select the documents to print together. Only active documents are listed. You can't mix PDF and ZPL label templates in one group.
- Set Document Group quick print, then click Add Group.
A document group prints several documents together.
Combined documents can't join a group.
6. Switch off, edit or delete a document
- Switch off. Use the Status toggle on the document's row. Carriyo stops generating it for new shipments.
- Edit. Click the document's name, or open the row's actions menu and click Edit.
- Delete. Open the row's actions menu and click Delete. The Dashboard also removes a deleted document from any document group, and deletes a group left with no documents.
- View history. Open the row's actions menu and click View Logs to see who changed the document and when.
Edit, view the history of, or delete a document from its actions menu.
While an active combined document uses a document, you can't delete that document or switch it off. Carriyo names the combined document in the error. Remove the document from the combined document first, then try again.
When combined documents help
- Printing outside the Dashboard. A print service or warehouse system reads one link from the shipment instead of collecting several documents.
- Carrier paperwork in a fixed order. Some carriers expect the invoice behind the label. The merge order you pick is the order in the PDF.
- Knowing the set is complete. A combined document only appears once every document in it exists, so nobody prints a label without its invoice.
Common mistakes
- Adding the Carrier Commercial Invoice to a combined document for all your shipments. Domestic shipments have no carrier commercial invoice, so the combined document never appears on them. To cover domestic shipments too, add a second combined document without it. Cross-border shipments then get both.
- Using the Carrier PDF Label with a carrier that only returns ZPL labels. Carriyo doesn't convert a carrier's ZPL label to PDF, so the combined document never appears. Use the Carriyo PDF Label instead.
- Mixing shipment types. A document set to Forward Shipment can't join a combined document for Reverse Shipment or All Shipments. Give both the same shipment type, or set the document to All Shipments.
- Deleting or switching off a document that a combined document uses. Carriyo blocks it while the combined document is active, and the error names it. Remove the document from the combined document first, or switch the combined document off.
- Looking for a combined document in Quick Print. It isn't in the print menus. Open it from the shipment's Documents list instead.