Viewing products

Use this api to gather all products and search for products/variants to link/unlink assets.

Search for products

To view products send a GET request to

https://app.digital-downloads.com/api/v1/products

To find products you can add query string parameters. The results are paginated use query string parameter page for more pages, or use the links provided in the response.

{
    "limit": 100, // max of 1000 will be retuned
    "name": "my new book", // searches name of product/vairant
    "sku": "my-sku",
    "product_id": 123456, // product_id that is generated by Shopify 
    "vendor": "my-store",
    "tag": "books",
    "page": 3,
    "with_assets": false // show linked assets
}

Response

{
    "data": [
        {
            "id": "82664d96-6dfd-4343-96b0-05c46f412a5q",
            "name": "My new Book",
            "variant_name": "Paper back",
            "sku": "my-sku",
            "product_id": 123456,
            "variant_id": 1234567,
            "vendor": "my-store",
            "tags": [
                "books",
                "paper-books"
            ]
        },
        {
            "id": "82664d96-6dfd-4343-96b0-05c46f412a5r",
            "name": "My new Book",
            "variant_name": "Hard back",
            "sku": "my-sku",
            "product_id": 123456,
            "variant_id": 1234563,
            "vendor": "my-store",
            "tags": [
                "books",
                "hardback-books"
            ]
        }
    ],
    "links": {
        "first": "https://app.digital-downloads.com/api/v1/products?page=1",
        "last": "https://app.digital-downloads.com/api/v1/products?page=4",
        "prev": null,
        "next": "https://app.digital-downloads.com/api/v1/products?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/products?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/products?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/products?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/products?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "https://app.digital-downloads.com/api/v1/products?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.digital-downloads.com/api/v1/products",
        "per_page": 25,
        "to": 25,
        "total": 76
    }
}

View product

To view an individual product, optionally load linked assets. Send a GET request to

https://app.digital-downloads.com/api/v1/products/:id

Example

https://app.digital-downloads.com/api/v1/products/82664d96-6dfd-4343-96b0-05c46f412a5q?with_assets=true

Response

{
    "data": {
        "id": "82664d96-6dfd-4343-96b0-05c46f412a5q",
        "name": "My new Book",
        "variant_name": "Paper back",
        "sku": "my-sku",
        "product_id": 123456,
        "variant_id": 1234567,
        "vendor": "my-store",
        "tags": [
            "books",
            "paper-books"
        ],
        "assets": [
            {
                "id": "82664d96-6dfd-4343-96b0-05c46f412a5b",
                "filename": "My new book",
                "size": "10MB",
                "is_file": false,
                "is_link": true,
                "url": "https://www.my-website.com/download/my-book.pdf"
            }
        ]
    }
}