documents

List documents for a shipment

Changed on
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Retrieve the carrier documents registered against a shipment, including their processing status.

get/v2/shipments/{shipment_id}/documents

Request

  • Base URL
    https://api.shipstation.com
  • URL
    https://api.shipstation.com/v2/shipments/{shipment_id}/documents
  • Auth
    API key in header api-key

Response

The request was a success.

document_idstring

The unique identifier of the document.

type'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'

The type of carrier document being registered. Supported values vary by carrier. See the Carrier Document Upload guide for the document types each carrier accepts.

file_namestring

The file name of the document.

status'awaiting_upload' | 'processing' | 'processing_claimed' | 'invalid' | 'uploaded' | 'queued' | 'sent' | 'failed'

The processing status of a carrier document.

  • awaiting_upload - The document has been registered and is waiting for the file to be uploaded to the provided upload target.
  • processing - The uploaded file is being processed.
  • processing_claimed - The document has been claimed for processing.
  • invalid - The document failed validation and cannot be used.
  • uploaded - The file has been uploaded successfully and is ready to be sent to the carrier.
  • queued - The document is queued to be sent to the carrier.
  • sent - The document has been transmitted to the carrier.
  • failed - Sending the document to the carrier failed.
errorstring nullable

A description of the error when the document is invalid or failed; otherwise null.

external_idstring nullable

The carrier-assigned identifier for the document once it has been sent; otherwise null.

Example response

[
  {
    "document_id": "7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d",
    "type": "usmca_commercial_invoice_certification_of_origin",
    "file_name": "usmca-certification-of-origin.pdf",
    "status": "awaiting_upload",
    "error": "The uploaded file could not be read.",
    "external_id": "1Z999AA10123456784"
  }
]

Changes

  • 4e29670aa28dRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • bf3618aaf7e1Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status