Shopify Locations API

Retrieve store locations

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-locations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Locations 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: Locations
  description: Retrieve store locations
paths:
  /locations.json:
    get:
      operationId: listLocations
      summary: Shopify Retrieve a list of locations
      description: Retrieves a list of all locations for a shop.
      tags:
      - Locations
      responses:
        '200':
          description: A list of locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
  /locations/count.json:
    get:
      operationId: getLocationCount
      summary: Shopify Retrieve a count of locations
      description: Retrieves a count of locations for a shop.
      tags:
      - Locations
      responses:
        '200':
          description: The location count
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
  /locations/{location_id}.json:
    get:
      operationId: getLocation
      summary: Shopify Retrieve a single location
      description: Retrieves a single location by ID.
      tags:
      - Locations
      parameters:
      - name: location_id
        in: path
        required: true
        description: The ID of the location
        schema:
          type: integer
      responses:
        '200':
          description: The requested location
          content:
            application/json:
              schema:
                type: object
                properties:
                  location:
                    $ref: '#/components/schemas/Location'
components:
  schemas:
    Location:
      type: object
      description: A physical location for inventory and fulfillment
      properties:
        id:
          type: integer
        name:
          type: string
        address1:
          type:
          - string
          - 'null'
        address2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        province:
          type:
          - string
          - 'null'
        province_code:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        country_code:
          type: string
        zip:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        active:
          type: boolean
        legacy:
          type: boolean
        localized_country_name:
          type: string
        localized_province_name:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        admin_graphql_api_id:
          type: string
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth