Files

Use the files resource to manage all artifacts that you upload:

  • Magento 2 ZIP files (.zip)
  • PDF documents for user guides, installation guides, and reference manuals
  • Product icons
  • Image files for galleries
  • Image files for your personal and company profile

Each file upload receives a unique ID. You must associate these IDs with your submission later using the packages API.

You can associate a file with multiple products. This allows for asset sharing across different packages. For example, you can share an image file for a gallery with different packages by associating it with the same file upload ID.

All files that you upload are inspected for malware. We only accept packages for further review if all associated files have passed the malware inspection.

File uploads

Use this API to upload files, retrieve file upload status, and remove files.

1
2
GET /rest/v1/files/uploads/:file_upload_id
POST /rest/v1/files/uploads

Get a file upload

Use the upload ID to retrieve details about a file upload.

1
GET /rest/v1/files/uploads/:file_upload_id

Parameters:

Field Type Description
file_upload_id URL element The file_upload_id string that was returned when uploading or listing the file.
offset int Index of the first element to return in the response. Used for pagination.
limit int Maximum number of list items to return in the response. Used for pagination.

Sorting and filtering parameters are currently not available for this endpoint.

If the file_upload_id parameter is specified, a single file record will be returned. If it is omitted, then a batch response will be returned: an array of records for all files uploaded by the current user.

Request:

1
2
3
curl -X GET \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     https://developer-stg-api.magento.com/rest/v1/files/uploads/5c129cd41ba478.65767699.1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
{
    "file_upload_id" : "5c129cd41ba478.65767699.1",
    "filename" : "icon.png",
    "content_type" : "image/png",
    "size" : 123456,
    "malware_status" : "pass",
    "file_hash" : "f53f5db985b8815f1ce6fd4b48a0439a",
    "submission_ids" : [
    ],
    "is_profile_image" : false,
    "url" : "https://mp-stg-static.magento.com/user/68/f3/68f360d3516f594fc957c4179ed4a7a872911f07/pub/f5/3f/f53f5db985b8815f1ce6fd4b48a0439a/icon.png"
}

Response field details:

Field Type Description
file_upload_id string Unique identifier for the file
filename string The name of the file sent in the request.
content_type string The mime-type for which the file was uploaded.
size integer The size of the file in bytes.
malware_status string Malware check result for this file. Valid values include: pass, fail, in-progress.
file_hash string Hash of the file; currently md5. Only set if malware_status is pass.
url string The URL from which the file may be downloaded, if applicable.
submission_ids array The list of package submissions associated with this file, if any.

The order of fields may differ, and additional fields may also be returned.

Upload files

Upload files in bulk using the multipart/form-data encoding type. With this approach, binary files can be uploaded without the need for additional encoding, which could otherwise result in an increase in overall upload size.

1
POST /rest/v1/files/uploads

A sample request body of mime type, multipart/form-data with a boundary string of UNIQUE_BOUNDARY_TOKEN is shown below:

The boundary marker must be part of the request Content-Type header and it must be a single line with no line breaks.

1
Content-Type: multipart/form-data; boundary=UNIQUE_BOUNDARY_TOKEN

For more info on multipart/form-data requests, see the IETF specification

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
--UNIQUE_BOUNDARY_TOKEN
Content-Disposition: form-data; name="file[]"; filename="acme_one-click-checkout.zip"
Content-Type: application/zip

<zip file content here.....>

--UNIQUE_BOUNDARY_TOKEN
Content-Disposition: form-data; name="file[]"; filename="icon.png"
Content-Type: image/png

<image file content here.....>

--UNIQUE_BOUNDARY_TOKEN
Content-Disposition: form-data; name="file[]"; filename="acme-logo.png"
Content-Type: image/png

<image file content here.....>

--UNIQUE_BOUNDARY_TOKEN
Content-Disposition: form-data; name="file[]"; filename="user.pdf"
Content-Type: application/pdf

<pdf file content here....>

--UNIQUE_BOUNDARY_TOKEN--
  • Each part has a header and body.
  • The body of each part is the full contents of the raw file.
  • The header has the following required elements:
Element Type Description
Content-Disposition string MUST be form-data
name string MUST be file[] for all parts.
filename string Should be the original name of the file.
Content-Type string Should be the correct mime-type for the file.

Recognized Content-Types

File Type Recognized Content-Type Usage
png image/png avatar, gallery
jpg / jpeg image/jpeg avatar, gallery
gif image/gif avatar
pdf application/pdf document
zip application/zip package
zip application/x-zip-compressed package
zip application/octet-stream package

Request:

If the request body given above was saved into a temporary file at /tmp/files-payload, you may use it in your POST request to upload the files:

1
2
3
4
5
curl -X POST \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     -H "Content-Type: multipart/form-data; boundary=UNIQUE_BOUNDARY_TOKEN" \
     --data-binary  @/tmp/files-payload \
     https://developer-stg-api.magento.com/rest/v1/files/uploads

Response:

The above request gives an output similar to:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[
  {
    "filename" : "acme_one-click-checkout.zip",
    "content_type" : "application/zip",
    "size" : 182934,
    "file_upload_id" : "5c11e656057b42.97931218.5"
  },

  {
    "filename" : "icon.png",
    "content_type" : "image/png",
    "size" : 37492,
    "file_upload_id" : "5c129cd41ba478.65767699.1"
  },

  {
    "filename" : "acme-logo.png",
    "content_type" : "image/png",
    "size" : 6825,
    "file_upload_id" : "5c644fa344e5d7.04253635.8"
  },

  {
    "filename" : "user.pdf",
    "content_type" : "application/pdf",
    "size" : 48392,
    "file_upload_id" : "5c644d97bb7c41.37505716.6"
  }
]

The response is the list of files in the same order sent during the upload request.

Each record in the list has the following fields:

Field Type Description
filename string The name of the file sent in the request.
content-type string The mime-type of the uploaded file.
size integer The size of the file in bytes.
file_upload_id string A unique identifier for the file.

The file_upload_id must be tracked for subsequent package submission API endpoints.