> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List pickup locations

> Pickup-enabled stock locations for a pickup delivery method. Pass cart_id to keep only locations that can fulfill the whole cart from local stock.



## OpenAPI

````yaml /api-reference/store.yaml get /api/v3/store/delivery_methods/{id}/pickup_locations
openapi: 3.0.3
info:
  title: Store API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Store API v3 - Customer-facing storefront API for building headless
    commerce experiences.


    ## Authentication


    The Store API uses two authentication methods:


    ### API Key (Required)

    All requests must include a publishable API key in the `x-spree-api-key`
    header.


    ### JWT Bearer Token (For authenticated customers)

    After login, include the JWT token in the `Authorization: Bearer <token>`
    header.


    ### Order Token (For guest checkout)

    When creating an order, a `token` is returned. Include this in the
    `x-spree-token` header

    for guest access to that specific order.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "record_not_found",
        "message": "Product not found"
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Customer authentication (login, logout, token refresh)
  - name: Product Catalog
    description: Products and categories
  - name: Carts
    description: Shopping cart management
  - name: Orders
    description: Order lookup
  - name: Customers
    description: Customer account, addresses, saved payment methods, and order history
  - name: Markets
    description: Markets, countries, currencies, and locales
  - name: Wishlists
    description: Customer wishlists
  - name: Newsletter Subscribers
    description: Guest and customer newsletter subscriptions (double opt-in)
  - name: Policies
    description: Store policies (return policy, privacy policy, terms of service)
  - name: Digitals
    description: Digital product downloads
paths:
  /api/v3/store/delivery_methods/{id}/pickup_locations:
    get:
      tags:
        - Delivery
      summary: List pickup locations
      description: >-
        Pickup-enabled stock locations for a pickup delivery method. Pass
        cart_id to keep only locations that can fulfill the whole cart from
        local stock.
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Delivery method prefixed ID
          schema:
            type: string
        - name: cart_id
          in: query
          required: false
          description: Cart prefixed ID for availability filtering
          schema:
            type: string
      responses:
        '200':
          description: pickup locations found
          content:
            application/json:
              example:
                data:
                  - id: sloc_UkLWZg9DAJ
                    name: Downtown
                    address1: 1600 Pennsylvania Ave NW
                    city: Washington
                    zipcode: '20500'
                    country_code: US
                    country_name: United States
                    state_code: AL
                    state_text: AL
                    pickup_ready_in_minutes: null
                    pickup_instructions: null
      security:
        - api_key: []
      x-codeSamples:
        - lang: javascript
          label: Spree SDK
          source: >-
            import { createClient } from '@spree/sdk'


            const client = createClient({
              baseUrl: 'https://your-store.com',
              publishableKey: '<api-key>',
            })


            const { data: pickupLocations } = await
            client.deliveryMethods.pickupLocations('dm_abc123', {
              cart_id: 'cart_abc123',
            })
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Publishable API key for store access

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.