/shopify/collections/products

POST /api/shopify/collections/products

Price: 1 credit

List the products within a collection of any Shopify store by store domain and collection handle (or URL): title, brand, product_type, tags, description, image and images, options, and all variants with price, list_price, sku, availability, weight and shipping flags.

How to use it

List the products inside a collection of a specific Shopify store. store_domain is the store's domain (e.g. allbirds.com); collection is the collection handle or URL; count is how many products to return. Each item has id, alias (handle), title, description, brand, product_type, tags, image+images, options (name/values) and variants (each with price, list_price, sku, available, weight, options).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• store_domain string required — Shopify store domain (examples: "allbirds.com", "kith.com"; minLength: 1)
• collection string required — Collection handle or a collection URL (examples: "mens", "womens"; minLength: 1)
• count integer required — Max number of products to return (min: 1)

Response

• @type string (default: "ShopifyProduct")
• id integer required
• alias string nullable
• description string nullable
• brand string nullable
• product_type string nullable
• tags array (default: [])
• image string nullable
• images array (default: [])
• options array (default: [])
  • @type string (default: "ShopifyProductOption")
  • name string required
  • position integer nullable
  • values array (default: [])
• variants array (default: [])
  • @type string (default: "ShopifyProductVariant")
  • id integer required
  • sku string nullable
  • barcode string nullable
  • price number nullable
  • list_price number nullable
  • currency string nullable
  • available boolean nullable
  • inventory_quantity integer nullable
  • inventory_policy string nullable
  • inventory_management string nullable
  • fulfillment_service string nullable
  • requires_shipping boolean nullable
  • taxable boolean nullable
  • option1 string nullable
  • option2 string nullable
  • option3 string nullable
  • grams integer nullable
  • weight number nullable
  • weight_unit string nullable
  • position integer nullable
  • image string nullable
  • created_at string nullable
  • updated_at string nullable
• published_at string nullable
• created_at string nullable
• updated_at string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Collection not found, or the domain is not a Shopify store / has its public JSON disabled Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.