List Downloads for a given Product

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

Get or search for one or more downloads associated with a Product using a range of accepted query parameters.

Scopes

Requires either the products or products.readonly OAuth scope.

Path Parameters

productId required
The product ID is required.


Query Parameters

Accepts the following query parameters:

id:in
Return downloads for a product by a comma-separated list of IDs.
id:min
Return downloads with an ID greater than or equal to that specified.
id:max
Return downloads with an ID less than or equal to that specified.
id:after
Return downloads with an ID greater than that specified.
id:before
Return downloads with an ID less than that specified.
visibility

Return downloads by their visibility status:

  • public
  • contact
  • purchase


JSON response

Evance will return a JSON object containing the following properties:

success
A successful search request containing zero or more results will always return a true value.
status
An integer matching the HTTP response code. A successful request will have a status of 200.
data
An array containing zero or more Product Download data objects.
pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.
  • limit - the number of results to return per page
  • page - the current page number
  • total - the total number of available results
  • totalPages - the total number of available pages of results
links
An object containing links to traverse available search results.
  • self - the URL for the current search.
  • previous - a URL for the previous results page, or null if there isn't one.
  • next - a URL for the next results page, or null if there isn't one


Example response

In the example below you're able to see examples of a product download returned in this API.

{
    "success": true,
    "status": 200,
    "data": [
        {
            "id": 48646,
            "productId": 3066,
            "file": "https://cdn.evance.me/portal/web/0/content/downloads/be05aa4b29f41eb94c6f4bb5a36370be.zip",
            "title": null,
            "description": null,
            "sequence": 1,
            "visibility": 'public',
            "createdOn": "2022-05-21T15:54:05+00:00",
            "createdBy": null,
            "modifiedOn": "2022-05-21T15:54:05+00:00",
            "modifiedBy": null
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/products/3066/downloads.json",
        "previous": null,
        "next": null
    }
}