InsightSocial API

Shopify

Shopify API reference: 25 endpoints for products, reviews, collections and store policies. Per-endpoint credit prices and cURL examples.

Any public Shopify store: products, variants, reviews, collections, search, blogs, pages, policies and locations.

Base path: /v1/shopify/...

Quickstart

cURL
curl "https://api.insightsocial.app/v1/shopify/blog/articles?blog_handle=news&store=allbirds.com" \
  -H "x-api-key: $INSIGHTSOCIAL_API_KEY"

Endpoints

1 of these is metered: the price depends on how much the call reads. See Credits.

Every endpoint here is beta: it returns the platform's own structure under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp), not a schema-2 entity, and its fields may change. See Beta endpoints.

EndpointCreditsWhat it returnsKey parameters
/blog/article20Get one Shopify article by handle, with its comments. Beta.blog_handle, handle, store
/blog/articles20List the articles in one Shopify blog with full content, author and paging. Beta.blog_handle, store
/blogs20List a Shopify store's blogs with their SEO, authors and recent articles. Beta.store
/collection20Get one Shopify collection with its filter facets and counts. Beta.handle, store
/collection/products20List the products in a Shopify collection with filters, sorting and cursor paging. Beta.handle, store
/collections20List a Shopify store's collections with descriptions, images and SEO. Beta.store
/page20Get one Shopify page by handle. Beta.handle, store
/pages20List a Shopify store's pages with body HTML, summary, SEO and timestamps. Beta.store
/product20Get one Shopify product with its variants, images, collections, SEO, and stock detail where the store exposes it. Beta.handle, store
/product/availability20List per-variant pickup availability and location for one Shopify product. Beta.handle, store
/product/metafields20Get merchant-exposed metafields for one Shopify product. Beta.handle, store
/product/recommendations20Get the products a Shopify store recommends beside one product, related or complementary. Beta.handle, store
/product/reviews20List a Shopify product's reviews, ratings and review media the store publishes. Beta.handle, store
/product/reviews/summary20Get a Shopify product's review summary and star distribution. Beta.handle, store
/products20List a Shopify store's products with the store's own query syntax, sorting and cursor paging. Beta.store
/products/batch20–320Get up to 25 Shopify products by handle in one call. Beta.store, handles
/search20Search a Shopify store's products, articles and pages, with the store's facets and result count. Beta.store, query
/search/suggest20Get a Shopify store's search suggestions across products, collections, pages, articles and queries. Beta.store, query
/store20Get a Shopify store's identity, brand, market, payment settings, policy summary and agent-commerce capabilities. Beta.store
/store/locations20List a Shopify store's physical locations with address, coordinates and phone. Beta.store
/store/menus20Get one of a Shopify store's navigation menus, including nested items. Beta.handle, store
/store/policies20Get a Shopify store's privacy, refund, shipping, terms, subscription, contact and legal policies with their full text. Beta.store
/store/redirects20List a Shopify store's URL redirect table. Beta.store
/store/reviews20List a Shopify store's store-wide reviews, ratings and review media the store publishes. Beta.store
/store/sitemap20Get a Shopify store's sitemap index or one typed child sitemap, with last-modified dates and image metadata. Beta.store

On this page