Shopify Admin API · Example Payload

Shopify Admin List Products Example

Example of retrieving a list of products from the Shopify Admin REST API

CommerceEcommerceAdminProductsOrdersCustomers

Shopify Admin List Products Example is an example object payload from Shopify Admin API, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

Raw ↑
{
  "summary": "List Products - Example Request/Response",
  "description": "Example of retrieving a list of products from the Shopify Admin REST API",
  "request": {
    "method": "GET",
    "url": "https://mystore.myshopify.com/admin/api/2024-10/products.json?limit=2&status=active",
    "headers": {
      "X-Shopify-Access-Token": "shpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "Content-Type": "application/json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json",
      "X-Shopify-Shop-Api-Call-Limit": "1/40"
    },
    "body": {
      "products": [
        {
          "id": 632910392,
          "title": "Classic Cotton T-Shirt",
          "body_html": "<p>A comfortable, everyday cotton t-shirt available in multiple colors.</p>",
          "vendor": "ACME Clothing",
          "product_type": "Shirts",
          "created_at": "2024-01-15T09:00:00-05:00",
          "updated_at": "2024-04-20T14:30:00-05:00",
          "published_at": "2024-01-15T09:00:00-05:00",
          "handle": "classic-cotton-t-shirt",
          "status": "active",
          "tags": "cotton, t-shirt, classic",
          "variants": [
            {
              "id": 808950810,
              "product_id": 632910392,
              "title": "Small / Blue",
              "price": "29.99",
              "sku": "CCT-S-BLU",
              "position": 1,
              "inventory_management": "shopify",
              "inventory_quantity": 100,
              "requires_shipping": true,
              "weight": 0.5,
              "weight_unit": "kg"
            },
            {
              "id": 808950811,
              "product_id": 632910392,
              "title": "Medium / Blue",
              "price": "29.99",
              "sku": "CCT-M-BLU",
              "position": 2,
              "inventory_management": "shopify",
              "inventory_quantity": 150,
              "requires_shipping": true,
              "weight": 0.5,
              "weight_unit": "kg"
            }
          ],
          "images": [
            {
              "id": 850703190,
              "product_id": 632910392,
              "position": 1,
              "src": "https://cdn.shopify.com/s/files/1/0001/classic-cotton-tshirt.jpg",
              "alt": "Classic Cotton T-Shirt in Blue",
              "width": 1024,
              "height": 1024
            }
          ],
          "options": [
            {
              "id": 594680422,
              "product_id": 632910392,
              "name": "Size",
              "position": 1,
              "values": ["Small", "Medium", "Large", "XL"]
            },
            {
              "id": 594680423,
              "product_id": 632910392,
              "name": "Color",
              "position": 2,
              "values": ["Blue", "Red", "Black", "White"]
            }
          ]
        }
      ]
    }
  }
}