Shopify

Shopify Applications API

The Applications API from Shopify — 86 operation(s) for applications.

GitHub OpenAPI

Operations 104

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

GET /admin/api/2020-01/reports/{report_id}.json Get one of my app's reports (API 2020-01) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“How do I pull up a single report my app created on the 2020-01 Admin API?”
“Can a 2020-01 report lookup return only a few chosen fields?”
Tell an agent
Fetch report {report_id} through Admin API version 2020-01.
Show just the {fields} of app report {report_id}, January 2020 release.
GET /admin/api/2020-04/reports/{report_id}.json Get one of my app's reports (API 2020-04) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“Which call returns a report my app made when I'm pinned to API version 2020-04?”
“Is there a fields filter when reading an app report in the April 2020 release?”
Tell an agent
Open my app's report {report_id} on the 2020-04 API.
Read report {report_id} from the April 2020 endpoint, limited to {fields}.
GET /admin/api/2020-07/reports/{report_id}.json Get one of my app's reports (API 2020-07) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“Where do I read back a report my app built, using the July 2020 Admin API?”
“Does the 2020-07 single-report endpoint let me restrict the response fields?”
Tell an agent
Load app-created report {report_id} with the 2020-07 version.
Using July 2020 API, give me report {report_id} with only {fields}.
GET /admin/api/2020-10/reports/{report_id}.json Get one of my app's reports (API 2020-10) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“What's the current 2020-10 way to retrieve a report my app created?”
“Can I ask for specific fields when getting a report on the October 2020 API?”
Tell an agent
Get report {report_id} that my app created, API 2020-10.
Return fields {fields} for report {report_id} on the October 2020 version.
GET /admin/api/2021-01/reports/{report_id}.json Get one of my app's reports (API 2021-01) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“How can I look at one app report via the 2021-01 Admin API release?”
“Will the January 2021 report endpoint return a subset of fields if I list them?”
Tell an agent
Pull app report {report_id} from API version 2021-01.
On the 2021 January release, retrieve report {report_id} showing {fields} only.
GET /admin/api/unstable/reports/{report_id}.json Get one of my app's reports (unstable API) · Shopify Retrieves A Single Report Created By Your App #
Ask an LLM
“Can I retrieve a single app report through the unstable Admin API version?”
“What does the unstable-channel report lookup return when I pass a fields list?”
Tell an agent
Retrieve report {report_id} from the unstable API channel.
Via unstable, fetch {fields} of my app's report {report_id}.
POST /admin/api/2020-01/application_charges.json Bill a shop a one-time app charge (API 2020-01) · Shopify Creates An Application Charge #
Ask an LLM
“How do I charge a merchant a single one-off fee for my app on the 2020-01 API?”
“Which 2020-01 endpoint creates a one-time application charge?”
Tell an agent
Create a one-time application charge with Admin API 2020-01.
Raise a single non-recurring app fee for this shop via the January 2020 release.
GET /admin/api/2020-01/application_charges.json List one-time app charges (API 2020-01) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“How do I see every one-time charge my app has billed a shop, on API 2020-01?”
“Can the 2020-01 one-time charge list start after a given charge ID?”
Tell an agent
List all one-time application charges using the 2020-01 version.
Show one-time app charges newer than {since_id}, January 2020 API.
GET /admin/api/2020-01/application_charges/{application_charge_id}.json Get a one-time app charge (API 2020-01) · Shopify Retrieves An Application Charge #
Ask an LLM
“How can I check the status of one specific one-time app charge on 2020-01?”
“Does the January 2020 charge lookup accept a fields list?”
Tell an agent
Look up one-time charge {application_charge_id} on API 2020-01.
Get the {fields} of application charge {application_charge_id}, January 2020 release.
POST /admin/api/2020-04/application_charges.json Bill a shop a one-time app charge (API 2020-04) · Shopify Creates An Application Charge #
Ask an LLM
“Can I bill a store a one-time purchase for my app on the April 2020 API?”
“What call starts a single application charge under version 2020-04?”
Tell an agent
Start a one-off application charge on the 2020-04 release.
Charge the merchant once for my app using April 2020 Admin API.
GET /admin/api/2020-04/application_charges.json List one-time app charges (API 2020-04) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“Where can I list the one-off fees my app charged, using API version 2020-04?”
“Is paging by since_id supported on the April 2020 one-time charge list?”
Tell an agent
Show my app's one-time charges from the 2020-04 API.
Page April 2020 one-off app charges after ID {since_id}.
GET /admin/api/2020-04/application_charges/{application_charge_id}.json Get a one-time app charge (API 2020-04) · Shopify Retrieves An Application Charge #
Ask an LLM
“Which 2020-04 call shows me one particular one-time app charge?”
“Can I narrow an April 2020 single-charge response to certain fields?”
Tell an agent
Retrieve one-off charge {application_charge_id} via version 2020-04.
Using April 2020, show {fields} for one-time charge {application_charge_id}.
POST /admin/api/2020-07/application_charges.json Bill a shop a one-time app charge (API 2020-07) · Shopify Creates An Application Charge #
Ask an LLM
“How would I create a one-time app purchase for a store on the 2020-07 release?”
“Is a one-off application charge created with a POST on the July 2020 API?”
Tell an agent
Create a one-time charge for my app with the July 2020 version.
Bill this store a single app payment through 2020-07.
GET /admin/api/2020-07/application_charges.json List one-time app charges (API 2020-07) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“What's the July 2020 endpoint for listing all one-time charges from my app?”
“Can I skip earlier one-time charges with since_id on 2020-07?”
Tell an agent
Get every one-time app charge on API 2020-07.
List July 2020 application charges created after {since_id}, only {fields}.
GET /admin/api/2020-07/application_charges/{application_charge_id}.json Get a one-time app charge (API 2020-07) · Shopify Retrieves An Application Charge #
Ask an LLM
“Where do I read a single one-time app charge by ID on the July 2020 API?”
“Can the 2020-07 charge detail call return only the fields I name?”
Tell an agent
Fetch application charge {application_charge_id} from 2020-07.
Show fields {fields} of one-off charge {application_charge_id}, July 2020 release.
POST /admin/api/2020-10/application_charges.json Bill a shop a one-time app charge (API 2020-10) · Shopify Creates An Application Charge #
Ask an LLM
“Can I sell a merchant a one-time app upgrade using the 2020-10 Admin API?”
“Which October 2020 endpoint makes a one-time application charge?”
Tell an agent
Make a one-time app charge for the shop on API 2020-10.
Create a single non-recurring app charge on the October 2020 version.
GET /admin/api/2020-10/application_charges.json List one-time app charges (API 2020-10) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“How can I list the one-time charges my app has made on the current 2020-10 API?”
“Does the October 2020 one-time charge list support since_id paging?”
Tell an agent
List one-time application charges, version 2020-10.
Show October 2020 one-off charges after charge {since_id}.
GET /admin/api/2020-10/application_charges/{application_charge_id}.json Get a one-time app charge (API 2020-10) · Shopify Retrieves An Application Charge #
Ask an LLM
“What's the 2020-10 call to see whether a one-time app charge was accepted?”
“Can I get selected fields of a one-time charge on the October 2020 API?”
Tell an agent
Get one-time charge {application_charge_id} with API version 2020-10.
Return {fields} for charge {application_charge_id} on the October 2020 release.
POST /admin/api/2021-01/application_charges.json Bill a shop a one-time app charge (API 2021-01) · Shopify Creates An Application Charge #
Ask an LLM
“How do I create a one-off purchase charge for my app on 2021-01?”
“Does the January 2021 release still let me POST a one-time application charge?”
Tell an agent
Issue a one-time app charge via the 2021-01 Admin API.
Charge this shop a one-off app fee on the January 2021 release.
GET /admin/api/2021-01/application_charges.json List one-time app charges (API 2021-01) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“Which call lists my app's one-off charges on the January 2021 API?”
“Is since_id available to page one-time charges in version 2021-01?”
Tell an agent
Pull all one-time app charges using 2021-01.
List 2021-01 one-off application charges beyond ID {since_id}.
GET /admin/api/2021-01/application_charges/{application_charge_id}.json Get a one-time app charge (API 2021-01) · Shopify Retrieves An Application Charge #
Ask an LLM
“How can I inspect one specific one-off app charge on the 2021-01 version?”
“Can January 2021 charge lookups be trimmed to particular fields?”
Tell an agent
Inspect one-time charge {application_charge_id} on API 2021-01.
From the January 2021 release, get {fields} of charge {application_charge_id}.
POST /admin/api/unstable/application_charges.json Bill a shop a one-time app charge (unstable API) · Shopify Creates An Application Charge #
Ask an LLM
“Is creating a one-time app charge possible on the unstable API version?”
“What unstable-channel endpoint bills a shop once for my app?”
Tell an agent
Create a one-time application charge on unstable.
Bill the store a single app fee through the unstable channel.
GET /admin/api/unstable/application_charges.json List one-time app charges (unstable API) · Shopify Retrieves A List Of Application Charges #
Ask an LLM
“Can I list one-time app charges on the unstable Admin API channel?”
“Does the unstable one-time charge list take a since_id cursor?”
Tell an agent
List one-off app charges from the unstable version.
Via unstable, show one-time charges after {since_id}.
GET /admin/api/unstable/application_charges/{application_charge_id}.json Get a one-time app charge (unstable API) · Shopify Retrieves An Application Charge #
Ask an LLM
“How do I get one one-off app charge by ID on the unstable channel?”
“Can an unstable single-charge lookup return a limited field set?”
Tell an agent
Get application charge {application_charge_id} on the unstable API.
Unstable channel: show {fields} for one-off charge {application_charge_id}.
POST /admin/api/2020-01/application_credits.json Issue an app credit to a shop (API 2020-01) · Shopify Creates An Application Credit #
Ask an LLM
“How do I give a merchant a credit toward future app charges on API 2020-01?”
“Which 2020-01 call creates an application credit?”
Tell an agent
Issue an application credit to this shop using 2020-01.
Credit the merchant's app billing via the January 2020 release.
GET /admin/api/2020-01/application_credits/{application_credit_id}.json Get an app credit (API 2020-01) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“Where can I look up one application credit I issued, on version 2020-01?”
“Can a January 2020 credit lookup return just some fields?”
Tell an agent
Show application credit {application_credit_id} on API 2020-01.
Get {fields} of credit {application_credit_id} from the January 2020 version.
POST /admin/api/2020-04/application_credits.json Issue an app credit to a shop (API 2020-04) · Shopify Creates An Application Credit #
Ask an LLM
“Can I credit a store for my app on the April 2020 Admin API?”
“What's the 2020-04 endpoint to create an application credit?”
Tell an agent
Create an app credit for the merchant with version 2020-04.
Give this shop an application credit through April 2020.
GET /admin/api/2020-04/application_credits/{application_credit_id}.json Get an app credit (API 2020-04) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“How can I retrieve a single application credit on the 2020-04 release?”
“Is there a fields option on the April 2020 credit detail call?”
Tell an agent
Retrieve app credit {application_credit_id} via 2020-04.
April 2020: return {fields} for credit {application_credit_id}.
POST /admin/api/2020-07/application_credits.json Issue an app credit to a shop (API 2020-07) · Shopify Creates An Application Credit #
Ask an LLM
“What call issues a merchant credit for my app under API 2020-07?”
“Can I create application credits on the July 2020 version?”
Tell an agent
Issue a July 2020 application credit to the shop.
Add an app billing credit for this store on 2020-07.
GET /admin/api/2020-07/application_credits/{application_credit_id}.json Get an app credit (API 2020-07) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“Which July 2020 endpoint returns one application credit by ID?”
“Can I limit the fields of a 2020-07 application credit response?”
Tell an agent
Fetch credit {application_credit_id} from API 2020-07.
Show only {fields} of app credit {application_credit_id}, July 2020 release.
POST /admin/api/2020-10/application_credits.json Issue an app credit to a shop (API 2020-10) · Shopify Creates An Application Credit #
Ask an LLM
“How do I credit a merchant against future app charges on the 2020-10 API?”
“Is the October 2020 application credit endpoint a POST with no path ID?”
Tell an agent
Create an application credit on API version 2020-10.
Credit this store toward my app's charges using October 2020.
GET /admin/api/2020-10/application_credits/{application_credit_id}.json Get an app credit (API 2020-10) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“What's the current 2020-10 way to read back an application credit?”
“Can the October 2020 credit lookup return selected fields only?”
Tell an agent
Get application credit {application_credit_id} on 2020-10.
On October 2020, show fields {fields} for app credit {application_credit_id}.
POST /admin/api/2021-01/application_credits.json Issue an app credit to a shop (API 2021-01) · Shopify Creates An Application Credit #
Ask an LLM
“Can I still issue an app credit to a merchant on the 2021-01 release?”
“Which January 2021 call creates a credit for my app's billing?”
Tell an agent
Issue an app credit with the 2021-01 Admin API.
Give the merchant a billing credit for my app, January 2021 version.
GET /admin/api/2021-01/application_credits/{application_credit_id}.json Get an app credit (API 2021-01) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“How do I view one application credit on API version 2021-01?”
“Does the January 2021 credit detail endpoint honor a fields list?”
Tell an agent
View app credit {application_credit_id} from 2021-01.
Read {fields} of application credit {application_credit_id} on the January 2021 release.
POST /admin/api/unstable/application_credits.json Issue an app credit to a shop (unstable API) · Shopify Creates An Application Credit #
Ask an LLM
“Can the unstable API version create application credits?”
“What unstable endpoint credits a merchant for my app?”
Tell an agent
Create an app credit on the unstable channel.
Issue this shop an application credit via unstable.
GET /admin/api/unstable/application_credits/{application_credit_id}.json Get an app credit (unstable API) · Shopify Retrieves A Single Application Credit #
Ask an LLM
“How can I fetch one application credit through the unstable API?”
“Will the unstable credit lookup return only the fields I ask for?”
Tell an agent
Get app credit {application_credit_id} on unstable.
Unstable channel: fetch {fields} of credit {application_credit_id}.
POST /admin/api/2020-01/recurring_application_charges.json Start an app subscription charge (API 2020-01) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“How do I set up a monthly subscription charge for my app on 2020-01?”
“Which January 2020 call creates a recurring application charge?”
Tell an agent
Create a recurring app charge using the 2020-01 API.
Start a subscription billing plan for this shop, January 2020 release.
GET /admin/api/2020-01/recurring_application_charges.json List app subscriptions (API 2020-01) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“How do I list the recurring subscription charges for my app on API 2020-01?”
“Can I page 2020-01 recurring app charges with since_id?”
Tell an agent
List recurring application charges on version 2020-01.
Show January 2020 app subscriptions after charge {since_id}.
DELETE /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (API 2020-01) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“How do I cancel a merchant's recurring app charge on API 2020-01?”
“Is cancelling a subscription charge a DELETE on the January 2020 version?”
Tell an agent destructive · confirm first
Cancel recurring charge {recurring_application_charge_id} via 2020-01.
End app subscription {recurring_application_charge_id} on the January 2020 release.
POST /admin/api/2020-04/recurring_application_charges.json Start an app subscription charge (API 2020-04) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“Can I create a recurring subscription for my app on the 2020-04 version?”
“What April 2020 endpoint bills a merchant on a recurring basis?”
Tell an agent
Set up a recurring application charge through 2020-04.
Begin recurring app billing for the store with the April 2020 API.
GET /admin/api/2020-04/recurring_application_charges.json List app subscriptions (API 2020-04) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“Where do I see all recurring app charges with the April 2020 Admin API?”
“Can a 2020-04 subscription charge list return only certain fields?”
Tell an agent
Show my app's recurring charges from API 2020-04.
List April 2020 recurring charges with fields {fields} only.
DELETE /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (API 2020-04) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“Which 2020-04 call cancels a recurring charge for my app?”
“Can I stop a merchant's app subscription on the April 2020 release?”
Tell an agent destructive · confirm first
Cancel app subscription {recurring_application_charge_id} using 2020-04.
Stop recurring charge {recurring_application_charge_id} on the April 2020 API.
POST /admin/api/2020-07/recurring_application_charges.json Start an app subscription charge (API 2020-07) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“How would I start recurring billing for my app on the 2020-07 release?”
“Is a recurring application charge created by POST on the July 2020 API?”
Tell an agent
Create a subscription charge for my app on 2020-07.
Put this merchant on recurring app billing, July 2020 version.
GET /admin/api/2020-07/recurring_application_charges.json List app subscriptions (API 2020-07) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“What's the July 2020 call to list my app's recurring subscription charges?”
“Does since_id work on the 2020-07 recurring charge list?”
Tell an agent
Get all recurring app charges via 2020-07.
List July 2020 subscription charges after {since_id}.
DELETE /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (API 2020-07) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“Where do I cancel a recurring app charge on the July 2020 Admin API?”
“What happens to the subscription when I delete a recurring charge on 2020-07?”
Tell an agent destructive · confirm first
Cancel recurring app charge {recurring_application_charge_id}, API 2020-07.
Terminate subscription {recurring_application_charge_id} with the July 2020 release.
POST /admin/api/2020-10/recurring_application_charges.json Start an app subscription charge (API 2020-10) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“How do I charge a merchant a recurring fee for my app on 2020-10?”
“Which October 2020 endpoint creates a recurring application charge?”
Tell an agent
Create a recurring app charge on API 2020-10.
Start subscription billing for this shop on the October 2020 release.
GET /admin/api/2020-10/recurring_application_charges.json List app subscriptions (API 2020-10) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“How can I see every recurring charge my app has on the current 2020-10 API?”
“Can I filter October 2020 recurring charges to those after a given ID?”
Tell an agent
List recurring application charges, version 2020-10.
Show October 2020 app subscriptions newer than {since_id}.
DELETE /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (API 2020-10) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“How do I cancel a recurring app charge with the 2020-10 Admin API?”
“Can I end a shop's app subscription on the October 2020 version?”
Tell an agent destructive · confirm first
Cancel recurring charge {recurring_application_charge_id} on 2020-10.
End the app subscription {recurring_application_charge_id} using October 2020.
POST /admin/api/2021-01/recurring_application_charges.json Start an app subscription charge (API 2021-01) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“Can I create a recurring charge for my app on API version 2021-01?”
“What January 2021 call puts a store on a recurring app plan?”
Tell an agent
Create a recurring application charge via 2021-01.
Set up a recurring app plan for the shop, January 2021 release.
GET /admin/api/2021-01/recurring_application_charges.json List app subscriptions (API 2021-01) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“Which call lists recurring app charges on the 2021-01 release?”
“Is there a fields option on the January 2021 subscription charge list?”
Tell an agent
Pull my app's recurring charges from 2021-01.
List January 2021 recurring charges after {since_id}.
DELETE /admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (API 2021-01) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“How can I cancel an app's recurring charge on the 2021-01 version?”
“Does the January 2021 API let me cancel a merchant's subscription by charge ID?”
Tell an agent destructive · confirm first
Cancel app subscription {recurring_application_charge_id} on 2021-01.
Stop recurring billing {recurring_application_charge_id} via the January 2021 API.
POST /admin/api/unstable/recurring_application_charges.json Start an app subscription charge (unstable API) · Shopify Creates A Recurring Application Charge #
Ask an LLM
“Is creating a recurring app charge supported on the unstable version?”
“What unstable endpoint starts recurring billing for my app?”
Tell an agent
Create a recurring application charge on unstable.
Start a recurring app plan for this store through the unstable channel.
GET /admin/api/unstable/recurring_application_charges.json List app subscriptions (unstable API) · Shopify Retrieves A List Of Recurring Application Charges #
Ask an LLM
“Can I list recurring app charges on the unstable Admin API?”
“Does the unstable recurring charge list support since_id?”
Tell an agent
List recurring app charges on unstable.
Via unstable, show subscription charges after {since_id}.
DELETE /admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}.json Cancel an app subscription (unstable API) · Shopify Cancels A Recurring Application Charge #
Ask an LLM
“How do I cancel a recurring app charge through the unstable API?”
“Can the unstable channel end a merchant's app subscription?”
Tell an agent destructive · confirm first
Cancel recurring charge {recurring_application_charge_id} on unstable.
Unstable channel: end subscription {recurring_application_charge_id}.
GET /admin/api/2021-01/deprecated_api_calls.json List my app's deprecated API calls (API 2021-01) · Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated… #
Ask an LLM
“Which deprecated Admin API calls has my app been making, according to 2021-01?”
“Can I audit my app for calls to retired endpoints on the January 2021 release?”
Tell an agent
List the deprecated API calls my app made, using 2021-01.
Show my app's usage of deprecated endpoints from the January 2021 API.
GET /admin/api/unstable/deprecated_api_calls.json List my app's deprecated API calls (unstable API) · Shopify Retrieves A List Of Deprecated Api Calls Made By The Authenticated… #
Ask an LLM
“Does the unstable API report which deprecated calls my app still makes?”
“Where do I find my app's deprecated call history on the unstable channel?”
Tell an agent
List deprecated calls made by my app via unstable.
Unstable channel: report the retired endpoints my app is still hitting.
GET /admin/api/2020-01/collection_listings.json List collections published to my app (API 2020-01) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“How do I see which collections a merchant published to my sales channel app on 2020-01?”
“Can I cap how many collection listings come back on the 2020-01 API?”
Tell an agent
List collection listings published to my app, version 2020-01.
Show the first {limit} collections published to my app, January 2020 release.
GET /admin/api/2020-01/collection_listings/{collection_listing_id}.json Get a collection listing (API 2020-01) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“Where do I read one collection that's published to my app on API 2020-01?”
“Which January 2020 call returns a single collection listing by ID?”
Tell an agent
Get collection listing {collection_listing_id} on 2020-01.
Show published collection {collection_listing_id} from the January 2020 API.
PUT /admin/api/2020-01/collection_listings/{collection_listing_id}.json Publish a collection to my app (API 2020-01) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“How do I publish a collection to my sales channel app on the 2020-01 API?”
“Is publishing a collection listing a PUT by collection ID in January 2020?”
Tell an agent
Publish collection {collection_listing_id} to my app via 2020-01.
Create a collection listing for {collection_listing_id}, January 2020 release.
DELETE /admin/api/2020-01/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (API 2020-01) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“How do I take a collection off my sales channel app on API 2020-01?”
“Does deleting a collection listing on 2020-01 unpublish it from my app?”
Tell an agent destructive · confirm first
Unpublish collection {collection_listing_id} from my app using 2020-01.
Delete collection listing {collection_listing_id} on the January 2020 version.
GET /admin/api/2020-04/collection_listings.json List collections published to my app (API 2020-04) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“Which collections are published to my channel app, per the April 2020 API?”
“Is there a limit parameter on 2020-04 collection listings?”
Tell an agent
Show collections published to my app with 2020-04.
List up to {limit} collection listings from the April 2020 version.
GET /admin/api/2020-04/collection_listings/{collection_listing_id}.json Get a collection listing (API 2020-04) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“How can I fetch one collection listing published to my app on 2020-04?”
“What April 2020 endpoint shows a specific published collection?”
Tell an agent
Retrieve collection listing {collection_listing_id} via 2020-04.
Open published collection {collection_listing_id} on the April 2020 release.
PUT /admin/api/2020-04/collection_listings/{collection_listing_id}.json Publish a collection to my app (API 2020-04) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“Can I publish a store collection to my channel app on the April 2020 API?”
“Which 2020-04 call creates a collection listing for my app?”
Tell an agent
Publish collection {collection_listing_id} to my channel, API 2020-04.
Make collection {collection_listing_id} available in my app, April 2020 version.
DELETE /admin/api/2020-04/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (API 2020-04) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“How can I unpublish a collection from my app with the 2020-04 release?”
“Which April 2020 call deletes a collection listing?”
Tell an agent destructive · confirm first
Remove collection {collection_listing_id} from my app on 2020-04.
Unpublish collection listing {collection_listing_id} via the April 2020 API.
GET /admin/api/2020-07/collection_listings.json List collections published to my app (API 2020-07) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“What's the July 2020 call to list collection listings for my app?”
“Can I limit the number of 2020-07 collection listings returned?”
Tell an agent
Get collection listings for my app from 2020-07.
Return {limit} published collections via the July 2020 API.
GET /admin/api/2020-07/collection_listings/{collection_listing_id}.json Get a collection listing (API 2020-07) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“Where do I get a single published collection for my app on 2020-07?”
“Does the July 2020 API return a collection listing by its ID?”
Tell an agent
Fetch collection listing {collection_listing_id} on API 2020-07.
Look up published collection {collection_listing_id}, July 2020 release.
PUT /admin/api/2020-07/collection_listings/{collection_listing_id}.json Publish a collection to my app (API 2020-07) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“How would I publish a collection to my app using the July 2020 version?”
“Is a collection listing created with PUT on 2020-07?”
Tell an agent
Publish collection {collection_listing_id} to my app on 2020-07.
List collection {collection_listing_id} in my sales channel, July 2020 API.
DELETE /admin/api/2020-07/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (API 2020-07) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“Can I unpublish a collection from my channel app on API 2020-07?”
“What July 2020 call removes a collection listing?”
Tell an agent destructive · confirm first
Unpublish collection {collection_listing_id} via version 2020-07.
Delete the listing for collection {collection_listing_id}, July 2020 release.
GET /admin/api/2020-10/collection_listings.json List collections published to my app (API 2020-10) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“How do I list the collections published to my sales channel on the 2020-10 API?”
“Can I set a page size for October 2020 collection listings?”
Tell an agent
List collection listings on API version 2020-10.
Show {limit} collections published to my app, October 2020 release.
GET /admin/api/2020-10/collection_listings/{collection_listing_id}.json Get a collection listing (API 2020-10) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“What's the 2020-10 call to read one collection listing for my app?”
“Can I retrieve a specific published collection on the October 2020 version?”
Tell an agent
Get collection listing {collection_listing_id}, API 2020-10.
Show the published collection {collection_listing_id} via October 2020.
PUT /admin/api/2020-10/collection_listings/{collection_listing_id}.json Publish a collection to my app (API 2020-10) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“How do I publish a collection to my channel app on the current 2020-10 API?”
“Which October 2020 endpoint creates a collection listing?”
Tell an agent
Publish collection {collection_listing_id} to my app on 2020-10.
Create a listing for collection {collection_listing_id} with the October 2020 API.
DELETE /admin/api/2020-10/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (API 2020-10) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“How can I unpublish a collection from my sales channel with API 2020-10?”
“Does deleting an October 2020 collection listing remove it from my app?”
Tell an agent destructive · confirm first
Unpublish collection {collection_listing_id} on 2020-10.
Delete collection listing {collection_listing_id} via the October 2020 release.
GET /admin/api/2021-01/collection_listings.json List collections published to my app (API 2021-01) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“Which call lists collections published to my app on the 2021-01 release?”
“Is limit supported on January 2021 collection listings?”
Tell an agent
Pull collection listings for my app via 2021-01.
List the first {limit} collections published to my channel, January 2021 API.
GET /admin/api/2021-01/collection_listings/{collection_listing_id}.json Get a collection listing (API 2021-01) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“How do I view one collection listing for my app on 2021-01?”
“Can I look up a published collection by ID with the January 2021 API?”
Tell an agent
View collection listing {collection_listing_id} on 2021-01.
Read published collection {collection_listing_id} from the January 2021 release.
PUT /admin/api/2021-01/collection_listings/{collection_listing_id}.json Publish a collection to my app (API 2021-01) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“Can I publish a collection to my sales channel on API version 2021-01?”
“What January 2021 call creates a collection listing?”
Tell an agent
Publish collection {collection_listing_id} to my channel via 2021-01.
Add collection {collection_listing_id} to my app, January 2021 version.
DELETE /admin/api/2021-01/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (API 2021-01) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“How do I remove a collection from my app on the 2021-01 release?”
“Which January 2021 endpoint unpublishes a collection listing?”
Tell an agent destructive · confirm first
Unpublish collection {collection_listing_id} using 2021-01.
Take collection {collection_listing_id} off my channel with the January 2021 API.
GET /admin/api/unstable/collection_listings.json List collections published to my app (unstable) · Shopify Retrieve Collection Listings That Are Published To Your App #
Ask an LLM
“Can I list collection listings for my app on the unstable API?”
“Does the unstable collection listing endpoint accept a limit?”
Tell an agent
List collections published to my app on unstable.
Via unstable, return {limit} collection listings.
GET /admin/api/unstable/collection_listings/{collection_listing_id}.json Get a collection listing (unstable API) · Shopify Retrieve A Specific Collection Listing That Is Published To Your App #
Ask an LLM
“How do I get one collection listing through the unstable version?”
“What unstable call returns a published collection by ID?”
Tell an agent
Get collection listing {collection_listing_id} on unstable.
Unstable channel: show published collection {collection_listing_id}.
PUT /admin/api/unstable/collection_listings/{collection_listing_id}.json Publish a collection to my app (unstable API) · Shopify Create A Collection Listing To Publish A Collection To Your App #
Ask an LLM
“Can the unstable API publish a collection to my sales channel app?”
“What unstable endpoint creates a collection listing?”
Tell an agent
Publish collection {collection_listing_id} to my app via unstable.
Unstable channel: create a listing for collection {collection_listing_id}.
DELETE /admin/api/unstable/collection_listings/{collection_listing_id}.json Unpublish a collection from my app (unstable) · Shopify Delete A Collection Listing To Unpublish A Collection From Your App #
Ask an LLM
“How can I unpublish a collection from my app on the unstable channel?”
“Does the unstable API delete collection listings?”
Tell an agent destructive · confirm first
Unpublish collection {collection_listing_id} on unstable.
Via unstable, remove the listing for collection {collection_listing_id}.
GET /admin/api/2020-01/product_listings.json List products published to my app (API 2020-01) · Shopify Retrieve Product Listings That Are Published To Your App #
Ask an LLM
“How do I list the products a merchant published to my sales channel on API 2020-01?”
“Can I filter 2020-01 product listings by collection or recent updates?”
Tell an agent
List product listings in collection {collection_id}, version 2020-01.
Show products published to my app updated since {updated_at_min}, January 2020 API.
GET /admin/api/2020-01/product_listings/product_ids.json List IDs of products published to my app (2020-01) · Shopify Retrieve Product_ids That Are Published To Your App #
Ask an LLM
“Is there a lightweight 2020-01 call that returns only the product IDs published to my app?”
“How many product IDs can one January 2020 product_ids call return?”
Tell an agent
Get the IDs of all products published to my app via 2020-01.
Return {limit} published product IDs from the January 2020 release.
GET /admin/api/2020-01/product_listings/count.json Count products published to my app (API 2020-01) · Shopify Retrieve A Count Of Products That Are Published To Your App #
Ask an LLM
“How many products are published to my sales channel app, per API 2020-01?”
“What January 2020 endpoint counts my app's product listings?”
Tell an agent
Count product listings for my app on 2020-01.
Tell me the number of products published to my channel, January 2020 version.
GET /admin/api/2020-01/product_listings/{product_listing_id}.json Get a product listing (API 2020-01) · Shopify Retrieve A Specific Product Listing That Is Published To Your App #
Ask an LLM
“Where do I read one product published to my app on the 2020-01 API?”
“Which January 2020 call returns a single product listing?”
Tell an agent
Get product listing {product_listing_id} on API 2020-01.
Show published product {product_listing_id} from the January 2020 release.
PUT /admin/api/2020-01/product_listings/{product_listing_id}.json Publish a product to my app (API 2020-01) · Shopify Create A Product Listing To Publish A Product To Your App #
Ask an LLM
“How do I publish a product to my sales channel app on 2020-01?”
“Is creating a product listing a PUT by product ID on the January 2020 API?”
Tell an agent
Publish product {product_listing_id} to my app via 2020-01.
Create a product listing for {product_listing_id}, January 2020 version.
DELETE /admin/api/2020-01/product_listings/{product_listing_id}.json Unpublish a product from my app (API 2020-01) · Shopify Delete A Product Listing To Unpublish A Product From Your App #
Ask an LLM
“How can I unpublish a product from my channel app on API 2020-01?”
“Which January 2020 call deletes a product listing?”
Tell an agent destructive · confirm first
Unpublish product {product_listing_id} from my app on 2020-01.
Delete product listing {product_listing_id} using the January 2020 API.
GET /admin/api/2020-04/product_listings.json List products published to my app (API 2020-04) · Shopify Retrieve Product Listings That Are Published To Your App #
Ask an LLM
“Which products are published to my app, using the April 2020 API?”
“Can I look up April 2020 product listings by handle or specific product IDs?”
Tell an agent
List product listings with handle {handle} on version 2020-04.
Show published products {product_ids} from the April 2020 release.
GET /admin/api/2020-04/product_listings/product_ids.json List IDs of products published to my app (2020-04) · Shopify Retrieve Product_ids That Are Published To Your App #
Ask an LLM
“Can I fetch just the product IDs published to my channel on API 2020-04?”
“Does the April 2020 product_ids endpoint take a limit?”
Tell an agent
List published product IDs for my app via 2020-04.
Give me {limit} product IDs published to my channel, April 2020.
GET /admin/api/2020-04/product_listings/count.json Count products published to my app (API 2020-04) · Shopify Retrieve A Count Of Products That Are Published To Your App #
Ask an LLM
“What's the April 2020 call to count products published to my app?”
“Can I get a product listing total without paging on 2020-04?”
Tell an agent
Count products published to my app using 2020-04.
Return the product listing total for my channel, April 2020 API.
GET /admin/api/2020-04/product_listings/{product_listing_id}.json Get a product listing (API 2020-04) · Shopify Retrieve A Specific Product Listing That Is Published To Your App #
Ask an LLM
“How can I fetch one product listing for my app on the 2020-04 version?”
“What April 2020 endpoint shows a specific published product?”
Tell an agent
Retrieve product listing {product_listing_id} via 2020-04.
Open published product {product_listing_id} on the April 2020 release.
PUT /admin/api/2020-04/product_listings/{product_listing_id}.json Publish a product to my app (API 2020-04) · Shopify Create A Product Listing To Publish A Product To Your App #
Ask an LLM
“When a merchant picks a product for my channel, how do I list it through the April 2020 API?”
“Which 2020-04 call creates a product listing for my app?”
Tell an agent
Publish product {product_listing_id} to my channel, API 2020-04.
Make product {product_listing_id} available in my app, April 2020 version.
DELETE /admin/api/2020-04/product_listings/{product_listing_id}.json Unpublish a product from my app (API 2020-04) · Shopify Delete A Product Listing To Unpublish A Product From Your App #
Ask an LLM
“How do I remove a product from my sales channel app on 2020-04?”
“Does deleting an April 2020 product listing unpublish the product?”
Tell an agent destructive · confirm first
Remove product {product_listing_id} from my app on 2020-04.
Unpublish product listing {product_listing_id} via the April 2020 API.
GET /admin/api/2020-07/product_listings.json List products published to my app (API 2020-07) · Shopify Retrieve Product Listings That Are Published To Your App #
Ask an LLM
“What's the July 2020 call to list products published to my sales channel?”
“Can I cap and filter July 2020 product listings by update date?”
Tell an agent
List {limit} product listings for my app via 2020-07.
Show July 2020 published products changed after {updated_at_min} in collection {collection_id}.
GET /admin/api/2020-07/product_listings/product_ids.json List IDs of products published to my app (2020-07) · Shopify Retrieve Product_ids That Are Published To Your App #
Ask an LLM
“Is there a July 2020 endpoint returning only the IDs of products published to my app?”
“How do I page product IDs for my channel on 2020-07?”
Tell an agent
Get published product IDs for my app from 2020-07.
Return up to {limit} channel product IDs, July 2020 release.
GET /admin/api/2020-07/product_listings/count.json Count products published to my app (API 2020-07) · Shopify Retrieve A Count Of Products That Are Published To Your App #
Ask an LLM
“How many products has the merchant published to my app, per the 2020-07 API?”
“Which July 2020 call gives a product listing count?”
Tell an agent
Count my app's product listings on version 2020-07.
How many products are in my channel? Use the July 2020 count endpoint.
GET /admin/api/2020-07/product_listings/{product_listing_id}.json Get a product listing (API 2020-07) · Shopify Retrieve A Specific Product Listing That Is Published To Your App #
Ask an LLM
“What does one product listing look like when I fetch it by product ID on 2020-07?”
“Does the July 2020 API return a product listing by its ID?”
Tell an agent
Fetch product listing {product_listing_id} on API 2020-07.
Look up published product {product_listing_id}, July 2020 release.
PUT /admin/api/2020-07/product_listings/{product_listing_id}.json Publish a product to my app (API 2020-07) · Shopify Create A Product Listing To Publish A Product To Your App #
Ask an LLM
“Which July 2020 call makes a store product show up in my sales channel?”
“Is a product listing created with PUT on 2020-07?”
Tell an agent
Publish product {product_listing_id} to my app on 2020-07.
List product {product_listing_id} in my sales channel, July 2020 API.
DELETE /admin/api/2020-07/product_listings/{product_listing_id}.json Unpublish a product from my app (API 2020-07) · Shopify Delete A Product Listing To Unpublish A Product From Your App #
Ask an LLM
“How do I stop selling a product through my app with the 2020-07 release?”
“What July 2020 call removes a product listing?”
Tell an agent destructive · confirm first
Unpublish product {product_listing_id} via version 2020-07.
Delete the listing for product {product_listing_id}, July 2020 release.
GET /admin/api/2020-01/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (2020-01) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“How does my fulfillment app see the fulfillment orders assigned to it on API 2020-01?”
“Can I filter 2020-01 assigned fulfillment orders by assignment status?”
Tell an agent
List fulfillment orders assigned to my app with status {assignment_status}, API 2020-01.
Show fulfillment orders assigned to locations {location_ids}, January 2020 release.
GET /admin/api/2020-04/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (2020-04) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“Which fulfillment orders are assigned to my fulfillment service, per the April 2020 API?”
“Can I narrow 2020-04 assigned fulfillment orders to specific locations?”
Tell an agent
Get fulfillment orders assigned to my app at locations {location_ids} via 2020-04.
List April 2020 assigned fulfillment orders in {assignment_status} status.
GET /admin/api/2020-07/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (2020-07) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“What's the July 2020 call for a fulfillment app to list its assigned fulfillment orders?”
“Can I find 2020-07 fulfillment orders where the merchant requested cancellation?”
Tell an agent
Show my app's assigned fulfillment orders on 2020-07.
List July 2020 assigned fulfillment orders filtered to {assignment_status}.
GET /admin/api/2020-10/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (2020-10) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“How can my fulfillment service list the orders assigned to it on the 2020-10 API?”
“Is there a way to see only fulfillment requests awaiting my app's response in October 2020?”
Tell an agent
List fulfillment orders assigned to my app in status {assignment_status}, version 2020-10.
Get October 2020 assigned fulfillment orders for locations {location_ids}.
GET /admin/api/2021-01/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (2021-01) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“Which call returns fulfillment orders assigned to my app on the 2021-01 release?”
“Can January 2021 assigned fulfillment orders be filtered by location?”
Tell an agent
Pull fulfillment orders assigned to my app via 2021-01.
Show January 2021 assigned fulfillment orders at {location_ids} with status {assignment_status}.
GET /admin/api/unstable/assigned_fulfillment_orders.json List fulfillment orders assigned to my app (unstable) · Shopify Retrieves A List Of Fulfillment Orders On A Shop For A Specific App #
Ask an LLM
“Can I list my app's assigned fulfillment orders on the unstable API?”
“Does the unstable assigned fulfillment order list filter by assignment status?”
Tell an agent
List assigned fulfillment orders for my app on unstable.
Via unstable, get assigned fulfillment orders with status {assignment_status}.

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-applications-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-applications-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-applications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Applications 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 (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-applications-api-openapi.yml