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

# List locations

> **Permission:** `fulfillment:read`



## OpenAPI

````yaml /api-reference/openapi/user-api.yaml get /shipping/locations
openapi: 3.0.3
info:
  title: PapelShip Store API
  version: 1.0.0
  description: >-
    Manage your PapelShip store from your own systems: create orders, sync
    products and stock, ship physical orders, answer support tickets and react
    to events.


    Every request needs your API key in `x-api-key` and your store ID in
    `x-store-hash`. Amounts are integers in minor units (`2999` = 29.99). Dates
    are ISO 8601 in UTC.
  contact:
    name: PapelShip Support
    email: support@papelship.com
    url: https://papelship.com
servers:
  - url: https://app.papelship.com/api/v1
    description: Production
security:
  - ApiKey: []
    StoreHash: []
tags:
  - name: Account
    description: Your key, store and payment methods.
  - name: Orders
    description: Create orders, take manual payments, cancel, refund and read deliveries.
  - name: Products
    description: Products and their settings.
  - name: Variants & stock
    description: Variants, physical stock and license keys.
  - name: Product content
    description: Media, SEO, payment methods, files and stock alerts.
  - name: Categories
    description: Organise products.
  - name: Groups
    description: Collections of products.
  - name: Coupons
    description: Discount codes.
  - name: Customers
    description: Buyers and their history.
  - name: Blocklist
    description: Emails and IPs that can't place orders.
  - name: Reviews
    description: Customer reviews.
  - name: Support
    description: Support tickets.
  - name: Subscriptions
    description: Recurring products and auto-renewals.
  - name: Fulfillment
    description: Ship physical orders.
  - name: Returns
    description: Return requests.
  - name: Shipping settings
    description: Zones, rates and locations.
  - name: Webhooks
    description: Endpoints, deliveries and event types.
  - name: Affiliates
    description: Partner programme.
  - name: Analytics
    description: Sales summary.
paths:
  /shipping/locations:
    get:
      tags:
        - Shipping settings
      summary: List locations
      description: '**Permission:** `fulfillment:read`'
      operationId: listLocations
      responses:
        '200':
          description: A page of results
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShippingLocation'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                  - success
components:
  schemas:
    ShippingLocation:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          example: Main warehouse
        is_default_origin:
          type: boolean
        is_return:
          type: boolean
        contact_name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        active:
          type: boolean
        address:
          type: object
          properties:
            country_code:
              type: string
            region:
              type: string
              nullable: true
            city:
              type: string
              nullable: true
            district:
              type: string
              nullable: true
            line1:
              type: string
            line2:
              type: string
              nullable: true
            postal_code:
              type: string
              nullable: true
    Pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching records.
          example: 128
        limit:
          type: integer
          example: 25
        offset:
          type: integer
          example: 0
        has_more:
          type: boolean
          description: '`true` when another page exists.'
          example: true
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Store API key (`pk_live_...`). Create it in **Developers › API
        keys**.
    StoreHash:
      type: apiKey
      in: header
      name: x-store-hash
      description: >-
        The ID of the store the request is for. Shown in **Developers › API
        keys**.

````

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