Shopify

Shopify Address API

The Address API from Shopify — 30 operation(s) for address.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 42

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}/addresses.json Add an address to a customer (2020-01 API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“How do I add a new shipping address to a customer on the 2020-01 Admin API?”
“Can a customer hold more than one address when I call the 2020-01 version?”
Tell an agent
Add a new address to customer {customer} via the 2020-01 API.
Using API version 2020-01, save another address on customer {customer}'s address book.
GET /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (2020-01 API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“How do I fetch a single saved address for a customer on the 2020-01 API?”
“What details come back for one customer address in version 2020-01?”
Tell an agent
Show address {address} of customer {customer} using the 2020-01 API.
Fetch the details of address {address} belonging to {customer}, version 2020-01.
PUT /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (2020-01 API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“How do I correct a typo in a customer's saved address on the 2020-01 API?”
“Can I change an existing customer address rather than add a new one in 2020-01?”
Tell an agent
Update address {address} of customer {customer} using version 2020-01.
Edit the existing address {address} on customer {customer} with the 2020-01 API.
DELETE /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (2020-01 API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“How do I delete an outdated address from a customer's address list on 2020-01?”
“Can I remove one address from a customer without deleting the customer, in 2020-01?”
Tell an agent destructive · confirm first
Delete address {address} from customer {customer} using the 2020-01 API.
Remove the old address {address} from {customer}'s address list, version 2020-01.
PUT /admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (2020-01 API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“How do I make one of a customer's saved addresses their default on 2020-01?”
“Can I switch which address is a customer's primary one in the 2020-01 API?”
Tell an agent
Make address {address} the default for customer {customer} using 2020-01.
Set {customer}'s primary address to {address} with the 2020-01 API.
POST /admin/api/2020-04/customers/{customer_id}/addresses.json Add an address to a customer (2020-04 API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“What call on the 2020-04 release adds an extra address to a shopper's account?”
“Is creating a customer address still supported in the 2020-04 version?”
Tell an agent
On the 2020-04 release, create an address for customer {customer}.
Append a fresh address record to shopper {customer} with version 2020-04.
GET /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (2020-04 API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“Can I read one specific address off a customer in the 2020-04 release?”
“Which 2020-04 call returns a single address by its ID for a customer?”
Tell an agent
Retrieve address {address} for customer {customer} on 2020-04.
Pull up one saved address, {address}, of shopper {customer} with the 2020-04 release.
PUT /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (2020-04 API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“Which 2020-04 call modifies an address a customer already has on file?”
“Is it possible to overwrite a stored customer address in the 2020-04 release?”
Tell an agent
Change address {address} for customer {customer} on the 2020-04 release.
Revise shopper {customer}'s saved address {address} via 2020-04.
DELETE /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (2020-04 API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“Which 2020-04 endpoint drops an address from a customer's saved addresses?”
“Is deleting a customer address supported in the 2020-04 release?”
Tell an agent destructive · confirm first
Remove address {address} from customer {customer} on 2020-04.
Drop saved address {address} off shopper {customer}'s account via the 2020-04 release.
PUT /admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (2020-04 API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“Which 2020-04 call marks an address as the customer's default?”
“Is changing a customer's default address supported in the 2020-04 release?”
Tell an agent
Set address {address} as default for customer {customer} on 2020-04.
Promote saved address {address} to shopper {customer}'s default via the 2020-04 release.
POST /admin/api/2020-07/customers/{customer_id}/addresses.json Add an address to a customer (2020-07 API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“Where do I post a new customer address in the 2020-07 Admin REST version?”
“Which 2020-07 endpoint stores an additional address for an existing customer?”
Tell an agent
Create a customer address for {customer} against the 2020-07 version.
Give customer {customer} one more saved address through 2020-07.
GET /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (2020-07 API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“Where do I read a customer's individual address in the 2020-07 version?”
“Does version 2020-07 support getting one address by ID for a customer?”
Tell an agent
Get customer {customer}'s address {address} from the 2020-07 version.
Look up the single address {address} on buyer {customer} via 2020-07.
PUT /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (2020-07 API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“Where do I update an already-saved customer address in version 2020-07?”
“What endpoint in 2020-07 lets me fix a buyer's existing address?”
Tell an agent
Modify address {address} of customer {customer} through the 2020-07 version.
Fix the stored address {address} for buyer {customer} with 2020-07.
DELETE /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (2020-07 API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“Where do I remove a customer's unwanted address in version 2020-07?”
“What happens to a customer's address list when I delete one address in 2020-07?”
Tell an agent destructive · confirm first
Delete customer {customer}'s address {address} through the 2020-07 version.
Erase the address {address} from buyer {customer} with 2020-07.
PUT /admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (2020-07 API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“Where do I choose a buyer's default address in version 2020-07?”
“What endpoint in 2020-07 flips which saved address is primary for a customer?”
Tell an agent
Mark address {address} as customer {customer}'s default through 2020-07.
Switch buyer {customer}'s default address to {address} with the 2020-07 version.
POST /admin/api/2020-10/customers/{customer_id}/addresses.json Add an address to a customer (2020-10 API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“How can I give an existing customer a second address with the 2020-10 API?”
“Does the 2020-10 Admin API let me attach a new address to a customer record?”
Tell an agent
Add an address to customer {customer} with the 2020-10 Admin API.
Register a new mailing address under customer {customer}, version 2020-10.
GET /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (2020-10 API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“How can I view one particular address a customer has saved, using 2020-10?”
“What does the 2020-10 Admin API return for a single customer address?”
Tell an agent
Show me address {address} on customer {customer} with the 2020-10 API.
Read the saved address {address} of customer {customer}, API 2020-10.
PUT /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (2020-10 API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“How can I update an address a customer previously saved, using the 2020-10 API?”
“Does the 2020-10 Admin API support editing an existing customer address?”
Tell an agent
Update customer {customer}'s address {address} on the 2020-10 API.
Correct the details of existing address {address} for {customer}, version 2020-10.
DELETE /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (2020-10 API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“How can I take an address off a customer's address list with the 2020-10 API?”
“Does the 2020-10 Admin API let me delete a single customer address?”
Tell an agent destructive · confirm first
Remove address {address} from customer {customer} with the 2020-10 API.
Delete the stale address {address} on {customer}, API version 2020-10.
PUT /admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (2020-10 API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“How can I change which address a customer uses by default with the 2020-10 API?”
“Does the 2020-10 Admin API let me pick a default among a customer's addresses?”
Tell an agent
Make {address} the default address of customer {customer} on the 2020-10 API.
Set the primary address for {customer} to saved address {address}, API 2020-10.
POST /admin/api/2021-01/customers/{customer_id}/addresses.json Add an address to a customer (2021-01 API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“Can I create a customer address using the 2021-01 REST release?”
“What endpoint in version 2021-01 lets a merchant add an address for a buyer?”
Tell an agent
Through the 2021-01 release, add an address for customer {customer}.
Create one more address in the address list of buyer {customer} on 2021-01.
GET /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (2021-01 API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“Can I retrieve just one of a customer's addresses in the 2021-01 release?”
“Which endpoint in 2021-01 gives me a single customer address by ID?”
Tell an agent
Using 2021-01, fetch address {address} of customer {customer}.
Display one address, {address}, for shopper {customer} on the 2021-01 release.
PUT /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (2021-01 API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“Can I change a customer's existing address with the 2021-01 release?”
“Which 2021-01 endpoint edits one address already on a customer's account?”
Tell an agent
With the 2021-01 release, edit address {address} of customer {customer}.
Overwrite the saved address {address} on shopper {customer} using 2021-01.
DELETE /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (2021-01 API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“Can I delete one of a customer's addresses using the 2021-01 release?”
“Which 2021-01 call removes a saved address from a buyer's account?”
Tell an agent destructive · confirm first
Using 2021-01, delete address {address} of customer {customer}.
Strip address {address} out of shopper {customer}'s address book on the 2021-01 release.
PUT /admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (2021-01 API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“Can I set a customer's default address using the 2021-01 release?”
“Which 2021-01 endpoint designates one saved address as a buyer's default?”
Tell an agent
Using 2021-01, set address {address} as the default for customer {customer}.
Designate {address} as shopper {customer}'s primary address on the 2021-01 release.
POST /admin/api/unstable/customers/{customer_id}/addresses.json Add an address to a customer (unstable API) · Shopify Creates A New Address For A Customer #
Ask an LLM
“Is there an unstable-version endpoint for adding a customer address?”
“How would I test creating a customer address against the unstable Admin API?”
Tell an agent
Add an address to customer {customer} on the unstable API version.
Use the unstable release to create a new address for shopper {customer}.
GET /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json Look up one customer address (unstable API) · Shopify Retrieves Details A Single Customer Address #
Ask an LLM
“Is reading a single customer address available on the unstable API?”
“How would I get one customer address by ID from the unstable version?”
Tell an agent
Retrieve address {address} of customer {customer} from the unstable API.
On the unstable version, look up saved address {address} for buyer {customer}.
PUT /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json Edit a customer address (unstable API) · Shopify Updates An Existing Customer Address #
Ask an LLM
“Is there an unstable-version call to edit an existing customer address?”
“How would I update a saved customer address on the unstable Admin API?”
Tell an agent
Update address {address} for customer {customer} on the unstable version.
Via the unstable API, change the existing address {address} of buyer {customer}.
DELETE /admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json Remove a customer address (unstable API) · Shopify Removes An Address From A Customer’s Address List #
Ask an LLM
“Is removing a customer address possible on the unstable API version?”
“How would I delete a saved customer address against the unstable release?”
Tell an agent destructive · confirm first
Delete address {address} from customer {customer} on the unstable API.
On the unstable version, remove saved address {address} for buyer {customer}.
PUT /admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.json Set a customer's default address (unstable API) · Shopify Sets The Default Address For A Customer #
Ask an LLM
“Is setting a default customer address available on the unstable API?”
“How would I mark a customer's default address against the unstable release?”
Tell an agent
Set address {address} as the default for customer {customer} on the unstable API.
On the unstable version, make saved address {address} buyer {customer}'s primary one.
POST /admin/api/2020-01/webhooks.json Subscribe to a webhook topic (2020-01 API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“How do I register a webhook subscription with an address and topic on 2020-01?”
“Can my webhook payloads arrive as XML instead of JSON in the 2020-01 API?”
Tell an agent
Create a webhook subscription on the 2020-01 API.
Subscribe a new webhook with {format} payloads using version 2020-01.
PUT /admin/api/2020-01/webhooks/{webhook_id}.json Change a webhook's topic or address (2020-01 API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“How do I point an existing webhook at a new callback URL on the 2020-01 API?”
“Can I switch the topic of a webhook I already subscribed, in 2020-01?”
Tell an agent
Update webhook {webhook}'s address using the 2020-01 API.
Change the topic on existing webhook {webhook} with version 2020-01.
POST /admin/api/2020-04/webhooks.json Subscribe to a webhook topic (2020-04 API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“Which 2020-04 call sets up a new webhook for a topic and callback address?”
“What payload formats can a new webhook use in the 2020-04 release?”
Tell an agent
Register a webhook for a topic and delivery address on 2020-04.
Set up a webhook subscription that sends {format} via the 2020-04 release.
PUT /admin/api/2020-04/webhooks/{webhook_id}.json Change a webhook's topic or address (2020-04 API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“Which 2020-04 call edits the destination URI of an existing webhook subscription?”
“Is changing a webhook's topic supported in the 2020-04 release?”
Tell an agent
Repoint webhook {webhook} to a new address on 2020-04.
Edit the topic of subscription {webhook} via the 2020-04 release.
POST /admin/api/2020-07/webhooks.json Subscribe to a webhook topic (2020-07 API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“Where do I create a webhook subscription in version 2020-07?”
“Is XML still an option for webhook payloads on the 2020-07 version?”
Tell an agent
Add a webhook subscription through the 2020-07 version.
Start a webhook subscription delivering {format} payloads with 2020-07.
PUT /admin/api/2020-07/webhooks/{webhook_id}.json Change a webhook's topic or address (2020-07 API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“Where do I modify an existing webhook's address in version 2020-07?”
“What can I change on an already-created webhook with 2020-07?”
Tell an agent
Modify webhook {webhook}'s delivery address through 2020-07.
Move existing webhook {webhook} to another topic with the 2020-07 version.
POST /admin/api/2020-10/webhooks.json Subscribe to a webhook topic (2020-10 API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“How can my app get notified of store events by subscribing a webhook on 2020-10?”
“Does the 2020-10 Admin API default new webhooks to JSON payloads?”
Tell an agent
Subscribe to a webhook topic with the 2020-10 Admin API.
Create a webhook that delivers {format} to my endpoint, API 2020-10.
PUT /admin/api/2020-10/webhooks/{webhook_id}.json Change a webhook's topic or address (2020-10 API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“How can I update the URI an existing webhook posts to, using the 2020-10 API?”
“Does the 2020-10 Admin API let me change a subscribed webhook's topic?”
Tell an agent
Update the address of webhook {webhook} on the 2020-10 API.
Switch existing webhook {webhook} to a different topic, API 2020-10.
POST /admin/api/2021-01/webhooks.json Subscribe to a webhook topic (2021-01 API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“Can I create a new webhook subscription using the 2021-01 release?”
“Which format values does the 2021-01 webhook create call accept?”
Tell an agent
Using 2021-01, create a webhook subscription for a topic.
Register a new webhook in {format} format on the 2021-01 release.
PUT /admin/api/2021-01/webhooks/{webhook_id}.json Change a webhook's topic or address (2021-01 API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“Can I edit an existing webhook's callback address using the 2021-01 release?”
“Which 2021-01 endpoint changes the topic of a webhook I already have?”
Tell an agent
Using 2021-01, change the callback address of webhook {webhook}.
Retarget subscription {webhook} to a new topic on the 2021-01 release.
POST /admin/api/unstable/webhooks.json Subscribe to a webhook topic (unstable API) · Shopify Create A New Webhook Subscription By Specifying Both An Address And A… #
Ask an LLM
“Is creating a webhook subscription available on the unstable API?”
“How would I test a new webhook subscription against the unstable release?”
Tell an agent
Create a webhook subscription on the unstable API version.
On the unstable version, subscribe a webhook with {format} payloads.
PUT /admin/api/unstable/webhooks/{webhook_id}.json Change a webhook's topic or address (unstable API) · Shopify Update A Webhook Subscription's Topic Or Address Uris #
Ask an LLM
“Is updating an existing webhook subscription possible on the unstable API?”
“How would I change an existing webhook's URI against the unstable release?”
Tell an agent
Update webhook {webhook}'s address on the unstable API version.
On the unstable version, change the topic of existing webhook {webhook}.

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-address-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-address-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-address-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shopify Address 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 (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-address-api-openapi.yml