Sign in
Product

Retrieves a list of products.

get/admin/products.json

Query parameters

idsstring

Return only certain products, specified by a comma-separated list of product IDs.

limitinteger

Return up to this many results per page. (default: 50, maximum: 250).

since_idinteger

Restrict results to after the specified ID.

titlestring

Filter results by product title.

vendorstring

Filter results by vendor.

handlestring

Filter results by handle.

product_typestring

Filter results by product type.

collection_idinteger

Filter results by product collection ID.

created_at_minstring

Show products created after date. (format: 2014-04-25T16:15:47-04:00)

created_at_maxstring

Show products created before date. (format: 2014-04-25T16:15:47-04:00)

updated_at_minstring

Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)

updated_at_maxstring

Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)

published_at_minstring

Show products published after date. (format: 2014-04-25T16:15:47-04:00)

published_at_maxstring

Show products published before date. (format: 2014-04-25T16:15:47-04:00)

published_statusstring

Return products by their published status. (default: any), published: Show only published products. unpublished: Show only unpublished products. any: Show all products.

fieldsstring

Show only certain fields, specified by a comma-separated list of field names.

presentment_currenciesstring

Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes.

sort_fieldstring

Sort result-set in ascending or descending order by that field.

sort_modestring

Ascending or descending order. (default: asc)

Response

OK

Example response

{
  "products": [
    {
      "body_html": "<p>It's the small iPod with a big idea: Video.<p>",
      "custom_options": [
        {
          "active": true,
          "default_value": "default value",
          "default_value_index": 1,
          "font_family": "arial",
          "font_path": "https://example.com/font_path.tff",
          "help_text": "example",
          "id": "123443",
          "label": "example label",
          "name": "example name",
          "placeholder": "example",
          "rules": [
            {
              "conditions": [
                {
                  "relation": "equals",
                  "value": "Hair"
                }
              ],
              "show_option_ids": [
                "1123123",
                "3453567"
              ]
            }
          ],
          "type": "text",
          "validations": {
            "allowed_characters": [
              "symbol"
            ],
            "max_length": 50,
            "min_size": 50,
            "required": true
          },
          "values": [
            {
              "text": "Option text",
              "value": "Option value"
            }
          ]
        }
      ],
      "display_options": {
        "group_options_by": 1
      },
      "fulfillment_services": [
        {
          "can_remove_mapping": true,
          "is_mapped": true,
          "service_name": "Service name"
        }
      ],
      "handle": "ipod-nano-8gb",
      "id": 632910392,
      "image": {
        "alt_text": "ipod-nano-xin",
        "height": 480,
        "id": 850703190,
        "position": 1,
        "product_id": 632910392,
        "src": "https://img.btdmp.com/products/ipod-nano.png",
        "width": 640
      },
      "images": [
        {
          "alt_text": "ipod-nano-xin",
          "height": 480,
          "id": 850703190,
          "position": 1,
          "product_id": 632910392,
          "src": "https://img.btdmp.com/products/ipod-nano.png",
          "width": 640
        }
      ],
      "metafields_global_description_tag": "It's the small iPod with a big idea: Video.",
      "metafields_global_title_tag": "IPod Nano - White, 8GB",
      "options": [
        {
          "id": 1002,
          "name": "color",
          "position": 1,
          "product_id": 632910392,
          "values": [
            "red",
            " blue",
            " green"
          ]
        }
      ],
      "product_availability": 7,
      "product_type": "Cult Products",
      "published": true,
      "tags": "Emotive, Flash Memory, MP3, Music",
      "title": "IPod Nano - 8GB",
      "variants": [
        {
          "barcode": "9 788073 400972",
          "compare_at_price": 200,
          "fulfillment_service": "Shop base fulfillment",
          "id": 632910392,
          "image_id": 434522,
          "inventory_management": "shopbase",
          "inventory_quantity": 100,
          "is_default": true,
          "option1": "IPOD2008PINK",
          "position": 1,
          "price": 100,
          "product_id": 632910392,
          "requires_shipping": true,
          "sku": "null",
          "taxable": true,
          "title": "IPod Nano - 8GB",
          "weight": 12,
          "weight_unit": "12"
        }
      ],
      "vendor": "Apple"
    }
  ]
}

Changes