Add a Product Download

POST /api/v2/products/{productId}/downloads.json

Add a Download item to a Product.

Scope

Requires the products OAuth scope.

Path parameters

Request body

Your request body must contain an object including:

Example

To add a Product Download you must POST JSON to this resource within a data object. The minimum requirement for a product download is a file value. In the example below we're supplying an image using a Data URI. 

{
    "data": {
        "file": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
    }
}

Importing downloads using a Data URI will result in a new filename based on the md5 of the file contents and it's location in the Media Library will be based on the file's mime type. However, this may not be desirable if you wish to maintain searchable filenames. You can define your preferred filename and/or directory for your Data URI using a Content URI request object, which consists of a src, filename and directory property (as illustrated below).

{
    "data": {
        "file": {
            "src": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
            "filename": "my-image-name.png",
            "directory": "˜/content/images/products"
        }
    }
}

Note that the directory, if supplied, must be a valid Content URI starting with ~/content. If the directory is not supplied it will be calculated based on the file's mime type.

Success responses

If the Product Download was created successfully you should receive a response with a 201 status code:

Error responses

If the Download could not be created you will encounter a response with a 422 status code: