Shopify

Shopify Collection API

The Collection API from Shopify — 66 operation(s) for collection.

GitHub OpenAPI

Operations 72

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /admin/api/2020-01/collects.json Add a product to a custom collection (2020-01) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“Can I add a product to a custom collection through the 2020-01 Admin API?”
“What call links a product into a manual collection on API version 2020-01?”
Tell an agent
Add a product to one of my custom collections using the 2020-01 API.
Create a 2020-01 collect that places a product in a custom collection.
DELETE /admin/api/2020-01/collects/{collect_id}.json Remove a product from a collection (2020-01) · Shopify Removes A Product From A Collection #
Ask an LLM
“How do I take a product out of a collection with the 2020-01 API?”
“Does the 2020-01 API let me remove a product from a collection by its collect ID?”
Tell an agent destructive · confirm first
Remove collect {collect} using API version 2020-01.
Delete the 2020-01 collect {collect} so that product leaves its collection.
POST /admin/api/2020-04/collects.json Add a product to a custom collection (2020-04) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“Could I put a product into a custom collection with version 2020-04?”
“Does the 2020-04 release still let me create collects for custom collections?”
Tell an agent
Place a product into a custom collection via the 2020-04 collects endpoint.
Link a product to a hand-picked collection on API version 2020-04.
DELETE /admin/api/2020-04/collects/{collect_id}.json Remove a product from a collection (2020-04) · Shopify Removes A Product From A Collection #
Ask an LLM
“What 2020-04 call removes a product from a collection?”
“Can I unlink a product from a custom collection on version 2020-04?”
Tell an agent destructive · confirm first
Delete collect {collect} through the 2020-04 API.
Take the product in collect {collect} out of its collection on 2020-04.
POST /admin/api/2020-07/collects.json Add a product to a custom collection (2020-07) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“Which 2020-07 endpoint adds a product to a custom collection?”
“Can the 2020-07 Admin API attach an item to a manually curated collection?”
Tell an agent
Attach a product to a custom collection with the 2020-07 API.
Make a new collect in 2020-07 so a product shows up in a custom collection.
DELETE /admin/api/2020-07/collects/{collect_id}.json Remove a product from a collection (2020-07) · Shopify Removes A Product From A Collection #
Ask an LLM
“Which endpoint in 2020-07 drops a product from a collection?”
“Is removing a collect the way to pull an item from a collection in 2020-07?”
Tell an agent destructive · confirm first
Drop collect {collect} with the 2020-07 Admin API.
Pull the product linked by collect {collect} out of the collection, version 2020-07.
POST /admin/api/2020-10/collects.json Add a product to a custom collection (2020-10) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“How can I add a product to a custom collection on the 2020-10 API version?”
“What creates a collect record in Shopify's 2020-10 Admin API?”
Tell an agent
Add a product to a custom collection using version 2020-10.
Create a collect on 2020-10 to put a product into a manual collection.
DELETE /admin/api/2020-10/collects/{collect_id}.json Remove a product from a collection (2020-10) · Shopify Removes A Product From A Collection #
Ask an LLM
“How can I remove a product from a collection in version 2020-10?”
“Can I delete a single collect by ID on the 2020-10 API?”
Tell an agent destructive · confirm first
Delete collect {collect} on version 2020-10.
Remove the product tied to collect {collect} from its collection via 2020-10.
POST /admin/api/2021-01/collects.json Add a product to a custom collection (2021-01) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“Is there a 2021-01 call for adding products to a custom collection?”
“How would I create a collect with the 2021-01 Admin API?”
Tell an agent
Put a product in a custom collection through the 2021-01 API.
Create a collect under version 2021-01 linking a product to a custom collection.
DELETE /admin/api/2021-01/collects/{collect_id}.json Remove a product from a collection (2021-01) · Shopify Removes A Product From A Collection #
Ask an LLM
“Is there a 2021-01 endpoint to remove a product from a collection?”
“Can the 2021-01 API delete a collect by its ID?”
Tell an agent destructive · confirm first
Remove collect {collect} using the 2021-01 release.
Unlink the product in collect {collect} from its collection on 2021-01.
POST /admin/api/unstable/collects.json Add a product to a custom collection (unstable) · Shopify Adds A Product To A Custom Collection #
Ask an LLM
“Can I add products to a custom collection on the unstable API version?”
“Which unstable-version call creates a collect for a custom collection?”
Tell an agent
Add a product to a custom collection using the unstable API.
Create a collect on the unstable version for a hand-picked collection.
DELETE /admin/api/unstable/collects/{collect_id}.json Remove a product from a collection (unstable) · Shopify Removes A Product From A Collection #
Ask an LLM
“How would I remove a product from a collection with the unstable API?”
“Which unstable-version call deletes a collect?”
Tell an agent destructive · confirm first
Delete collect {collect} on the unstable API version.
Take collect {collect} out using the unstable endpoint.
GET /admin/api/2020-01/collections/{collection_id}.json Get any collection by ID (2020-01) · Shopify Retrieves A Single Collection #
Ask an LLM
“Can I look up a collection by ID, custom or smart, with the 2020-01 API?”
“Can the 2020-01 collections endpoint return only certain fields of a collection?”
Tell an agent
Get collection {collection}, whatever its type, using API version 2020-01.
Fetch collection {collection} on 2020-01 with only the fields {fields}.
GET /admin/api/2020-04/collections/{collection_id}.json Get any collection by ID (2020-04) · Shopify Retrieves A Single Collection #
Ask an LLM
“Which 2020-04 call retrieves any single collection regardless of type?”
“Can I fetch a collection by its ID without knowing if it's smart or custom, on 2020-04?”
Tell an agent
Retrieve collection {collection} of any type through the 2020-04 API.
Show me the {fields} of collection {collection} using version 2020-04.
GET /admin/api/2020-07/collections/{collection_id}.json Get any collection by ID (2020-07) · Shopify Retrieves A Single Collection #
Ask an LLM
“What's the 2020-07 endpoint for reading one collection of any kind?”
“Does 2020-07 let me limit which fields come back when I retrieve a generic collection?”
Tell an agent
Look up collection {collection}, smart or custom, with version 2020-07.
Return just {fields} for collection {collection} from the 2020-07 API.
GET /admin/api/2020-10/collections/{collection_id}.json Get any collection by ID (2020-10) · Shopify Retrieves A Single Collection #
Ask an LLM
“How can I retrieve a single collection, smart or custom, on version 2020-10?”
“Can I read any collection's details by ID through the 2020-10 Admin API?”
Tell an agent
Retrieve collection {collection} on 2020-10 regardless of its type.
Get the fields {fields} of collection {collection} via 2020-10.
GET /admin/api/2021-01/collections/{collection_id}.json Get any collection by ID (2021-01) · Shopify Retrieves A Single Collection #
Ask an LLM
“Is there a 2021-01 call to get one collection whatever its type?”
“Can I choose the fields returned for a general collection lookup in 2021-01?”
Tell an agent
Fetch collection {collection} of either type using the 2021-01 release.
Pull {fields} from collection {collection} with the 2021-01 API.
GET /admin/api/unstable/collections/{collection_id}.json Get any collection by ID (unstable) · Shopify Retrieves A Single Collection #
Ask an LLM
“How would I get a single collection of any type from the unstable API?”
“Which unstable endpoint returns a collection by its ID whether it is smart or custom?”
Tell an agent
Get collection {collection}, custom or smart, from the unstable version.
Look up {fields} on collection {collection} using the unstable API.
POST /admin/api/2020-01/custom_collections.json Create a custom collection (2020-01) · Shopify Creates A Custom Collection #
Ask an LLM
“Can I create a hand-picked custom collection with the 2020-01 Admin API?”
“What 2020-01 call sets up a brand-new custom collection?”
Tell an agent
Create a new custom collection using API version 2020-01.
Set up a manual collection for my store on 2020-01.
GET /admin/api/2020-01/custom_collections/{custom_collection_id}.json Get a custom collection (2020-01) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“How do I retrieve one custom collection by ID on 2020-01?”
“Can the 2020-01 custom collections endpoint return selected fields only?”
Tell an agent
Get custom collection {custom_collection} with API version 2020-01.
Fetch {fields} for custom collection {custom_collection} on 2020-01.
PUT /admin/api/2020-01/custom_collections/{custom_collection_id}.json Update a custom collection (2020-01) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“Can I edit an existing custom collection with the 2020-01 API?”
“What 2020-01 call changes a custom collection I already made?”
Tell an agent
Update custom collection {custom_collection} using API version 2020-01.
Edit my existing custom collection {custom_collection} on 2020-01.
DELETE /admin/api/2020-01/custom_collections/{custom_collection_id}.json Delete a custom collection (2020-01) · Shopify Deletes A Custom Collection #
Ask an LLM
“How do I delete a custom collection with the 2020-01 API?”
“Can I permanently remove a manual collection on 2020-01?”
Tell an agent destructive · confirm first
Delete custom collection {custom_collection} using API version 2020-01.
Permanently remove custom collection {custom_collection} on 2020-01.
POST /admin/api/2020-04/custom_collections.json Create a custom collection (2020-04) · Shopify Creates A Custom Collection #
Ask an LLM
“What's involved in making a custom collection on version 2020-04?”
“Which 2020-04 endpoint creates a manually curated collection?”
Tell an agent
Make a custom collection through the 2020-04 API.
Add a new hand-curated collection to the store with 2020-04.
GET /admin/api/2020-04/custom_collections/{custom_collection_id}.json Get a custom collection (2020-04) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“Which 2020-04 call reads a single custom collection?”
“Can I look up a manual collection's details by its ID in 2020-04?”
Tell an agent
Retrieve custom collection {custom_collection} via the 2020-04 API.
Show the {fields} of custom collection {custom_collection} on 2020-04.
PUT /admin/api/2020-04/custom_collections/{custom_collection_id}.json Update a custom collection (2020-04) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“What's the way to modify a custom collection on version 2020-04?”
“Which 2020-04 endpoint saves changes to a manual collection?”
Tell an agent
Modify custom collection {custom_collection} through the 2020-04 API.
Save changes to custom collection {custom_collection} with 2020-04.
DELETE /admin/api/2020-04/custom_collections/{custom_collection_id}.json Delete a custom collection (2020-04) · Shopify Deletes A Custom Collection #
Ask an LLM
“Which 2020-04 call deletes a custom collection?”
“Is there a way to get rid of a curated collection in 2020-04?”
Tell an agent destructive · confirm first
Remove custom collection {custom_collection} through the 2020-04 API.
Get rid of custom collection {custom_collection} with 2020-04.
POST /admin/api/2020-07/custom_collections.json Create a custom collection (2020-07) · Shopify Creates A Custom Collection #
Ask an LLM
“Is creating a custom collection supported in the 2020-07 release?”
“What endpoint builds a new manual collection on 2020-07?”
Tell an agent
Create a custom collection with version 2020-07.
Start a fresh hand-picked collection via the 2020-07 Admin API.
GET /admin/api/2020-07/custom_collections/{custom_collection_id}.json Get a custom collection (2020-07) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“What 2020-07 endpoint returns one custom collection?”
“Does version 2020-07 let me trim the fields on a custom collection lookup?”
Tell an agent
Look up custom collection {custom_collection} using 2020-07.
Return only {fields} for custom collection {custom_collection} from 2020-07.
PUT /admin/api/2020-07/custom_collections/{custom_collection_id}.json Update a custom collection (2020-07) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“Is updating a custom collection possible in 2020-07?”
“What endpoint in 2020-07 edits an existing curated collection?”
Tell an agent
Edit custom collection {custom_collection} using version 2020-07.
Apply updates to custom collection {custom_collection} via the 2020-07 Admin API.
DELETE /admin/api/2020-07/custom_collections/{custom_collection_id}.json Delete a custom collection (2020-07) · Shopify Deletes A Custom Collection #
Ask an LLM
“What 2020-07 endpoint removes a custom collection entirely?”
“Can I delete a hand-picked collection using version 2020-07?”
Tell an agent destructive · confirm first
Delete custom collection {custom_collection} via version 2020-07.
Wipe out custom collection {custom_collection} using the 2020-07 Admin API.
POST /admin/api/2020-10/custom_collections.json Create a custom collection (2020-10) · Shopify Creates A Custom Collection #
Ask an LLM
“How can I create a custom collection on the 2020-10 API?”
“Which 2020-10 call adds a new curated collection to my shop?”
Tell an agent
Create a new custom collection on 2020-10.
Build a manual product collection using the 2020-10 endpoint.
GET /admin/api/2020-10/custom_collections/{custom_collection_id}.json Get a custom collection (2020-10) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“How can I view a single custom collection in version 2020-10?”
“Can I get a hand-picked collection by ID from the 2020-10 Admin API?”
Tell an agent
Retrieve custom collection {custom_collection} on 2020-10.
Get {fields} of custom collection {custom_collection} via version 2020-10.
PUT /admin/api/2020-10/custom_collections/{custom_collection_id}.json Update a custom collection (2020-10) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“How can I update a custom collection in the 2020-10 release?”
“Which 2020-10 call rewrites an existing hand-picked collection?”
Tell an agent
Update custom collection {custom_collection} on 2020-10.
Change the details of custom collection {custom_collection} via version 2020-10.
DELETE /admin/api/2020-10/custom_collections/{custom_collection_id}.json Delete a custom collection (2020-10) · Shopify Deletes A Custom Collection #
Ask an LLM
“How can I delete a custom collection on 2020-10?”
“Which 2020-10 call permanently removes a manual collection?”
Tell an agent destructive · confirm first
Delete custom collection {custom_collection} on 2020-10.
Remove the custom collection {custom_collection} for good via version 2020-10.
POST /admin/api/2021-01/custom_collections.json Create a custom collection (2021-01) · Shopify Creates A Custom Collection #
Ask an LLM
“Can I add a new custom collection through the 2021-01 API?”
“Where do I create a curated collection in version 2021-01?”
Tell an agent
Set up a custom collection with the 2021-01 release.
Create a hand-picked collection on API version 2021-01.
GET /admin/api/2021-01/custom_collections/{custom_collection_id}.json Get a custom collection (2021-01) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“Is there a 2021-01 call to read one custom collection?”
“Can I request specific fields of a custom collection in 2021-01?”
Tell an agent
Fetch custom collection {custom_collection} with the 2021-01 release.
Pull {fields} from custom collection {custom_collection} using 2021-01.
PUT /admin/api/2021-01/custom_collections/{custom_collection_id}.json Update a custom collection (2021-01) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“Can the 2021-01 API change an existing custom collection?”
“Where do I update a manual collection in version 2021-01?”
Tell an agent
Modify custom collection {custom_collection} with the 2021-01 release.
Push edits to custom collection {custom_collection} using 2021-01.
DELETE /admin/api/2021-01/custom_collections/{custom_collection_id}.json Delete a custom collection (2021-01) · Shopify Deletes A Custom Collection #
Ask an LLM
“Can the 2021-01 API delete a custom collection?”
“Where is the custom collection delete call in 2021-01?”
Tell an agent destructive · confirm first
Remove custom collection {custom_collection} with the 2021-01 release.
Delete my custom collection {custom_collection} using 2021-01.
POST /admin/api/unstable/custom_collections.json Create a custom collection (unstable) · Shopify Creates A Custom Collection #
Ask an LLM
“Does the unstable API let me create a custom collection?”
“What's the unstable-version call for a new manual collection?”
Tell an agent
Create a custom collection using the unstable version.
Add a curated collection through the unstable Admin API.
GET /admin/api/unstable/custom_collections/{custom_collection_id}.json Get a custom collection (unstable) · Shopify Retrieves A Single Custom Collection #
Ask an LLM
“How would I fetch a custom collection from the unstable API?”
“Which unstable endpoint returns one manual collection?”
Tell an agent
Get custom collection {custom_collection} from the unstable version.
Look up the {fields} on custom collection {custom_collection} with the unstable API.
PUT /admin/api/unstable/custom_collections/{custom_collection_id}.json Update a custom collection (unstable) · Shopify Updates An Existing Custom Collection #
Ask an LLM
“Does the unstable version support editing a custom collection?”
“What's the unstable call for updating a curated collection?”
Tell an agent
Update custom collection {custom_collection} on the unstable API.
Edit the existing custom collection {custom_collection} via the unstable version.
DELETE /admin/api/unstable/custom_collections/{custom_collection_id}.json Delete a custom collection (unstable) · Shopify Deletes A Custom Collection #
Ask an LLM
“Does the unstable version let me delete a custom collection?”
“What unstable endpoint removes a curated collection?”
Tell an agent destructive · confirm first
Delete custom collection {custom_collection} on the unstable API.
Get rid of custom collection {custom_collection} via the unstable version.
POST /admin/api/2020-01/smart_collections.json Create a rule-based smart collection (2020-01) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“Can I create a smart collection driven by rules with the 2020-01 API?”
“What 2020-01 call builds an automated collection from conditions?”
Tell an agent
Create a new rule-based smart collection using API version 2020-01.
Set up an automated smart collection on 2020-01.
GET /admin/api/2020-01/smart_collections/{smart_collection_id}.json Get a smart collection (2020-01) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“Can I read a single automated smart collection with the 2020-01 API?”
“Does the 2020-01 smart collections endpoint let me pick which fields return?”
Tell an agent
Get smart collection {smart_collection} using the 2020-01 release.
Fetch the {fields} for smart collection {smart_collection} on version 2020-01.
PUT /admin/api/2020-01/smart_collections/{smart_collection_id}.json Update a smart collection (2020-01) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“Can I edit an existing smart collection with the 2020-01 API?”
“What 2020-01 call saves changes to an automated collection?”
Tell an agent
Update smart collection {smart_collection} using API version 2020-01.
Edit my smart collection {smart_collection} on 2020-01.
DELETE /admin/api/2020-01/smart_collections/{smart_collection_id}.json Delete a smart collection (2020-01) · Shopify Removes A Smart Collection #
Ask an LLM
“How do I remove a smart collection with the 2020-01 API?”
“Can I permanently delete an automated collection on 2020-01?”
Tell an agent destructive · confirm first
Delete smart collection {smart_collection} using API version 2020-01.
Permanently remove smart collection {smart_collection} on 2020-01.
PUT /admin/api/2020-01/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (2020-01) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“Can I change how products are sorted inside a smart collection with the 2020-01 API?”
“Is it possible to pin specific products to the top of a smart collection on 2020-01?”
Tell an agent
Set the sort order of smart collection {smart_collection} to {sort_order} using 2020-01.
Pin products {products} to the top of smart collection {smart_collection} on version 2020-01.
POST /admin/api/2020-04/smart_collections.json Create a rule-based smart collection (2020-04) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“How do I make a smart collection that fills itself by rules on 2020-04?”
“Which 2020-04 endpoint creates an automatic collection?”
Tell an agent
Make a smart collection with rules through the 2020-04 API.
Add an automated collection to the store with 2020-04.
GET /admin/api/2020-04/smart_collections/{smart_collection_id}.json Get a smart collection (2020-04) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“Which 2020-04 endpoint shows one rule-based collection?”
“Can I look up an automated collection by its ID in 2020-04?”
Tell an agent
Retrieve smart collection {smart_collection} via 2020-04.
Show only {fields} of smart collection {smart_collection} with the 2020-04 API.
PUT /admin/api/2020-04/smart_collections/{smart_collection_id}.json Update a smart collection (2020-04) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“Could I modify a smart collection on version 2020-04?”
“Which 2020-04 endpoint edits a rule-based collection?”
Tell an agent
Modify smart collection {smart_collection} through the 2020-04 API.
Save edits to smart collection {smart_collection} with 2020-04.
DELETE /admin/api/2020-04/smart_collections/{smart_collection_id}.json Delete a smart collection (2020-04) · Shopify Removes A Smart Collection #
Ask an LLM
“Which 2020-04 call removes a smart collection?”
“Is there a way to get rid of a rule-based collection in 2020-04?”
Tell an agent destructive · confirm first
Remove smart collection {smart_collection} through the 2020-04 API.
Get rid of smart collection {smart_collection} with 2020-04.
PUT /admin/api/2020-04/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (2020-04) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“How do I reorder the products in a smart collection on 2020-04?”
“Which 2020-04 call sets the sorting type of an automated collection?”
Tell an agent
Change smart collection {smart_collection} to sort by {sort_order} via the 2020-04 API.
Put products {products} first in smart collection {smart_collection} with 2020-04.
POST /admin/api/2020-07/smart_collections.json Create a rule-based smart collection (2020-07) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“Is creating a rule-driven smart collection supported in 2020-07?”
“What endpoint sets up an automatic collection on version 2020-07?”
Tell an agent
Create a smart collection using version 2020-07.
Start a new rules-based collection via the 2020-07 Admin API.
GET /admin/api/2020-07/smart_collections/{smart_collection_id}.json Get a smart collection (2020-07) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“What 2020-07 call returns one smart collection?”
“Is there a way to limit fields when reading a smart collection on 2020-07?”
Tell an agent
Look up smart collection {smart_collection} with the 2020-07 Admin API.
Return {fields} for smart collection {smart_collection} using version 2020-07.
PUT /admin/api/2020-07/smart_collections/{smart_collection_id}.json Update a smart collection (2020-07) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“Is updating a smart collection possible in 2020-07?”
“What endpoint in 2020-07 changes an existing automatic collection?”
Tell an agent
Edit smart collection {smart_collection} using version 2020-07.
Apply changes to smart collection {smart_collection} via the 2020-07 Admin API.
DELETE /admin/api/2020-07/smart_collections/{smart_collection_id}.json Delete a smart collection (2020-07) · Shopify Removes A Smart Collection #
Ask an LLM
“What 2020-07 endpoint deletes a smart collection entirely?”
“Can I remove an automatic collection using version 2020-07?”
Tell an agent destructive · confirm first
Delete smart collection {smart_collection} via version 2020-07.
Wipe out smart collection {smart_collection} using the 2020-07 Admin API.
PUT /admin/api/2020-07/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (2020-07) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“What 2020-07 endpoint controls product ordering in a smart collection?”
“Can I manually order a few products at the top of a rule-based collection in 2020-07?”
Tell an agent
Apply the {sort_order} ordering to smart collection {smart_collection} on 2020-07.
Move products {products} to the top of smart collection {smart_collection} using version 2020-07.
POST /admin/api/2020-10/smart_collections.json Create a rule-based smart collection (2020-10) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“How can I create a smart collection with product rules on 2020-10?”
“Which 2020-10 call adds an automated collection to my shop?”
Tell an agent
Create a new smart collection on 2020-10.
Build a rules-driven collection using the 2020-10 endpoint.
GET /admin/api/2020-10/smart_collections/{smart_collection_id}.json Get a smart collection (2020-10) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“How can I view a single smart collection on 2020-10?”
“Can I get an automatic collection by ID through the 2020-10 API?”
Tell an agent
Retrieve smart collection {smart_collection} from 2020-10.
Get the {fields} of smart collection {smart_collection} on the 2020-10 version.
PUT /admin/api/2020-10/smart_collections/{smart_collection_id}.json Update a smart collection (2020-10) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“What's the call to update a smart collection in the 2020-10 release?”
“Which 2020-10 call rewrites an existing rules-driven collection?”
Tell an agent
Update smart collection {smart_collection} on 2020-10.
Change the settings of smart collection {smart_collection} via version 2020-10.
DELETE /admin/api/2020-10/smart_collections/{smart_collection_id}.json Delete a smart collection (2020-10) · Shopify Removes A Smart Collection #
Ask an LLM
“How can I delete a smart collection on 2020-10?”
“Which 2020-10 call permanently removes a rules-driven collection?”
Tell an agent destructive · confirm first
Delete smart collection {smart_collection} on 2020-10.
Remove the smart collection {smart_collection} for good via version 2020-10.
PUT /admin/api/2020-10/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (2020-10) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“How can I set the product sort order for a smart collection on 2020-10?”
“Can I list specific product IDs to appear first in a smart collection via 2020-10?”
Tell an agent
Sort smart collection {smart_collection} by {sort_order} on 2020-10.
Feature products {products} at the top of smart collection {smart_collection} via 2020-10.
POST /admin/api/2021-01/smart_collections.json Create a rule-based smart collection (2021-01) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“Can I add a smart collection based on rules through the 2021-01 API?”
“Where do I create an automated collection in version 2021-01?”
Tell an agent
Set up a smart collection with the 2021-01 release.
Create a rule-based collection on API version 2021-01.
GET /admin/api/2021-01/smart_collections/{smart_collection_id}.json Get a smart collection (2021-01) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“Is there a 2021-01 call to read one smart collection?”
“Can I request selected fields of a rule-based collection in 2021-01?”
Tell an agent
Fetch smart collection {smart_collection} using 2021-01.
Pull {fields} off smart collection {smart_collection} with the 2021-01 release.
PUT /admin/api/2021-01/smart_collections/{smart_collection_id}.json Update a smart collection (2021-01) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“Can the 2021-01 API change an existing smart collection?”
“Where do I update an automated collection in version 2021-01?”
Tell an agent
Modify smart collection {smart_collection} with the 2021-01 release.
Push edits to smart collection {smart_collection} using 2021-01.
DELETE /admin/api/2021-01/smart_collections/{smart_collection_id}.json Delete a smart collection (2021-01) · Shopify Removes A Smart Collection #
Ask an LLM
“Can the 2021-01 API remove a smart collection?”
“Where is the smart collection delete call in 2021-01?”
Tell an agent destructive · confirm first
Remove smart collection {smart_collection} with the 2021-01 release.
Delete my smart collection {smart_collection} using 2021-01.
PUT /admin/api/2021-01/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (2021-01) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“Does the 2021-01 API let me change the ordering type of a smart collection?”
“Can I push chosen products to the front of an automated collection with 2021-01?”
Tell an agent
Reorder smart collection {smart_collection} using {sort_order} with the 2021-01 release.
Place products {products} ahead of the rest in smart collection {smart_collection} on 2021-01.
POST /admin/api/unstable/smart_collections.json Create a rule-based smart collection (unstable) · Shopify Creates A New Smart Collection Using The Specified Rules #
Ask an LLM
“Does the unstable API let me create a smart collection?”
“What's the unstable-version call for a new rule-based collection?”
Tell an agent
Create a smart collection using the unstable version.
Add an automated rules collection through the unstable Admin API.
GET /admin/api/unstable/smart_collections/{smart_collection_id}.json Get a smart collection (unstable) · Shopify Retrieves A Single Smart Collection #
Ask an LLM
“How would I get a smart collection from the unstable API?”
“Which unstable endpoint returns one automated collection?”
Tell an agent
Get smart collection {smart_collection} on the unstable version.
Look up {fields} for smart collection {smart_collection} via the unstable API.
PUT /admin/api/unstable/smart_collections/{smart_collection_id}.json Update a smart collection (unstable) · Shopify Updates An Existing Smart Collection #
Ask an LLM
“Does the unstable version support editing a smart collection?”
“What's the unstable call for updating a rule-based collection?”
Tell an agent
Update smart collection {smart_collection} on the unstable API.
Edit the existing smart collection {smart_collection} via the unstable version.
DELETE /admin/api/unstable/smart_collections/{smart_collection_id}.json Delete a smart collection (unstable) · Shopify Removes A Smart Collection #
Ask an LLM
“Does the unstable version let me delete a smart collection?”
“What unstable endpoint removes an automated collection?”
Tell an agent destructive · confirm first
Delete smart collection {smart_collection} on the unstable API.
Get rid of smart collection {smart_collection} via the unstable version.
PUT /admin/api/unstable/smart_collections/{smart_collection_id}/order.json Set product ordering in a smart collection (unstable) · Shopify Updates The Ordering Type Of Products In A Smart Collection #
Ask an LLM
“Which unstable-version call reorders products in a smart collection?”
“Can the unstable API put hand-picked products first in a smart collection?”
Tell an agent
Set smart collection {smart_collection} ordering to {sort_order} on the unstable API.
Pin {products} at the top of smart collection {smart_collection} via the unstable version.

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-collection-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/shopify-collection-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shopify-collection-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Collection API
  description: Explore Shopify's API reference and templating documentation. Shopify provides a range of software tools, app templates, example apps, and libraries to accelerate your development process. The Admin API lets you build apps and integrations that extend and enhance the Shopify admin.
  version: 2020-10
tags:


# --- truncated at 32 KB (399 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-collection-api-openapi.yml