storefrontImages

Requires permission storefront:storefront:read.

The pictures this organization uploaded for its storefront, newest first, a page at a time (24 by default, at most 60). Each is the relative serve path an image field stores. Writes nothing.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query StorefrontImages {
  storefrontImages {
    hasMore
    limit
    page
    total
    images {
      size
      uploadedAt
      url
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query StorefrontImages {\n  storefrontImages {\n    hasMore\n    limit\n    page\n    total\n    images {\n      size\n      uploadedAt\n      url\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "storefrontImages": {
      "hasMore": true,
      "limit": 0,
      "page": 0,
      "total": 0,
      "images": [
        {
          "size": 0,
          "uploadedAt": "2025-01-15T00:00:00Z",
          "url": "string"
        }
      ]
    }
  }
}

storefrontImages(
  limit: Int = 24
  page: Int = 1
): StorefrontImagePage!

Arguments

storefrontImages.limit ● Int scalar

Pictures per page, 1 to 60; a larger number is read as 60.

storefrontImages.page ● Int scalar

Which page, from 1. A page past the end has no pictures.

Type

StorefrontImagePage object

One page of the storefront's picture library, newest first.