Shopify

Shopify Code API

The Code API from Shopify — 36 operation(s) for code.

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 48

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/price_rules/{price_rule_id}/discount_codes.json Add a discount code to a price rule (2020-01) · Shopify Creates A Discount Code #
Ask an LLM
“How do I add a new discount code to a price rule on the 2020-01 API?”
“Can I create a single discount code under an existing price rule with version 2020-01?”
Tell an agent
Create a discount code under price rule {price_rule_id} using API version 2020-01.
On 2020-01, add one new code to price rule {price_rule_id}.
PUT /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Change an existing discount code (2020-01) · Shopify Updates An Existing Discount Code #
Ask an LLM
“How can I edit a discount code that already exists, using the 2020-01 version?”
“Can I modify a discount code I already created under a price rule in 2020-01?”
Tell an agent
Update discount code {discount_code_id} on price rule {price_rule_id} with API version 2020-01.
Edit existing code {discount_code_id} in price rule {price_rule_id} (2020-01).
GET /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Look up one discount code by ID (2020-01) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“Can I fetch a single discount code by its ID on API version 2020-01?”
“What details does the 2020-01 endpoint return for one discount code of a price rule?”
Tell an agent
Retrieve discount code {discount_code_id} from price rule {price_rule_id} via 2020-01.
Show me code {discount_code_id} belonging to price rule {price_rule_id}, version 2020-01.
DELETE /admin/api/2020-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Delete a discount code (2020-01) · Shopify Deletes A Discount Code #
Ask an LLM
“How do I permanently remove a discount code from a price rule in 2020-01?”
“Can a discount code be deleted through the 2020-01 API version?”
Tell an agent destructive · confirm first
Delete discount code {discount_code_id} from price rule {price_rule_id} using 2020-01.
Remove code {discount_code_id} under price rule {price_rule_id} on version 2020-01.
GET /admin/api/2020-01/discount_codes/lookup.json Find where a discount code lives by its code (2020-01) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“Given only the text a shopper typed, where does that discount code live according to the 2020-01 lookup?”
“Can I locate a discount code by its code string with the 2020-01 lookup?”
Tell an agent
Look up the location of discount code {code} using the 2020-01 lookup.
Find where the code {code} is stored (API 2020-01).
POST /admin/api/2020-01/price_rules/{price_rule_id}/batch.json Start a bulk discount code creation job (2020-01) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“How can I create many discount codes at once for a price rule on 2020-01?”
“Is there a batch job for generating discount codes in bulk in the 2020-01 version?”
Tell an agent
Start a discount code creation job for price rule {price_rule_id} on 2020-01.
Queue a batch of new codes under price rule {price_rule_id} with API version 2020-01.
GET /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}.json Check a discount code creation job (2020-01) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“What is the status of my bulk discount code job on 2020-01?”
“Has my batch discount code creation job finished, on the 2020-01 API?”
Tell an agent
Get creation job {batch_id} for price rule {price_rule_id} via 2020-01.
Check progress of batch {batch_id} on price rule {price_rule_id}, version 2020-01.
GET /admin/api/2020-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json List codes produced by a creation job (2020-01) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“Which discount codes did my batch creation job produce, using 2020-01?”
“Can I list every code a discount code creation job generated with the 2020-01 API?”
Tell an agent
List the discount codes created by job {batch_id} for price rule {price_rule_id} on 2020-01.
Show codes from batch {batch_id} under price rule {price_rule_id} (2020-01).
POST /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes.json Create a discount code for a price rule (2020-04) · Shopify Creates A Discount Code #
Ask an LLM
“Can I generate one new discount code for an existing price rule through version 2020-04?”
“What does the 2020-04 release need to create a discount code under a price rule?”
Tell an agent
Using version 2020-04, make a new discount code for price rule {price_rule_id}.
Add a single code to price rule {price_rule_id} through the 2020-04 endpoint.
PUT /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Update an existing discount code (2020-04) · Shopify Updates An Existing Discount Code #
Ask an LLM
“Can I change a discount code after creating it, using release 2020-04?”
“What's the 2020-04 call for modifying a discount code already attached to a price rule?”
Tell an agent
Modify discount code {discount_code_id} in price rule {price_rule_id} through release 2020-04.
With 2020-04, save changes to code {discount_code_id} of price rule {price_rule_id}.
GET /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Retrieve a single discount code (2020-04) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“Where can I read back one discount code's details with the 2020-04 release?”
“Can the 2020-04 version fetch a discount code if I know its ID and price rule?”
Tell an agent
Fetch discount code {discount_code_id} of price rule {price_rule_id} with the 2020-04 release.
Pull up the 2020-04 record for code {discount_code_id} in price rule {price_rule_id}.
DELETE /admin/api/2020-04/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Remove a discount code (2020-04) · Shopify Deletes A Discount Code #
Ask an LLM
“Can I delete a discount code shoppers should no longer use, with release 2020-04?”
“Which 2020-04 call removes a discount code from its price rule for good?”
Tell an agent destructive · confirm first
Using release 2020-04, delete code {discount_code_id} from price rule {price_rule_id}.
Permanently drop discount code {discount_code_id} of price rule {price_rule_id} in 2020-04.
GET /admin/api/2020-04/discount_codes/lookup.json Locate a discount code by its code text (2020-04) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“If I only know the discount code a customer entered, can 2020-04 tell me where it lives?”
“Which 2020-04 endpoint resolves a code string to its discount code record?”
Tell an agent
Resolve the discount code {code} to its location with release 2020-04.
Using 2020-04, find where code {code} is stored.
POST /admin/api/2020-04/price_rules/{price_rule_id}/batch.json Queue a bulk discount code creation job (2020-04) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“Can I generate discount codes in bulk for one price rule with the 2020-04 release?”
“What's the 2020-04 way to kick off a batch of new discount codes?”
Tell an agent
Kick off a bulk code creation job on price rule {price_rule_id} through 2020-04.
Create a discount code batch for price rule {price_rule_id} using release 2020-04.
GET /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}.json Get a discount code creation job's status (2020-04) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“Can I poll a bulk discount code job for completion on release 2020-04?”
“Where do I see whether a 2020-04 discount code batch is still running?”
Tell an agent
Poll batch job {batch_id} on price rule {price_rule_id} with release 2020-04.
Using 2020-04, report the state of creation job {batch_id} for price rule {price_rule_id}.
GET /admin/api/2020-04/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json List discount codes from a creation job (2020-04) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“After a bulk job finishes, how can I get its discount codes on release 2020-04?”
“Can 2020-04 list the codes that belong to one creation job?”
Tell an agent
Using release 2020-04, list codes generated by batch {batch_id} on price rule {price_rule_id}.
Fetch the discount codes from creation job {batch_id}, price rule {price_rule_id}, in 2020-04.
POST /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes.json Issue a new discount code on a price rule (2020-07) · Shopify Creates A Discount Code #
Ask an LLM
“How would I issue a fresh discount code for a promotion's price rule on 2020-07?”
“Does the 2020-07 API let me attach a new code to a price rule I already set up?”
Tell an agent
Issue a new discount code on price rule {price_rule_id} (API 2020-07).
For the 2020-07 API, create one code tied to price rule {price_rule_id}.
PUT /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Edit a discount code (2020-07) · Shopify Updates An Existing Discount Code #
Ask an LLM
“Does the 2020-07 API allow editing a discount code that shoppers already use?”
“Can I adjust an existing code on a price rule through 2020-07?”
Tell an agent
Apply changes to discount code {discount_code_id} on price rule {price_rule_id}, API 2020-07.
Edit code {discount_code_id} belonging to price rule {price_rule_id} with the 2020-07 API.
GET /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Get one discount code's details (2020-07) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“What information comes back for a single discount code on the 2020-07 API?”
“Can I look at one specific code under a price rule with 2020-07?”
Tell an agent
Get the details of code {discount_code_id} under price rule {price_rule_id} from API 2020-07.
Read discount code {discount_code_id} for price rule {price_rule_id} on the 2020-07 API.
DELETE /admin/api/2020-07/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Delete a discount code from a price rule (2020-07) · Shopify Deletes A Discount Code #
Ask an LLM
“How can I retire a discount code by deleting it on the 2020-07 API?”
“Is deleting a single code under a price rule supported in 2020-07?”
Tell an agent destructive · confirm first
Retire discount code {discount_code_id} by deleting it from price rule {price_rule_id} (API 2020-07).
Delete code {discount_code_id} on price rule {price_rule_id} with the 2020-07 API.
GET /admin/api/2020-07/discount_codes/lookup.json Look up a discount code by its code (2020-07) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“A customer gave me a promo code; can the 2020-07 API show me where that discount code lives?”
“Is there a 2020-07 lookup that searches discount codes by their code value?”
Tell an agent
Look up promo code {code} with the 2020-07 API.
Find the discount code record for {code} on API 2020-07.
POST /admin/api/2020-07/price_rules/{price_rule_id}/batch.json Bulk-create discount codes for a price rule (2020-07) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“Is bulk generation of discount codes for a single price rule available on 2020-07?”
“What's involved in creating a large set of codes in one job with the 2020-07 API?”
Tell an agent
Bulk-create discount codes for price rule {price_rule_id} on the 2020-07 API.
Start a 2020-07 creation job that adds codes to price rule {price_rule_id}.
GET /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}.json Retrieve a discount code creation job (2020-07) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“Can the 2020-07 API tell me if a discount code creation job is done?”
“What status does a bulk code job report on 2020-07?”
Tell an agent
Retrieve creation job {batch_id} of price rule {price_rule_id} from the 2020-07 API.
Check whether batch {batch_id} on price rule {price_rule_id} has finished, using 2020-07.
GET /admin/api/2020-07/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json Get the codes a creation job produced (2020-07) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“What codes came out of my 2020-07 bulk discount job?”
“Can I pull the full set of codes from one creation job on API 2020-07?”
Tell an agent
Get the codes produced by creation job {batch_id} for price rule {price_rule_id} (API 2020-07).
List batch {batch_id}'s discount codes on price rule {price_rule_id} via the 2020-07 API.
POST /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes.json Create a discount code (2020-10, current version) · Shopify Creates A Discount Code #
Ask an LLM
“How do I create a discount code for a price rule on the current 2020-10 version?”
“What's needed to add a code to a price rule in 2020-10?”
Tell an agent
Create a new discount code for price rule {price_rule_id} on 2020-10.
Add a discount code to my price rule {price_rule_id} using the non-deprecated 2020-10 API.
PUT /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Update a discount code (2020-10) · Shopify Updates An Existing Discount Code #
Ask an LLM
“What's the way to update an existing discount code with the current 2020-10 version?”
“Can a code already on a price rule be changed via 2020-10?”
Tell an agent
Update discount code {discount_code_id} under price rule {price_rule_id} on 2020-10.
Change existing code {discount_code_id} for price rule {price_rule_id} with the 2020-10 API.
GET /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Retrieve a discount code (2020-10) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“Can I retrieve one discount code by ID with the non-deprecated 2020-10 API?”
“Which details of a single price rule code does 2020-10 return?”
Tell an agent
Retrieve discount code {discount_code_id} for price rule {price_rule_id} on 2020-10.
Show discount code {discount_code_id} from price rule {price_rule_id}, current 2020-10 version.
DELETE /admin/api/2020-10/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Delete a discount code (2020-10) · Shopify Deletes A Discount Code #
Ask an LLM
“Can I delete a discount code with the non-deprecated 2020-10 API?”
“Which 2020-10 call removes one code from a price rule?”
Tell an agent destructive · confirm first
Delete discount code {discount_code_id} from price rule {price_rule_id} on 2020-10.
Remove code {discount_code_id} for price rule {price_rule_id} using the current 2020-10 version.
GET /admin/api/2020-10/discount_codes/lookup.json Find a discount code by its code value (2020-10) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“How can I find a discount code's location from its code text on 2020-10?”
“Does the current 2020-10 API have a lookup by discount code value?”
Tell an agent
Find the location of discount code {code} using the 2020-10 lookup.
Look up code {code} with the current 2020-10 version.
POST /admin/api/2020-10/price_rules/{price_rule_id}/batch.json Create a discount code creation job (2020-10) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“Can I create discount codes in bulk on the current 2020-10 version?”
“What does a 2020-10 batch job for new discount codes need?”
Tell an agent
Create a discount code creation job for price rule {price_rule_id} on 2020-10.
Generate codes in bulk for price rule {price_rule_id} with the non-deprecated 2020-10 API.
GET /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}.json Check a discount code creation job (2020-10) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“How do I check whether a 2020-10 discount code batch has completed?”
“Can I retrieve one creation job by ID on the current 2020-10 API?”
Tell an agent
Retrieve creation job {batch_id} for price rule {price_rule_id} on 2020-10.
Check the status of batch {batch_id} under price rule {price_rule_id} using the current 2020-10 version.
GET /admin/api/2020-10/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json List a creation job's discount codes (2020-10) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“Which codes did a discount code creation job produce, on the current 2020-10 API?”
“Can 2020-10 list all discount codes from one bulk job?”
Tell an agent
List discount codes created by batch {batch_id} for price rule {price_rule_id} on 2020-10.
Show the codes job {batch_id} generated for price rule {price_rule_id}, current 2020-10 version.
POST /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes.json Create a discount code on a price rule (2021-01) · Shopify Creates A Discount Code #
Ask an LLM
“Is creating a discount code under a price rule possible with version 2021-01?”
“What's the 2021-01 endpoint for adding one code to a price rule?”
Tell an agent
With version 2021-01, create a discount code under price rule {price_rule_id}.
Set up one new code on price rule {price_rule_id} via the 2021-01 version.
PUT /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Modify a discount code (2021-01) · Shopify Updates An Existing Discount Code #
Ask an LLM
“Can I modify a price rule's existing discount code in version 2021-01?”
“Which 2021-01 call updates a code that already exists?”
Tell an agent
With version 2021-01, update code {discount_code_id} on price rule {price_rule_id}.
Revise discount code {discount_code_id} in price rule {price_rule_id} through the 2021-01 version.
GET /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Fetch a single discount code (2021-01) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“Can version 2021-01 return a single discount code by its ID?”
“What does one price rule code look like when fetched through 2021-01?”
Tell an agent
With version 2021-01, fetch discount code {discount_code_id} on price rule {price_rule_id}.
Display code {discount_code_id} of price rule {price_rule_id} from the 2021-01 version.
DELETE /admin/api/2021-01/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Delete a discount code (2021-01) · Shopify Deletes A Discount Code #
Ask an LLM
“Is it possible to delete one discount code through version 2021-01?”
“Which 2021-01 endpoint deletes a code under a price rule?”
Tell an agent destructive · confirm first
With version 2021-01, delete discount code {discount_code_id} on price rule {price_rule_id}.
Get rid of code {discount_code_id} from price rule {price_rule_id} via the 2021-01 version.
GET /admin/api/2021-01/discount_codes/lookup.json Locate a discount code by code string (2021-01) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“Can version 2021-01 locate a discount code when all I have is its code?”
“Which 2021-01 endpoint turns a code string into its discount code location?”
Tell an agent
With version 2021-01, locate discount code {code}.
Get the location for the code {code} through the 2021-01 version.
POST /admin/api/2021-01/price_rules/{price_rule_id}/batch.json Start a bulk discount code job (2021-01) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“Can version 2021-01 create discount codes for a price rule in one batch job?”
“Which 2021-01 call launches bulk code generation?”
Tell an agent
With version 2021-01, start a bulk creation job for price rule {price_rule_id}.
Launch a batch of discount codes on price rule {price_rule_id} through the 2021-01 version.
GET /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}.json Get a discount code creation job (2021-01) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“Can I look up a bulk discount code job's progress in version 2021-01?”
“Which 2021-01 call returns one discount code creation job?”
Tell an agent
With version 2021-01, get creation job {batch_id} for price rule {price_rule_id}.
Report on batch {batch_id} of price rule {price_rule_id} via the 2021-01 version.
GET /admin/api/2021-01/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json List codes from a bulk creation job (2021-01) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“Can version 2021-01 show the discount codes that a batch job created?”
“Which 2021-01 call lists a creation job's resulting codes?”
Tell an agent
With version 2021-01, list codes made by batch {batch_id} on price rule {price_rule_id}.
Show me what codes job {batch_id} created for price rule {price_rule_id} via the 2021-01 version.
POST /admin/api/unstable/price_rules/{price_rule_id}/discount_codes.json Create a discount code (unstable version) · Shopify Creates A Discount Code #
Ask an LLM
“Can I test creating a discount code on a price rule against the unstable API version?”
“What does the unstable version expect when adding a code to a price rule?”
Tell an agent
On the unstable API version, create a discount code for price rule {price_rule_id}.
Try adding a code to price rule {price_rule_id} using the unstable version.
PUT /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Update a discount code (unstable version) · Shopify Updates An Existing Discount Code #
Ask an LLM
“Can I update an existing discount code against the unstable API version?”
“How does the unstable version handle edits to a price rule's code?”
Tell an agent
On the unstable API version, update discount code {discount_code_id} in price rule {price_rule_id}.
Try editing code {discount_code_id} of price rule {price_rule_id} using the unstable version.
GET /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Retrieve a discount code (unstable version) · Shopify Retrieves A Single Discount Code #
Ask an LLM
“Can I read a single discount code from the unstable API version?”
“What does the unstable version return for one price rule code?”
Tell an agent
On the unstable API version, retrieve code {discount_code_id} from price rule {price_rule_id}.
Try fetching discount code {discount_code_id} of price rule {price_rule_id} with the unstable version.
DELETE /admin/api/unstable/price_rules/{price_rule_id}/discount_codes/{discount_code_id}.json Delete a discount code (unstable version) · Shopify Deletes A Discount Code #
Ask an LLM
“Can I delete a discount code through the unstable API version?”
“Does the unstable version support removing one code from a price rule?”
Tell an agent destructive · confirm first
On the unstable API version, delete discount code {discount_code_id} from price rule {price_rule_id}.
Try removing code {discount_code_id} of price rule {price_rule_id} with the unstable version.
GET /admin/api/unstable/discount_codes/lookup.json Look up a discount code by code (unstable version) · Shopify Retrieves The Location Of A Discount Code #
Ask an LLM
“Can the unstable API version find a discount code from its code text?”
“Does the unstable version offer a discount code lookup by value?”
Tell an agent
On the unstable API version, look up the discount code {code}.
Try locating code {code} using the unstable version.
POST /admin/api/unstable/price_rules/{price_rule_id}/batch.json Start a discount code creation job (unstable) · Shopify Creates A Discount Code Creation Job #
Ask an LLM
“Can I bulk-create discount codes against the unstable API version?”
“Does the unstable version support batch jobs for new discount codes?”
Tell an agent
On the unstable API version, start a code creation job for price rule {price_rule_id}.
Try a bulk discount code batch for price rule {price_rule_id} with the unstable version.
GET /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}.json Check a discount code creation job (unstable) · Shopify Retrieves A Discount Code Creation Job #
Ask an LLM
“Can I check a bulk discount code job's status on the unstable API version?”
“Does the unstable version return a single creation job by ID?”
Tell an agent
On the unstable API version, get creation job {batch_id} of price rule {price_rule_id}.
Try checking batch {batch_id} for price rule {price_rule_id} using the unstable version.
GET /admin/api/unstable/price_rules/{price_rule_id}/batch/{batch_id}/discount_codes.json List a creation job's codes (unstable version) · Shopify Retrieves A List Of Discount Codes For A Discount Code Creation Job #
Ask an LLM
“Can I list the codes a bulk job generated on the unstable API version?”
“Does the unstable version show every code from one creation job?”
Tell an agent
On the unstable API version, list discount codes from batch {batch_id} on price rule {price_rule_id}.
Try listing codes job {batch_id} made for price rule {price_rule_id} with 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-code-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-code-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-code-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Code 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 (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-code-api-openapi.yml