Getting Collection Notes

Ship
api
shipment groups
collection notes

Ship's Collection Notes functionality enables you to generate driver's manifest documents for your shipments. This page explains how to retrieve collection notes.

Making a Collection Note Request

In Ship, a collection note (sometimes referred to as a driver's manifest) is a document listing items that are to be collected by a driver. It is intended to be printed and given to the driver at the point of collection.

In order to generate a note for a specific collection, you will need to tell Ship which shipments are to be picked up as part of that collection. You can do so using the Get Shipment Group Collection Note endpoint.

Note

This page explains how to generate a single collection note for a number of shipments that are being picked up together, for example as part of a scheduled collection.

You can also get a collection note for a single shipment via the Get Document endpoint, which is covered on the Getting Shipment Documents page.

Getting Collection Notes for a Shipment Group

To call Get Shipment Group Collection Note, send a GET request to https://api.sorted.com/pro/collection_notes/shipment_group/{reference}, where {reference} is the unique reference of the shipment group you want to get a collection note for.

Note

Ship generates a collection note for a shipment group at the point that the group is locked. As such, you can only get collection notes for locked shipment groups. If you attempt to get a collection note for an unlocked shipment group then Ship returns a 404 - Not Found error.

For more information on locking shipment groups, see the Locking and Unlocking Shipment Groups section of the Editing Shipment Groups page.

Alternatively, you can call Get Shipment Group Collection Note using a shipment's {custom_reference} and {version} by sending a GET request to https://api.sorted.com/pro/collection_notes/shipment_group/custom_reference/{custom_reference}/{version}. {version} must be either an integer or the value latest.

Ship returns a collection note listing the contents of all of the shipments in the specified group.

Note

For an explanation of versioning in Ship shipment groups, see the Versioning in Shipment Groups section of the Getting Shipment Groups page.
For full reference information on the Collection Notes API, see the Ship API reference.

All Collection Notes endpoints return a collection note as a document object with a document_type of collection_note.

The document object has four properties:

file - A base64-encoded byte array representing the file content.
content_type - The document's format (e.g. application/pdf).
document_type - The type of document (e.g. commercial_invoice).
dpi - The document's resolution in DPI.

The example shows a collection note request for shipment group sg_00693870520933731157514090446848.

Example Get Shipment Group Collection Note Request
Example Collection Note Response

GET https://api.sorted.com/pro/collection_notes/shipment_group/sg_00693870520933731157514090446848

  {
    "file": {Base64 file contents},
    "content_type": "application/pdf",
    "document_type": "collection_note",
    "dpi": 203
  }

Next Steps

See a Glossary of Ship terms: Glossary
Learn how to use REACT, Sorted's advanced shipment tracking product: REACT Docs