ShipmentDocuments
Returns the list of documents associated with the specified shipment.
View-Specific Information
Select
The add-in will use the ShipStation API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- ShipmentId supports the following operator: =.
SELECT * FROM ShipmentDocuments WHERE ShipmentId = 'se-2345'
Columns
| Name | Type | References | Description |
| ShipmentId | String |
Shipments.Id | The shipment Id to retrieve documents for. |
| DocumentId [KEY] | String | A string that uniquely identifies the document. | |
| Type | String | The type of carrier document.
The allowed values are commercial_invoice, certificate_of_origin, usmca_commercial_invoice_certification_of_origin, usmca_certification_of_origin, pro_forma_invoice, other, authorization_form, export_accompanying_document, export_license, import_permit, one_time_nafta, power_of_attorney, packing_list, sed_document, shippers_letter_of_instruction, declaration, section_232_customs_affidavit. | |
| FileName | String | The file name of the document, including its extension. | |
| Status | String | The processing status of the document.
The allowed values are awaiting_upload, processing, processing_claimed, invalid, uploaded, queued, sent, failed. | |
| Error | String | The error message if the document failed to process. | |
| ExternalId | String | The external Id associated with the document. |