Shopify

Shopify Customers API

Manage customer records

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 49

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 /customers.json List customers · Shopify Retrieve a list of customers #
Ask an LLM
“How do I pull a list of my Shopify customers, up to 250 at a time?”
“Which customers signed up between two dates?”
Tell an agent
List my customers created between {created_at_min} and {created_at_max}.
Show customers updated after {updated_at_min}, at most {limit} of them.
POST /customers.json Create a customer · Shopify Create a customer #
Ask an LLM
“Can I add a new customer record and have a welcome email sent to them?”
“What does it take to register a shopper as a customer from my app?”
Tell an agent
Create a new customer from {customer}.
Add customer {customer} to the store and send the welcome email.
GET /customers/count.json Count customers · Shopify Retrieve a count of customers #
Ask an LLM
“How many customers does my store have in total?”
“Is there a quick way to get just the customer total without paging through records?”
Tell an agent
Tell me the total number of customers in my store.
Count all customer records.
GET /customers/search.json Search customers by name, email or phone · Shopify Search for customers #
Ask an LLM
“Can I find a customer by typing part of their email address or phone number?”
“What's the fastest way to look up a shopper by name?”
Tell an agent
Search customers for {query}.
Find up to {limit} customers matching {query}, returning only {fields}.
GET /customers/{customer_id}.json Retrieve a customer · Shopify Retrieve a single customer #
Ask an LLM
“What details are stored for one particular customer ID?”
“Can I fetch a single customer and keep only a few fields in the response?”
Tell an agent
Show me customer {customer_id}.
Get only {fields} for customer {customer_id}.
PUT /customers/{customer_id}.json Update a customer · Shopify Update a customer #
Ask an LLM
“How can I change a customer's details after their record already exists?”
“Can my app edit an existing shopper's profile?”
Tell an agent
Update customer {customer_id} with {customer}.
Save these profile changes {customer} to existing customer {customer_id}.
GET /customers/{customer_id}/orders.json List a customer's orders · Shopify Retrieve orders for a customer #
Ask an LLM
“What has a specific customer ordered from my shop?”
“Can I filter one shopper's order history by status?”
Tell an agent
List every order placed by customer {customer_id}.
Show customer {customer_id}'s orders with status {status}.
GET /admin/api/2020-01/customers.json List customers (API 2020-01) · Shopify Retrieves A List Of Customers #
Ask an LLM
“Where is the customer list endpoint in the 2020-01 Admin API?”
“Can I page customers with since_id on API version 2020-01?”
Tell an agent
Using version 2020-01, list customers after ID {since_id}.
With the 2020-01 API, get customers created from {created_at_min}.
GET /admin/api/2020-04/customers.json List customers (API 2020-04) · Shopify Retrieves A List Of Customers #
Ask an LLM
“Which April 2020 (2020-04) endpoint returns the store's customers?”
“Is filtering the customer list by update date supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, fetch customers changed before {updated_at_max}.
Return {limit} customers with the April 2020 endpoint.
GET /admin/api/2020-07/customers.json List customers (API 2020-07) · Shopify Retrieves A List Of Customers #
Ask an LLM
“My app is pinned to 2020-07; what lists customers there?”
“Can the July 2020 API return customers by a set of IDs?”
Tell an agent
Pull customers {ids} using July 2020 (2020-07).
With API 2020-07, list shoppers created until {created_at_max}.
GET /admin/api/2020-10/customers.json List customers (API 2020-10) · Shopify Retrieves A List Of Customers #
Ask an LLM
“What is the 2020-10 call for listing customers?”
“Does the October 2020 API filter customers by when they were updated?”
Tell an agent
List customers updated since {updated_at_min} on the October 2020 version.
Get the 2020-10 customer list, showing only {fields}.
GET /admin/api/2021-01/customers.json List customers (API 2021-01) · Shopify Retrieves A List Of Customers #
Ask an LLM
“Under the 2021-01 API, where do I list customers?”
“Can I page through customers with the January 2021 API version?”
Tell an agent
Page customers after {since_id} through API version 2021-01.
List {limit} customers against January 2021.
GET /admin/api/unstable/customers.json List customers (unstable API) · Shopify Retrieves A List Of Customers #
Ask an LLM
“Is there an unstable-channel endpoint for listing customers?”
“Can I test the customer list against the unstable API version?”
Tell an agent
List customers on the unstable API.
Against the unstable version, test listing customers created after {created_at_min}.
GET /admin/api/2020-01/customer_saved_searches.json List customer saved searches (API 2020-01) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“Where do I list the saved customer searches (segments) on the 2020-01 API?”
“Can I page saved customer searches with since_id on version 2020-01?”
Tell an agent
List customer saved searches via the 2020-01 API.
Using version 2020-01, show saved customer searches after {since_id}.
POST /admin/api/2020-01/customer_saved_searches.json Create a customer saved search (API 2020-01) · Shopify Creates A Customer Saved Search #
Ask an LLM
“Can I save a customer search for reuse with the 2020-01 API?”
“Which 2020-01 endpoint creates a new customer saved search?”
Tell an agent
Create a customer saved search via the 2020-01 API.
Using version 2020-01, save a new customer segment search.
GET /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (API 2020-01) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“How can I read one saved customer search by ID on the 2020-01 API?”
“What does a single customer saved search contain in version 2020-01?”
Tell an agent
Get customer saved search {customer_saved_search_id} via the 2020-01 API.
Using version 2020-01, show fields {fields} of saved search {customer_saved_search_id}.
PUT /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (API 2020-01) · Shopify Updates A Customer Saved Search #
Ask an LLM
“Can I edit an existing customer saved search using the 2020-01 API?”
“Which 2020-01 endpoint changes a saved customer segment?”
Tell an agent
Update customer saved search {customer_saved_search_id} via the 2020-01 API.
Using version 2020-01, edit saved segment {customer_saved_search_id}.
DELETE /admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (API 2020-01) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“Can I remove a customer saved search I no longer use, on the 2020-01 API?”
“Which 2020-01 endpoint deletes a saved customer segment?”
Tell an agent destructive · confirm first
Delete customer saved search {customer_saved_search_id} via the 2020-01 API.
Using version 2020-01, remove saved segment {customer_saved_search_id}.
GET /admin/api/2020-04/customer_saved_searches.json List customer saved searches (API 2020-04) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“Which April 2020 (2020-04) endpoint returns all customer saved searches?”
“Is limiting the number of saved searches returned supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, fetch the store's customer saved searches.
Return {limit} saved customer searches with the April 2020 endpoint.
POST /admin/api/2020-04/customer_saved_searches.json Create a customer saved search (API 2020-04) · Shopify Creates A Customer Saved Search #
Ask an LLM
“Which April 2020 (2020-04) endpoint adds a customer saved search?”
“Is creating saved customer segments supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, add a customer saved search.
Store a new saved customer segment with the April 2020 endpoint.
GET /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (API 2020-04) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“Which April 2020 (2020-04) endpoint returns one customer saved search?”
“Is fetching a saved customer segment by ID supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, fetch saved search {customer_saved_search_id}.
Pull customer segment {customer_saved_search_id} with the April 2020 endpoint.
PUT /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (API 2020-04) · Shopify Updates A Customer Saved Search #
Ask an LLM
“Which April 2020 (2020-04) endpoint modifies a customer saved search?”
“Is editing a saved customer segment supported in the 2020-04 release?”
Tell an agent
On the 2020-04 release, modify saved search {customer_saved_search_id}.
Apply changes to customer segment {customer_saved_search_id} with the April 2020 endpoint.
DELETE /admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (API 2020-04) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“Which April 2020 (2020-04) endpoint deletes a customer saved search?”
“Is removing a saved customer segment supported in the 2020-04 release?”
Tell an agent destructive · confirm first
On the 2020-04 release, delete saved search {customer_saved_search_id}.
Remove customer segment {customer_saved_search_id} with the April 2020 endpoint.
GET /admin/api/2020-07/customer_saved_searches.json List customer saved searches (API 2020-07) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“My app targets 2020-07; what lists customer saved searches there?”
“Can the July 2020 API show every saved customer segment in my store?”
Tell an agent
Show every saved customer segment using July 2020 (2020-07).
With API 2020-07, list saved searches returning only {fields}.
POST /admin/api/2020-07/customer_saved_searches.json Create a customer saved search (API 2020-07) · Shopify Creates A Customer Saved Search #
Ask an LLM
“My app targets 2020-07; what creates a customer saved search there?”
“Can the July 2020 API save a customer filter as a reusable segment?”
Tell an agent
Save a customer filter as a reusable segment using July 2020 (2020-07).
With API 2020-07, create a new customer saved search.
GET /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (API 2020-07) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“My app targets 2020-07; what reads one customer saved search there?”
“Can the July 2020 API show the query behind a saved customer segment?”
Tell an agent
Show the query behind saved segment {customer_saved_search_id} using July 2020 (2020-07).
With API 2020-07, read customer saved search {customer_saved_search_id}.
PUT /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (API 2020-07) · Shopify Updates A Customer Saved Search #
Ask an LLM
“My app targets 2020-07; what updates a customer saved search there?”
“Can the July 2020 API revise a saved customer segment?”
Tell an agent
Revise saved customer segment {customer_saved_search_id} using July 2020 (2020-07).
With API 2020-07, write updates to saved search {customer_saved_search_id}.
DELETE /admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (API 2020-07) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“My app targets 2020-07; what deletes a customer saved search there?”
“Can the July 2020 API get rid of an outdated customer segment?”
Tell an agent destructive · confirm first
Get rid of outdated segment {customer_saved_search_id} using July 2020 (2020-07).
With API 2020-07, delete customer saved search {customer_saved_search_id}.
GET /admin/api/2020-10/customer_saved_searches.json List customer saved searches (API 2020-10) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“What is the 2020-10 call for listing customer saved searches?”
“Does the October 2020 API page saved customer segments by since_id?”
Tell an agent
List saved customer segments after {since_id} on the October 2020 version.
Get all 2020-10 customer saved searches.
POST /admin/api/2020-10/customer_saved_searches.json Create a customer saved search (API 2020-10) · Shopify Creates A Customer Saved Search #
Ask an LLM
“What is the 2020-10 call for creating a customer saved search?”
“Does the October 2020 API let me define a new saved customer segment?”
Tell an agent
Define a new saved customer segment on the October 2020 version.
Create a 2020-10 customer saved search.
GET /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (API 2020-10) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“What is the 2020-10 call for retrieving one customer saved search?”
“Does the October 2020 API return a single saved customer segment by ID?”
Tell an agent
Return saved customer segment {customer_saved_search_id} on the October 2020 version.
Retrieve the 2020-10 customer saved search {customer_saved_search_id}.
PUT /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (API 2020-10) · Shopify Updates A Customer Saved Search #
Ask an LLM
“What is the 2020-10 call for updating a customer saved search?”
“Does the October 2020 API let me change a saved customer segment?”
Tell an agent
Change saved customer segment {customer_saved_search_id} on the October 2020 version.
Update the 2020-10 customer saved search {customer_saved_search_id}.
DELETE /admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (API 2020-10) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“What is the 2020-10 call for deleting a customer saved search?”
“Does the October 2020 API let me drop a saved customer segment?”
Tell an agent destructive · confirm first
Drop saved customer segment {customer_saved_search_id} on the October 2020 version.
Delete the 2020-10 customer saved search {customer_saved_search_id}.
GET /admin/api/2021-01/customer_saved_searches.json List customer saved searches (API 2021-01) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“Under the 2021-01 API, where do I list customer saved searches?”
“Can I cap how many saved customer segments come back with the January 2021 API?”
Tell an agent
List customer saved searches through API version 2021-01.
Return up to {limit} saved customer segments against January 2021.
POST /admin/api/2021-01/customer_saved_searches.json Create a customer saved search (API 2021-01) · Shopify Creates A Customer Saved Search #
Ask an LLM
“Under the 2021-01 API, where do I create a customer saved search?”
“Can I add a saved customer segment with the January 2021 API version?”
Tell an agent
Create a customer saved search through API version 2021-01.
Add a saved customer segment against January 2021.
GET /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (API 2021-01) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“My integration runs on 2021-01; what returns a single customer saved search by its ID?”
“Can the January 2021 API show me what filter one saved segment uses?”
Tell an agent
Inspect customer saved search {customer_saved_search_id} through API version 2021-01.
Show saved segment {customer_saved_search_id} against January 2021, fields {fields} only.
PUT /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (API 2021-01) · Shopify Updates A Customer Saved Search #
Ask an LLM
“Is there a 2021-01 endpoint to change the query of an existing saved customer search?”
“Can January 2021 apps rewrite a segment they already saved?”
Tell an agent
Amend customer saved search {customer_saved_search_id} through API version 2021-01.
Push an update for saved segment {customer_saved_search_id} against January 2021.
DELETE /admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (API 2021-01) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“Which 2021-01 call permanently removes a customer saved search?”
“Will the January 2021 API let me clean out segments nobody uses anymore?”
Tell an agent destructive · confirm first
Delete customer saved search {customer_saved_search_id} through API version 2021-01.
Erase saved segment {customer_saved_search_id} against January 2021.
GET /admin/api/unstable/customer_saved_searches.json List customer saved searches (unstable API) · Shopify Retrieves A List Of Customer Saved Searches #
Ask an LLM
“Is there an unstable-channel endpoint for listing customer saved searches?”
“Can I test listing saved customer segments against the unstable API version?”
Tell an agent
List customer saved searches on the unstable API.
Against the unstable version, test listing saved segments after {since_id}.
POST /admin/api/unstable/customer_saved_searches.json Create a customer saved search (unstable API) · Shopify Creates A Customer Saved Search #
Ask an LLM
“Is there an unstable-channel endpoint for creating a customer saved search?”
“Can I test creating saved customer segments against the unstable API version?”
Tell an agent
Create a customer saved search on the unstable API.
Against the unstable version, test saving a new customer segment.
GET /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json Retrieve a customer saved search (unstable API) · Shopify Retrieves A Single Customer Saved Search #
Ask an LLM
“Is there an unstable-channel endpoint for reading one customer saved search?”
“Can I test fetching a saved customer segment by ID against the unstable API?”
Tell an agent
Get customer saved search {customer_saved_search_id} on the unstable API.
Against the unstable version, test fetching saved segment {customer_saved_search_id}.
PUT /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json Update a customer saved search (unstable API) · Shopify Updates A Customer Saved Search #
Ask an LLM
“Is there an unstable-channel endpoint for updating a customer saved search?”
“Can I test editing a saved customer segment against the unstable API version?”
Tell an agent
Update customer saved search {customer_saved_search_id} on the unstable API.
Against the unstable version, test editing saved segment {customer_saved_search_id}.
DELETE /admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json Delete a customer saved search (unstable API) · Shopify Deletes A Customer Saved Search #
Ask an LLM
“Is there an unstable-channel endpoint for deleting a customer saved search?”
“Can I try permanently deleting a segment on the unstable release first?”
Tell an agent destructive · confirm first
Delete customer saved search {customer_saved_search_id} on the unstable API.
Against the unstable version, test removing saved segment {customer_saved_search_id}.

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-customers-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-customers-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-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Customers API
  x-refined-note:
  - x-date differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Customers across 2 of this provider''s published API definitions: shopify-admin-rest-api-openapi.yml, shopify-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
tags:


# --- truncated at 32 KB (68 KB total) ---
# Full source: https://artifacts.apis.io/shopify/openapi/shopify-customers-api-openapi.yml