Shopify

Shopify Addresses API

The Addresses API from Shopify — 12 operation(s) for addresses.

GitHub OpenAPI

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-addresses-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

OpenAPI Specification

shopify-addresses-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Addresses API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
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
security:
- AccessToken: []
tags:
- name: Addresses
paths:
  /admin/api/2020-01/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-04
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-04
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-07
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-07
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2020-10
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2020-10
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-2021-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-2021-01
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/customers/{customer_id}/addresses.json:
    get:
      summary: Shopify Retrieves A List Of Addresses For A Customer
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#index-unstable
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_customers_param_customer_id_addresses
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/customers/{customer_id}/addresses/set.json:
    put:
      summary: Shopify Performs Bulk Operations For Multiple Customer Addresses
      description: https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#set-unstable
      parameters:
      - in: path
        name: customer_id
        required: true
        schema:
          type: string
        description: customer_id
      - in: query
        name: address_ids[]
        schema:
          type: integer
        description: address_ids[]
        required: false
      - in: query
        name: operation
        schema:
          type: string
        description: operation
        required: false
      tags:
      - Addresses
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_customers_param_customer_id_addresses_set
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth