Reading products

Merchants will list a subset of their products in your sales channel. You can read the products meant for your channel using these authenticated endpoints:

  • GET /admin/applications/$app_id/product_listings.json
    Retrieve an index of products that are listed in your channel and globally published. Up to 250 products will be returned. You can retrieve more products using the page URL parameter.

    product_ids

    A comma-separated list of product ids

    limit

    Amount of results

    (default: 50) (maximum: 250)
    page

    Page to show

    (default: 1)
    collection_id

    Filter by collection id

    updated_at_min

    Show products last updated after date (format: 2008-12-31 03:00)

    handle

    Filter products by handle

  • GET /admin/applications/$app_id/product_listings/$product_id.json
    Retrieve a single product that is listed in your channel and globally published.

  • GET /admin/applications/$app_id/product_listings/product_ids.json
    Retrieve an index of product_ids that are listed in your channel and globally published. Up to 10,000 product IDs will be returned. You can retrieve more products using the page URL parameter.

  • GET /admin/applications/$app_id/collection_listings.json
    Retrieve an index of collections that are listed in your channel.

    limit

    Amount of results

    (default: 50) (maximum: 250)
    page

    Page to show

    (default: 1)

  • GET /admin/applications/$app_id/collection_listings/$collection_id.json
    Retrieve a single collection that is listed in your channel.

  • GET /admin/applications/$app_id/collection_listings/$collection_id/product_ids.json
    Retrieve a list of up to 10,000 product_ids from a collection that is listed in your channel. You can retrieve more products using the page URL parameter.

Sample authenticated request for product listings

GET /admin/applications/2329148/product_listings.json HTTP/1.1
Host: channelsrule.myshopify.com
X-Shopify-Access-Token: 085abas8bd90325c3f81s8e9c88befc0

View Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Status: 200 OK
X-Shopify-Shop-Api-Call-Limit: 1/40

{
    "product_listings": [
        {
            "product_id": 3669721031,
            "title": "Graphic Owl Guys Tee",
            "body_html": "<meta charset=\"utf-8\">\n<p>Have we mentioned we love owls? We guarantee you'll have a hoot wearing this graphic owl Guys Tee.</p>",
            "vendor": "channelsrule",
            "product_type": "",
            "created_at": "2015-12-08T16:45:54-05:00",
            "handle": "graphic-owl-guys-tee",
            "updated_at": "2015-12-08T16:46:14-05:00",
            "published_at": "2015-12-08T16:41:00-05:00",
            "template_suffix": null,
            "published_scope": "global",
            "tags": "",
            "variants": [
                {
                    "id": 11184583431,
                    "product_id": 3669721031,
                    "title": "small",
                    "price": "25.00",
                    "sku": "HOOT-001",
                    "position": 1,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "small",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:45:54-05:00",
                    "updated_at": "2015-12-08T16:45:54-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 45,
                    "old_inventory_quantity": 45,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                },
                {
                    "id": 11184583495,
                    "product_id": 3669721031,
                    "title": "medium",
                    "price": "25.00",
                    "sku": "HOOT-002",
                    "position": 2,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "medium",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:45:54-05:00",
                    "updated_at": "2015-12-08T16:45:54-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 30,
                    "old_inventory_quantity": 30,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                },
                {
                    "id": 11184583559,
                    "product_id": 3669721031,
                    "title": "large",
                    "price": "25.00",
                    "sku": "HOOT-003",
                    "position": 3,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "large",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:45:54-05:00",
                    "updated_at": "2015-12-08T16:45:54-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 20,
                    "old_inventory_quantity": 20,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                }
            ],
            "options": [
                {
                    "id": 4450728455,
                    "product_id": 3669721031,
                    "name": "Size",
                    "position": 1,
                    "values": [
                        "small",
                        "medium",
                        "large"
                    ]
                }
            ],
            "images": [
                {
                    "id": 7645532679,
                    "product_id": 3669721031,
                    "position": 1,
                    "created_at": "2015-12-08T16:46:14-05:00",
                    "updated_at": "2015-12-08T16:46:14-05:00",
                    "src": "https://cdn.shopify.com/s/files/1/1089/0068/products/mens_tee_owl_large_650dc959-9cb4-4453-9406-3b9674eeb612.png?v=1449611174",
                    "variant_ids": []
                }
            ],
            "image": {
                "id": 7645532679,
                "product_id": 3669721031,
                "position": 1,
                "created_at": "2015-12-08T16:46:14-05:00",
                "updated_at": "2015-12-08T16:46:14-05:00",
                "src": "https://cdn.shopify.com/s/files/1/1089/0068/products/mens_tee_owl_large_650dc959-9cb4-4453-9406-3b9674eeb612.png?v=1449611174",
                "variant_ids": []
            }
        },
        {
            "id": 3669728775,
            "title": "Ruby Girls Tee",
            "body_html": "<meta charset=\"utf-8\">\n<p>Ruby on Rails is an open source web application framework which runs on the Ruby programming language. </p>",
            "vendor": "channelsrule",
            "product_type": "",
            "created_at": "2015-12-08T16:47:56-05:00",
            "handle": "ruby-girls-tee",
            "updated_at": "2015-12-08T16:48:17-05:00",
            "published_at": "2015-12-08T16:46:00-05:00",
            "template_suffix": null,
            "published_scope": "global",
            "tags": "",
            "variants": [
                {
                    "id": 11184596679,
                    "product_id": 3669728775,
                    "title": "small",
                    "price": "25.00",
                    "sku": "RUBY-001",
                    "position": 1,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "small",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:47:56-05:00",
                    "updated_at": "2015-12-08T16:47:56-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 30,
                    "old_inventory_quantity": 30,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                },
                {
                    "id": 11184596743,
                    "product_id": 3669728775,
                    "title": "medium",
                    "price": "25.00",
                    "sku": "RUBY-002",
                    "position": 2,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "medium",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:47:56-05:00",
                    "updated_at": "2015-12-08T16:47:56-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 40,
                    "old_inventory_quantity": 40,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                },
                {
                    "id": 11184596807,
                    "product_id": 3669728775,
                    "title": "large",
                    "price": "25.00",
                    "sku": "RUBY-003",
                    "position": 3,
                    "grams": 200,
                    "inventory_policy": "deny",
                    "compare_at_price": "30.00",
                    "fulfillment_service": "manual",
                    "inventory_management": "shopify",
                    "option1": "large",
                    "option2": null,
                    "option3": null,
                    "created_at": "2015-12-08T16:47:56-05:00",
                    "updated_at": "2015-12-08T16:47:56-05:00",
                    "requires_shipping": true,
                    "taxable": true,
                    "barcode": "",
                    "inventory_quantity": 24,
                    "old_inventory_quantity": 24,
                    "image_id": null,
                    "weight": 200,
                    "weight_unit": "g"
                }
            ],
            "options": [
                {
                    "id": 4450737479,
                    "product_id": 3669728775,
                    "name": "Size",
                    "position": 1,
                    "values": [
                        "small",
                        "medium",
                        "large"
                    ]
                }
            ],
            "images": [
                {
                    "id": 7645572167,
                    "product_id": 3669728775,
                    "position": 1,
                    "created_at": "2015-12-08T16:48:17-05:00",
                    "updated_at": "2015-12-08T16:48:17-05:00",
                    "src": "https://cdn.shopify.com/s/files/1/1089/0068/products/womens_tee_ruby_large_cfdd2326-6902-4358-87c7-4ddfbf684968.png?v=1449611297",
                    "variant_ids": []
                }
            ],
            "image": {
                "id": 7645572167,
                "product_id": 3669728775,
                "position": 1,
                "created_at": "2015-12-08T16:48:17-05:00",
                "updated_at": "2015-12-08T16:48:17-05:00",
                "src": "https://cdn.shopify.com/s/files/1/1089/0068/products/womens_tee_ruby_large_cfdd2326-6902-4358-87c7-4ddfbf684968.png?v=1449611297",
                "variant_ids": []
            }
        }
    ]
}

Pagination

When your app asks for a set of product listings, or a set of collection listings, Shopify will respond with up to 250 results per page. You can navigate forwards and backwards through results using the page URL parameter. In the above example, you could retrieve a second page of results by making a GET request to the following endpoint:

GET /admin/applications/2329148/product_listings.json?page=2 HTTP/1.1
Host: channelsrule.myshopify.com
X-Shopify-Access-Token: 085abas8bd90325c3f81s8e9c88befc0