Shopify

Shopify Endpoint API

The Endpoint API from Shopify — 8 operation(s) for endpoint.

GitHub OpenAPI

Operations 8

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/application_charges/{application_charge_id}/activate.json Activate a one-time app charge (deprecated, API 2020-01) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“After a merchant accepts my one-time app fee, how do I activate it on API 2020-01?”
“Is activating an accepted one-time application charge still required in 2020-01?”
Tell an agent
Activate one-time application charge {charge} using 2020-01.
Confirm the accepted single app purchase {charge} via release 2020-01.
POST /admin/api/2020-04/application_charges/{application_charge_id}/activate.json Activate a one-time app charge (deprecated, API 2020-04) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Can I still call the one-time charge activation step on version 2020-04?”
“What happens to an accepted one-off app payment I activate with 2020-04?”
Tell an agent
Activate the one-off app charge {charge} on 2020-04.
Finalize accepted one-time charge {charge} through the 2020-04 release.
POST /admin/api/2020-07/application_charges/{application_charge_id}/activate.json Activate a one-time app charge (deprecated, API 2020-07) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Is the separate activate call for one-time app charges needed under 2020-07?”
“Which endpoint in 2020-07 turns an accepted single app fee into an active charge?”
Tell an agent
Activate one-time app purchase {charge}, version 2020-07.
Mark accepted application charge {charge} active using API 2020-07.
POST /admin/api/2020-10/application_charges/{application_charge_id}/activate.json Activate a one-time app charge (deprecated, API 2020-10) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Does version 2020-10 still expose activation for one-time application charges?”
“What's the legacy way to activate a merchant-approved one-time app fee in 2020-10?”
Tell an agent
Activate single-payment app charge {charge} with 2020-10.
Run the deprecated 2020-10 activation on one-time charge {charge}.
POST /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.json Activate an app subscription charge (deprecated, 2020-01) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Once a merchant approves my app subscription, how do I activate it with 2020-01?”
“Do recurring application charges need an explicit activate call on API 2020-01?”
Tell an agent
Activate recurring app charge {charge} using API 2020-01.
Start billing on accepted subscription {charge} via 2020-01.
POST /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.json Activate an app subscription charge (deprecated, 2020-04) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Can I activate an approved recurring app plan through release 2020-04?”
“Is subscription activation for apps deprecated as of the 2020-04 version?”
Tell an agent
Activate the recurring application charge {charge} on 2020-04.
Turn on merchant-accepted app subscription {charge}, release 2020-04.
POST /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.json Activate an app subscription charge (deprecated, 2020-07) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Which 2020-07 call activates a recurring charge a store owner already accepted?”
“Does my app still have to activate monthly charges under version 2020-07?”
Tell an agent
Activate subscription charge {charge} with version 2020-07.
Put approved recurring app fee {charge} into effect via 2020-07.
POST /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.json Activate an app subscription charge (deprecated, 2020-10) · Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version… #
Ask an LLM
“Is the old recurring-charge activation step still callable in 2020-10?”
“What does activating an accepted app subscription do on API 2020-10?”
Tell an agent
Activate recurring charge {charge} through API 2020-10.
Call the legacy 2020-10 activate step for app subscription {charge}.

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/shopify/openapi/shopify-endpoint-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-product-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/shopify/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://artifacts.apis.io/shopify/json-structure/shopify-product-structure.json
📊
JSONStructure
https://artifacts.apis.io/shopify/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/shopify/json-ld/shopify-context.jsonld
🔗
Examples
https://artifacts.apis.io/shopify/examples/shopify-create-product-example.json
🔗
Examples
https://artifacts.apis.io/shopify/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://artifacts.apis.io/shopify/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://artifacts.apis.io/shopify/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:shopify-endpoint-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-endpoint-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Endpoint 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:
- name: Endpoint
paths:
  /admin/api/2020-01/application_charges/{application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    id: 675931192
                    name: iPod Cleaning
                    api_client_id: 755357713
                    price: '5.00'
                    status: accepted
                    return_url: http://google.com
                    test: null
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-07T15:53:44-05:00'
                    charge_type: null
                    decorated_return_url: http://google.com?charge_id=675931192
                summary: Activate an application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-01
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_application_charges_param_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/application_charges/{application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    id: 675931192
                    name: iPod Cleaning
                    api_client_id: 755357713
                    price: '5.00'
                    status: accepted
                    return_url: http://google.com
                    test: null
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-07T15:53:44-05:00'
                    charge_type: null
                    decorated_return_url: http://google.com?charge_id=675931192
                summary: Activate an application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-04
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_application_charges_param_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/application_charges/{application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    id: 675931192
                    name: iPod Cleaning
                    api_client_id: 755357713
                    price: '5.00'
                    status: accepted
                    return_url: http://google.com
                    test: null
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-07T15:53:44-05:00'
                    charge_type: null
                    decorated_return_url: http://google.com?charge_id=675931192
                summary: Activate an application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-07
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_application_charges_param_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/application_charges/{application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  application_charge:
                    id: 675931192
                    name: iPod Cleaning
                    api_client_id: 755357713
                    price: '5.00'
                    status: accepted
                    return_url: http://google.com
                    test: null
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-07T15:53:44-05:00'
                    charge_type: null
                    decorated_return_url: http://google.com?charge_id=675931192
                summary: Activate an application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/applicationcharge#activate-2020-10
      parameters:
      - in: path
        name: application_charge_id
        required: true
        schema:
          type: string
        description: application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: create_application_charges_param_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  recurring_application_charge:
                    id: 455696195
                    name: Super Mega Plan
                    api_client_id: 755357713
                    price: '15.00'
                    status: accepted
                    return_url: http://yourapp.com
                    billing_on: '2020-12-07'
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-06T19:00:00-05:00'
                    test: null
                    activated_on: null
                    cancelled_on: null
                    trial_days: 0
                    trial_ends_on: null
                    decorated_return_url: http://yourapp.com?charge_id=455696195
                summary: Activate a recurring application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-01
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_recurring_application_charges_param_recurring_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  recurring_application_charge:
                    id: 455696195
                    name: Super Mega Plan
                    api_client_id: 755357713
                    price: '15.00'
                    status: accepted
                    return_url: http://yourapp.com
                    billing_on: '2020-12-07'
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-06T19:00:00-05:00'
                    test: null
                    activated_on: null
                    cancelled_on: null
                    trial_days: 0
                    trial_ends_on: null
                    decorated_return_url: http://yourapp.com?charge_id=455696195
                summary: Activate a recurring application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-04
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_recurring_application_charges_param_recurring_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  recurring_application_charge:
                    id: 455696195
                    name: Super Mega Plan
                    api_client_id: 755357713
                    price: '15.00'
                    status: accepted
                    return_url: http://yourapp.com
                    billing_on: '2020-12-07'
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-06T19:00:00-05:00'
                    test: null
                    activated_on: null
                    cancelled_on: null
                    trial_days: 0
                    trial_ends_on: null
                    decorated_return_url: http://yourapp.com?charge_id=455696195
                summary: Activate a recurring application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-07
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_recurring_application_charges_param_recurring_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  recurring_application_charge:
                    id: 455696195
                    name: Super Mega Plan
                    api_client_id: 755357713
                    price: '15.00'
                    status: accepted
                    return_url: http://yourapp.com
                    billing_on: '2020-12-07'
                    created_at: '2020-12-07T15:53:44-05:00'
                    updated_at: '2020-12-06T19:00:00-05:00'
                    test: null
                    activated_on: null
                    cancelled_on: null
                    trial_days: 0
                    trial_ends_on: null
                    decorated_return_url: http://yourapp.com?charge_id=455696195
                summary: Activate a recurring application charge
      summary: Shopify This Endpoint Is No Longer Required And Is Deprecated As Of Api Version…
      description: https://shopify.dev/docs/admin-api/rest/reference/billing/recurringapplicationcharge#activate-2020-10
      parameters:
      - in: path
        name: recurring_application_charge_id
        required: true
        schema:
          type: string
        description: recurring_application_charge_id
      tags:
      - Endpoint
      responses:
        '200':
          description: ''
      operationId: create_recurring_application_charges_param_recurring_application_charge_id_activate
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true