The main focus of Transmission is the management of
Shipments, including the basic CrUD features and more in depth management.
In order to use the
Documents features, you must first have created a
Shipments instance, the guide to do so is here.
Note: Transmission does not host any identity services. Instead, you can use your own service by setting the PROFILES_URL in the environment.
Documents are tied to
Shipments instances, then they use a nested router, based off the id of the
Shipments instance you want to assign the
This means that you can only interact with
Documents if you have access to the
Documents can be one of three different file types,
JPEG, and must be noted as to which type it is upon creation with the field
There are three possible types of
Documents to upload,
OTHER, and are denoted by the field
Upon creation of a
Documents object, the response will include a link as to where to upload said document.
Once it has been uploaded, you need to update the
Documents instance with the
If it was successful, then Transmission will return alongside the
Documents information, a link to the document and its thumbnail.