How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shopify Customers API

Manage customer records

Shopify Customers API is one of 213 APIs that Shopify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, a JSON-LD context, API documentation, an API reference, and 8 JSON Schemas.

This API exposes 103 operations across 71 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2025-01.

Requests are made against a single base URL, https://{store}.myshopify.com/admin/api/2025-01.

103 operations 71 paths 11 schemas 6 DELETE59 GET13 POST25 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-01
Server
https://{store}.myshopify.com/admin/api/2025-01
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Shopify Customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Shopify-Access-Token (AccessToken). By default, every request must be authenticated.

  • AccessToken — Access token obtained via OAuth

Paths & Operations 103

Across 71 paths, the API surfaces 103 operations — 6 DELETE, 59 GET, 13 POST, 25 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 103

Manage customer records

GET
/customers.json
Shopify Retrieve a list of customers
listCustomers 8 params → 200
POST
/customers.json
Shopify Create a customer
createCustomer body → 201422
GET
/customers/count.json
Shopify Retrieve a count of customers
getCustomerCount → 200
GET
/customers/search.json
Shopify Search for customers
searchCustomers 3 params → 200
GET
/customers/{customer_id}.json
Shopify Retrieve a single customer
getCustomer 2 params → 200404
PUT
/customers/{customer_id}.json
Shopify Update a customer
updateCustomer 1 param body → 200422
GET
/customers/{customer_id}/orders.json
Shopify Retrieve orders for a customer
listCustomerOrders 2 params → 200
GET
/admin/api/2020-01/customers.json
Shopify Retrieves A List Of Customers
deprecated_202001_get_customers 8 params → 200
GET
/admin/api/2020-01/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
deprecated_202001_get_customers_search 4 params → 200
GET
/admin/api/2020-01/customers/count.json
Shopify Retrieves A Count Of All Customers
deprecated_202001_get_customers_count → 200
GET
/admin/api/2020-04/customers.json
Shopify Retrieves A List Of Customers
deprecated_202004_get_customers 8 params → 200
GET
/admin/api/2020-04/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
deprecated_202004_get_customers_search 4 params → 200
GET
/admin/api/2020-04/customers/count.json
Shopify Retrieves A Count Of All Customers
deprecated_202004_get_customers_count → 200
GET
/admin/api/2020-07/customers.json
Shopify Retrieves A List Of Customers
deprecated_202007_get_customers 8 params → 200
GET
/admin/api/2020-07/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
deprecated_202007_get_customers_search 4 params → 200
GET
/admin/api/2020-07/customers/count.json
Shopify Retrieves A Count Of All Customers
deprecated_202007_get_customers_count → 200
GET
/admin/api/2020-10/customers.json
Shopify Retrieves A List Of Customers
get_customers 8 params → 200
GET
/admin/api/2020-10/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
get_customers_search 4 params → 200
GET
/admin/api/2020-10/customers/count.json
Shopify Retrieves A Count Of All Customers
get_customers_count → 200
GET
/admin/api/2021-01/customers.json
Shopify Retrieves A List Of Customers
deprecated_202101_get_customers 8 params → 200
GET
/admin/api/2021-01/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
deprecated_202101_get_customers_search 4 params → 200
GET
/admin/api/2021-01/customers/count.json
Shopify Retrieves A Count Of All Customers
deprecated_202101_get_customers_count → 200
GET
/admin/api/unstable/customers.json
Shopify Retrieves A List Of Customers
deprecated_unstable_get_customers 8 params → 200
GET
/admin/api/unstable/customers/search.json
Shopify Searches For Customers That Match A Supplied Query
deprecated_unstable_get_customers_search 4 params → 200
GET
/admin/api/unstable/customers/count.json
Shopify Retrieves A Count Of All Customers
deprecated_unstable_get_customers_count → 200
GET
/admin/api/2020-01/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
deprecated_202001_get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/2020-01/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
deprecated_202001_create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
deprecated_202001_get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
deprecated_202001_update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/2020-01/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
deprecated_202001_update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
deprecated_202001_update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/2020-04/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
deprecated_202004_get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/2020-04/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
deprecated_202004_create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
deprecated_202004_get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
deprecated_202004_update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/2020-04/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
deprecated_202004_update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
deprecated_202004_update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/2020-07/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
deprecated_202007_get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/2020-07/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
deprecated_202007_create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
deprecated_202007_get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
deprecated_202007_update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/2020-07/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
deprecated_202007_update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
deprecated_202007_update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/2020-10/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/2020-10/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/2020-10/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/2021-01/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
deprecated_202101_get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/2021-01/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
deprecated_202101_create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
deprecated_202101_get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
deprecated_202101_update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/2021-01/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
deprecated_202101_update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
deprecated_202101_update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/unstable/customers/{customer_id}/addresses.json
Shopify Retrieves A List Of Addresses For A Customer
deprecated_unstable_get_customers_param_customer_id_addresses 1 param → 200
POST
/admin/api/unstable/customers/{customer_id}/addresses.json
Shopify Creates A New Address For A Customer
deprecated_unstable_create_customers_param_customer_id_addresses 1 param body → 200
GET
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json
Shopify Retrieves Details A Single Customer Address
deprecated_unstable_get_customers_param_customer_id_addresses_param_address_id 2 params → 200
PUT
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json
Shopify Updates An Existing Customer Address
deprecated_unstable_update_customers_param_customer_id_addresses_param_address_id 2 params body → 200
PUT
/admin/api/unstable/customers/{customer_id}/addresses/set.json
Shopify Performs Bulk Operations For Multiple Customer Addresses
deprecated_unstable_update_customers_param_customer_id_addresses_set 3 params → 200
PUT
/admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.json
Shopify Sets The Default Address For A Customer
deprecated_unstable_update_customers_param_customer_id_addresses_param_address_id_default 2 params → 200
GET
/admin/api/2020-01/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
deprecated_202001_get_customer_saved_searches 3 params → 200
POST
/admin/api/2020-01/customer_saved_searches.json
Shopify Creates A Customer Saved Search
deprecated_202001_create_customer_saved_searches body → 200
GET
/admin/api/2020-01/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
deprecated_202001_get_customer_saved_searches_count 1 param → 200
GET
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
deprecated_202001_get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
deprecated_202001_update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
deprecated_202001_delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
deprecated_202001_get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200
GET
/admin/api/2020-04/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
deprecated_202004_get_customer_saved_searches 3 params → 200
POST
/admin/api/2020-04/customer_saved_searches.json
Shopify Creates A Customer Saved Search
deprecated_202004_create_customer_saved_searches body → 200
GET
/admin/api/2020-04/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
deprecated_202004_get_customer_saved_searches_count 1 param → 200
GET
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
deprecated_202004_get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
deprecated_202004_update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
deprecated_202004_delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
deprecated_202004_get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200
GET
/admin/api/2020-07/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
deprecated_202007_get_customer_saved_searches 3 params → 200
POST
/admin/api/2020-07/customer_saved_searches.json
Shopify Creates A Customer Saved Search
deprecated_202007_create_customer_saved_searches body → 200
GET
/admin/api/2020-07/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
deprecated_202007_get_customer_saved_searches_count 1 param → 200
GET
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
deprecated_202007_get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
deprecated_202007_update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
deprecated_202007_delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
deprecated_202007_get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200
GET
/admin/api/2020-10/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
get_customer_saved_searches 3 params → 200
POST
/admin/api/2020-10/customer_saved_searches.json
Shopify Creates A Customer Saved Search
create_customer_saved_searches body → 200
GET
/admin/api/2020-10/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
get_customer_saved_searches_count 1 param → 200
GET
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200
GET
/admin/api/2021-01/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
deprecated_202101_get_customer_saved_searches 3 params → 200
POST
/admin/api/2021-01/customer_saved_searches.json
Shopify Creates A Customer Saved Search
deprecated_202101_create_customer_saved_searches body → 200
GET
/admin/api/2021-01/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
deprecated_202101_get_customer_saved_searches_count 1 param → 200
GET
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
deprecated_202101_get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
deprecated_202101_update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
deprecated_202101_delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
deprecated_202101_get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200
GET
/admin/api/unstable/customer_saved_searches.json
Shopify Retrieves A List Of Customer Saved Searches
deprecated_unstable_get_customer_saved_searches 3 params → 200
POST
/admin/api/unstable/customer_saved_searches.json
Shopify Creates A Customer Saved Search
deprecated_unstable_create_customer_saved_searches body → 200
GET
/admin/api/unstable/customer_saved_searches/count.json
Shopify Retrieves A Count Of All Customer Saved Searches
deprecated_unstable_get_customer_saved_searches_count 1 param → 200
GET
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json
Shopify Retrieves A Single Customer Saved Search
deprecated_unstable_get_customer_saved_searches_param_customer_saved_search_id 2 params → 200
PUT
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json
Shopify Updates A Customer Saved Search
deprecated_unstable_update_customer_saved_searches_param_customer_saved_search_id 1 param body → 200
DELETE
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}.json
Shopify Deletes A Customer Saved Search
deprecated_unstable_delete_customer_saved_searches_param_customer_saved_search_id 1 param → 200
GET
/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.json
Shopify Retrieves All Customers Returned By A Customer Saved Search
deprecated_unstable_get_customer_saved_searches_param_customer_saved_search_id_customers 4 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Order (34 properties), LineItem (20 properties), Customer (19 properties), Address (16 properties). Each schema is shown below with its type and property counts.

Error
object
Error response
1 property
TaxLine
object
A tax line applied to an item
3 properties
ShippingLine
object
A shipping method applied to an order
7 properties
Order
object
A Shopify order
34 properties
Refund
object
A refund on an order
7 properties
LineItem
object
An individual line item in an order
20 properties
Fulfillment
object
A fulfillment of an order
12 properties
CustomerInput
object
Input for creating or updating a customer
10 properties
Customer
object
A Shopify customer
19 properties
Money
object
A monetary amount with currency
2 properties
Address
object
A customer mailing address
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shopify-customers-api-openapi.yml Raw ↑

Other APIs Shopify publishes across the network.

Shopify GraphQL Admin API
Shopify Storefront API
Shopify Customer Account API
Shopify Partner API
Shopify Payments Apps API
Shopify Liquid API
Shopify Functions API
Shopify Discount Function API
Shopify Webhooks API
Shopify App Bridge
Shopify App Home API
Shopify Checkout UI Extensions API
Where this information came from

This is an independent, third-party profile of Shopify Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.