# Uploads file ## Shipments uploads file > Uploads supporting documents to a specific shipment by its ID. \ > This method is used for attaching invoices, product specifications, customs declarations, or other shipment-related documents required for processing and clearance. \ > Files are stored and linked to the shipment, ensuring better traceability and compliance.\ > \ > ⚠️ Region restriction:\
\ > This method is available only for European shipments (EU/EU and EU/UA directions).\
\ > It is not available for shipments originating from Ukraine.\ > \ > File naming: \ > • If the "fileName" parameter is provided, the uploaded file will be stored with that name. \ > • If "fileName" is not provided, the default file name will be set to "invoice".\ > \ > Use cases: \ > 1\) "I want to upload a client invoice in PDF to shipment 980911" - send the base64-encoded content in "file", set \`"fileName": "invoice.pdf"\`. \ > 2\) "I want to attach a product photo in JPEG" - encode the photo in base64, set \`"fileName": "product-photo.jpeg"\`.\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```json {"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Shipments"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.pl/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/shipments/uploads/{id}":{"post":{"tags":["Shipments"],"description":"Uploads supporting documents to a specific shipment by its ID. \nThis method is used for attaching invoices, product specifications, customs declarations, or other shipment-related documents required for processing and clearance. \nFiles are stored and linked to the shipment, ensuring better traceability and compliance.\n\n⚠️ Region restriction:
\nThis method is available only for European shipments (EU/EU and EU/UA directions).
\nIt is not available for shipments originating from Ukraine.\n\nFile naming: \n• If the \"fileName\" parameter is provided, the uploaded file will be stored with that name. \n• If \"fileName\" is not provided, the default file name will be set to \"invoice\".\n\nUse cases: \n1) \"I want to upload a client invoice in PDF to shipment 980911\" - send the base64-encoded content in \"file\", set `\"fileName\": \"invoice.pdf\"`. \n2) \"I want to attach a product photo in JPEG\" - encode the photo in base64, set `\"fileName\": \"product-photo.jpeg\"`.\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"name":"id","in":"path","description":"Unique identifier of the shipment to which the files are attached.
\nThis value represents the `shipmentId` of the European system.
\nUsing a Ukrainian shipment number will result in a validation error.\n","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"JSON body containing the base64-encoded file and optional file name.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Base64-encoded document file (PDF, JPEG, or other supported formats)."},"fileName":{"type":"string","description":"Optional file name. Defaults to \"invoice\" if not provided."}}}}}},"responses":{"201":{"description":"File upload result","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the file upload was successful."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Shipments uploads file"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api-portal.novapost.com/metodi-1/methods/shipments/uploads-file.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.