Shopify

Shopify Account API

The Account API from Shopify — 12 operation(s) for account.

GitHub OpenAPI

Operations 12

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/customers/{customer_id}/account_activation_url.json Get a customer account activation link (API 2020-01) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“How do I generate an activation URL for a customer who hasn't activated their account, on API 2020-01?”
“Can I create a one-off account activation link to send myself on the January 2020 release?”
Tell an agent
Generate an account activation URL for customer {customer_id} via 2020-01.
Make a fresh activation link for inactive customer {customer_id}, January 2020 API.
POST /admin/api/2020-01/customers/{customer_id}/send_invite.json Email a customer an account invite (API 2020-01) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“Which 2020-01 call emails a customer an invitation to create their store account?”
“Can I trigger the account invite email for one shopper on the January 2020 API?”
Tell an agent
Send customer {customer_id} an account invite using 2020-01.
Invite shopper {customer_id} to set up their account, January 2020 release.
POST /admin/api/2020-04/customers/{customer_id}/account_activation_url.json Get a customer account activation link (API 2020-04) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“What April 2020 endpoint returns an activation URL for a customer whose account is still disabled?”
“Is the account activation link generated per customer on API 2020-04?”
Tell an agent
Create an activation URL for customer {customer_id} on 2020-04.
Give me the account activation link for {customer_id} from the April 2020 API.
POST /admin/api/2020-04/customers/{customer_id}/send_invite.json Email a customer an account invite (API 2020-04) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“How can I send a customer their account invite email with the April 2020 API?”
“Does version 2020-04 have a send_invite call for customers?”
Tell an agent
Email an account invitation to customer {customer_id} via 2020-04.
On the April 2020 release, send the invite to shopper {customer_id}.
POST /admin/api/2020-07/customers/{customer_id}/account_activation_url.json Get a customer account activation link (API 2020-07) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“Where do I get an account activation URL for an unactivated customer on the July 2020 API?”
“Can the 2020-07 release hand back an activation link instead of emailing it?”
Tell an agent
Generate customer {customer_id}'s activation URL with version 2020-07.
July 2020 API: produce an activation link for customer {customer_id}.
POST /admin/api/2020-07/customers/{customer_id}/send_invite.json Email a customer an account invite (API 2020-07) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“What's the July 2020 call to email a customer an account invite?”
“Is sending a customer account invite a POST on the 2020-07 API?”
Tell an agent
Send an account invite to customer {customer_id} on 2020-07.
Use the July 2020 release to invite {customer_id} to create an account.
POST /admin/api/2020-10/customers/{customer_id}/account_activation_url.json Get a customer account activation link (API 2020-10) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“How do I get an activation URL for a customer who never activated their account, on the 2020-10 API?”
“Which October 2020 endpoint creates a customer account activation link?”
Tell an agent
Create an account activation URL for customer {customer_id}, API 2020-10.
Get a new activation link for customer {customer_id} on the October 2020 version.
POST /admin/api/2020-10/customers/{customer_id}/send_invite.json Email a customer an account invite (API 2020-10) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“Can I email a customer an invite to activate their account with the current 2020-10 API?”
“Which October 2020 call sends a customer account invitation?”
Tell an agent
Send customer {customer_id} an account invite on 2020-10.
Email the account invitation to {customer_id} via the October 2020 release.
POST /admin/api/2021-01/customers/{customer_id}/account_activation_url.json Get a customer account activation link (API 2021-01) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“How can I produce an activation URL for a disabled customer account on 2021-01?”
“Does the January 2021 release still generate customer activation links?”
Tell an agent
Generate an activation link for customer {customer_id} via 2021-01.
January 2021 API: create account activation URL for {customer_id}.
POST /admin/api/2021-01/customers/{customer_id}/send_invite.json Email a customer an account invite (API 2021-01) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“What 2021-01 call emails a shopper an invitation to their store account?”
“Can I resend a customer's account invite on the January 2021 API?”
Tell an agent
Invite customer {customer_id} to their account using 2021-01.
Send the account invite email to {customer_id}, January 2021 release.
POST /admin/api/unstable/customers/{customer_id}/account_activation_url.json Get a customer account activation link (unstable) · Shopify Generate An Account Activation Url For A Customer Whose Account Is Not… #
Ask an LLM
“Can the unstable API generate an account activation URL for a customer?”
“What unstable endpoint returns an activation link for an inactive customer?”
Tell an agent
Generate an activation URL for customer {customer_id} on unstable.
Unstable channel: create account activation link for {customer_id}.
POST /admin/api/unstable/customers/{customer_id}/send_invite.json Email a customer an account invite (unstable API) · Shopify Sends An Account Invite To A Customer #
Ask an LLM
“Is there an unstable-channel call to send a customer an account invite?”
“How do I email an account invitation to a shopper via the unstable API?”
Tell an agent
Send customer {customer_id} an account invite via unstable.
Unstable channel: invite shopper {customer_id} to create an account.

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-account-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-account-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-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Account 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: Account
paths:
  /admin/api/2020-01/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-04
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-04
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-07
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-07
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2020-10
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2020-10
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-2021-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-2021-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/customers/{customer_id}/account_activation_url.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value: {}
                summary: Creating an account activation URL for an enabled customer fails and returns an error
              example2:
                value: {}
                summary: Create an account activation URL for an invited or disabled customer
      summary: Shopify Generate An Account Activation Url For A Customer Whose Account Is Not…
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#account_activation_url-unstable
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_customers_param_customer_id_account_activation_url
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/customers/{customer_id}/send_invite.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  customer_invite: {}
                summary: Send the default invite
              example2:
                value:
                  customer_invite:
                    to: new_test_email@shopify.com
                    from: noaccesssteve@jobs.com
                    bcc:
                    - noaccesssteve@jobs.com
                    subject: Welcome to my new shop
                    custom_message: My awesome new store
                summary: Send a customized invite
      summary: Shopify Sends An Account Invite To A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer#send_invite-unstable
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Account
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_customers_param_customer_id_send_invite
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true