Skip to main content

Documents

Nautical provides document management capabilities for products, variants, sellers, and customers. This article provides instructions on how to use the document management feature in the Dashboard.

Centralized document management can be useful in a variety of scenarios, such as collecting documents during know-your-vendor (KYV) and know-your-customer (KYC) checks, providing onboarding materials for sellers, and making product specifications or user manuals available to buyers.

File size limits​

The file size limit is 5 MB. If you try to upload a document larger than 5 MB, the upload will return an error.

Supported file types​

You can upload the following document types:

File TypeFormat
Text Files
  • Plain Text (.TXT)
  • Rich Text Format (.RTF)
  • Comma-Separated Values (.CSV)
  • Illuminating Engineering Society (.IES)
Adobe Files
  • Portable Document Format (.PDF)
  • Encapsulated PostScript (.EPS)
  • PostScript (.PS)
Office Files
  • Microsoft Word Document (.DOC, .DOCX)
  • OpenOffice Text (.ODT)
  • Microsoft Excel Spreadsheet (.XLS, .XLSX)
  • OpenOffice Spreadsheet (.ODS)
  • Microsoft PowerPoint Presentation (.PPT, .PPTX)
  • OpenOffice Presentation (.ODP)
Image Files
  • Joint Photographic Experts Group (.JPG, .JPEG)
  • Portable Network Graphics (.PNG)
  • Graphics Interchange Format (.GIF)
  • Bitmap (.BMP)
  • Tagged Image File Format (.TIF, .TIFF)
  • Scalable Vector Graphics (.SVG)
  • WebP (.WEBP)
  • High Efficiency Image Format (.HEIC, .HEIF)
AutoCAD Files
  • AutoCAD Drawing (.DWG)
  • AutoCAD Drawing Exchange Format (.DXF)
Archive Files
  • ZIP Archive (.ZIP)
  • RAR Archive (.RAR)
  • TAR Archive (.TAR)
  • GZ Archive (.GZ)

Permissions​

To use the document management feature and add or view documents, you must have the "Manage documents" permission. In addition, you must have permission to manage the object you want to add the document to.

For instance, if you have the "Manage documents" permission but not the "Manage customers" permission, you won't be able to add or manage documents for customers. Similarly, seller staff members cannot add documents to other seller's products as their access is limited to the products they own.

Add a document​

  1. Go to the record you want to add the document to. You can add documents to products, variants, sellers, and customers.
  2. Go to the Media tab for products, or the Documents tab for sellers and customers.
  3. Under Documents, select the Add button (+).
  4. In the Upload Documents window, choose the file you want to upload:
    • Drag-and-drop a file into the upload area.
    • To browse and select the file on your device, click the upload area to launch a file browser.
  5. (Optional) Enter a Description for the document. This will be used as alternative (alt) text for the file.
  6. Select Confirm.

View a document​

You can view and download documents directly through your browser. When a document is created, a unique identifier called a Universal Unique Identifier (UUID) is generated to create the document's URL.

You can use this URL to link the document on your storefront, such as product spec sheets or other buyer-facing documents

Retrieve a document URL​

  1. Go to the record where the file was uploaded.
  2. Go to the Media tab for products, or the Documents tab for sellers and customers.
  3. Find the file in the Documents section.
  4. Select the file name to open it.
  5. Copy the URL from the address bar.

Document security​

Documents are stored in a private container, accessible through secure URLs with time-limited access tokens.

By default, these URLs are valid for one day but can be adjusted upon request to be shorter or longer, to a maximum of seven days. Contact Nautical Support to request a different time-limit to access document URLs.

When sharing URLs with customers, they will have a limited timeframe to access them. The document URL stored in the API and Dashboard will always return the most recent signed URL.

Edit the document description​

  1. Go to the record where the file was uploaded.
  2. Go to the Media tab for products, or the Documents tab for sellers and customers.
  3. Find the file in the Documents section, and then select the Edit button.
  4. Edit the Description as needed, and select Confirm when you're done.

Detach a document​

You can detach documents from the objects (product, variant, seller, or customer) they were originally added to.

note

Detaching the document does not delete the document or change the URL to access the document.

  1. Go to the record where the file was uploaded.
  2. Go to the Media tab for products, or the Documents tab for sellers and customers.
  3. Find the file in the Documents section, and then select the Delete button.

Delete a document​

Currently, you can only delete the documents through the API by calling the documentRemove mutation with the delete=true argument. Learn more in the API reference.

Was this page helpful?