{"templateId":"markdown","versions":[{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/shipping/documents-carrier-upload","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/docs/shipping/documents-carrier-upload","default":true,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/shipping/documents-carrier-upload","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Carrier Document Upload","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"carrier-document-upload","__idx":0},"children":["Carrier Document Upload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Document Upload lets you submit self-prepared customs paperwork — such as Pro Forma Invoices, USMCA forms (for example, the USMCA Certification of Origin), and other supporting documents — directly to the carrier. Use it whenever a shipment requires supplemental international documentation, helping to prevent customs delays and delivery issues."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Documents can be provided at either the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["shipment level"]}," or the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["label level"]}," — that is, before or after a label is generated:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Shipment level (before a label exists)."]}," Register the document with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#register-a-document"},"children":["Register a document for a shipment"]},". Documents registered at the shipment level are forwarded to the carrier automatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Label level (after a label is generated)."]}," Register the document with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#register-a-document"},"children":["Register a document for a label"]},", then call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#send-documents-to-the-carrier"},"children":["Send label documents"]}," to transmit it to the carrier."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable document upload for a shipment or label, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending_documents"]}," flag on the shipment's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customs"]}," object."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["step-by-step instructions on uploading documents through the ShipStation API dashboard"]},", see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/50888603341211"},"children":["Customs Declarations: Document Upload help article"]},". This is useful for operations teams who need to upload documents manually or as a fallback if API integration issues occur."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"LIMITED AVAILABILITY"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Carrier Document Upload is currently supported for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UPS"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["FedEx"]}," only. Accepted document types and file size vary by carrier — expand the lists below for the full set."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["FedEx accepted document types"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_commercial_invoice_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pro_forma_invoice"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["UPS accepted document types"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certificate_of_origin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_commercial_invoice_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorization_form"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["export_accompanying_document"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["export_license"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["import_permit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["power_of_attorney"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["packing_list"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sed_document"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shippers_letter_of_instruction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declaration"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"IMPORTANT"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have uploaded a document and sent it to the carrier, it cannot be deleted or modified. Please ensure all information is accurate before finalizing."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":1},"children":["Requirements"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"account-setup--prerequisites","__idx":2},"children":["Account setup & prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For standalone UPS accounts, you must have a valid 6-digit UPS shipper number enabled for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Upload Forms Created Offline\""]}," to avoid API errors."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ups-document--upload-restrictions","__idx":3},"children":["UPS document & upload restrictions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Limit"},"children":["Limit"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum 10 MB per file. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Maximum 50 MB total per request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quantity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum 13 files per request. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Maximum 13 documents total per shipment."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":4},"children":["How it works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uploading a document is a three-step flow:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Register the document."]}," Call the register endpoint with the document ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file_name"]},". The response returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["document_id"]}," and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["upload"]}," target — a pre-signed Amazon S3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," and a set of form ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Upload the file to Amazon S3."]}," Send an HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multipart/form-data"]}," to the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["upload.url"]},", including every key/value pair from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["upload.fields"]}," exactly as returned, followed by a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file"]}," part containing the document content."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send to the carrier."]}," Once the file is uploaded, call the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#send-documents-to-the-carrier"},"children":["send documents"]}," endpoint to transmit all of the label's documents to the carrier."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can register documents against either a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["shipment"]}," or a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["label"]},". When you register against a label, ShipStation resolves the carrier, tracking number, and transaction details automatically from the label."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":5},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/labels/{label_id}/documents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register a document against a label and receive S3 upload URL"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/labels/{label_id}/documents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List documents for a label"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/labels/{label_id}/documents/{document_id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a document (only before sending to carrier)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/labels/{label_id}/documents/send"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transmit all uploaded documents to the carrier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/documents/{document_id}/download"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download a document file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{shipment_id}/documents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register a document against a shipment and receive S3 upload URL"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{shipment_id}/documents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List documents for a shipment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{shipment_id}/documents/{document_id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a shipment document (only before creating a label)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/shipments/{shipment_id}/labels"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List shipments and their document statuses"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-document-types","__idx":6},"children":["Supported document types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The document types a carrier accepts differ. Use a value from the table below that is supported by the carrier on your label or shipment."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Document type"},"children":["Document type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"FedEx"},"children":["FedEx"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"UPS"},"children":["UPS"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certificate_of_origin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_commercial_invoice_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usmca_certification_of_origin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pro_forma_invoice"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorization_form"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["export_accompanying_document"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["export_license"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["import_permit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["power_of_attorney"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["packing_list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sed_document"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shippers_letter_of_instruction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declaration"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✓"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-file-formats","__idx":7},"children":["Supported file formats"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Documents can be uploaded in the following formats. If you omit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," when registering, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PDF"]}," is used."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PDF"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PNG"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"document-statuses","__idx":8},"children":["Document statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After a document is registered, its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," reflects where it is in the upload and send flow:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["awaiting_upload"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The document is registered and waiting for the file to be uploaded to the provided upload target."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["processing"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The uploaded file is being processed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["processing_claimed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The document has been claimed for processing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The document failed validation and cannot be used."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uploaded"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The file was uploaded successfully and is ready to be sent to the carrier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queued"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The document is queued to be sent to the carrier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The document was transmitted to the carrier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sending the document to the carrier failed."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"full-api-reference","__idx":9},"children":["Full API reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For complete request and response details for all document upload endpoints, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/openapi/documents"},"children":["Documents API reference"]},"."]}]},"headings":[{"value":"Carrier Document Upload","id":"carrier-document-upload","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Account setup & prerequisites","id":"account-setup--prerequisites","depth":3},{"value":"UPS document & upload restrictions","id":"ups-document--upload-restrictions","depth":3},{"value":"How it works","id":"how-it-works","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Supported document types","id":"supported-document-types","depth":2},{"value":"Supported file formats","id":"supported-file-formats","depth":2},{"value":"Document statuses","id":"document-statuses","depth":2},{"value":"Full API reference","id":"full-api-reference","depth":2}],"frontmatter":{"slug":"/upload-carrier-documents","seo":{"title":"Carrier Document Upload"}},"lastModified":"2026-06-24T18:06:56.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/upload-carrier-documents","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}