Skip to main content

List Shopify Store Collections

GET 

/api/v2/product-lifecycle/channels/shopify/:instance/collections

Collections in one connected Shopify store, optionally filtered by a search term. Use a collection's id as the fallback redirect target in the lifecycle settings: when an archived product has no live successor on the store, its storefront URL redirects to that collection. Results are cached for 5 minutes per store and search term.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query:

  • search (optional, string, first 100 characters used): filters collections by title

Response fields: collections [{id (Shopify collection GID), handle, title}], error (a message when Shopify could not be reached - collections is then empty; otherwise null).

Returns 404 when the integration instance is not a Shopify store.

Requires a Bearer token with the products read/write scope and the settings.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type