> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.fidly.be/llms.txt
> Use this file to discover all available pages before exploring further.

# List Delivery Locations

> The delivery addresses saved on the company's third parties.

Filter by `relation_id` to get those of one third party — which is how they are meant to be
read, an address only ever belonging to one.



## OpenAPI

````yaml /openapi.json get /delivery-locations
openapi: 3.1.0
info:
  title: Fidly API
  version: 1.0.0
servers:
  - url: https://api.fidly.be
    description: Production
security: []
paths:
  /delivery-locations:
    get:
      tags:
        - delivery locations
      summary: List Delivery Locations
      description: >-
        The delivery addresses saved on the company's third parties.


        Filter by `relation_id` to get those of one third party — which is how
        they are meant to be

        read, an address only ever belonging to one.
      operationId: list_delivery_locations_delivery_locations_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Max items returned (1-100).
            default: 50
            title: Limit
          description: Max items returned (1-100).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 0
            description: Number of items to skip (pagination). Capped at 10000.
            default: 0
            title: Offset
          description: Number of items to skip (pagination). Capped at 10000.
        - name: relation_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only the addresses saved on this third party.
            title: Relation Id
          description: Only the addresses saved on this third party.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_DeliveryLocationOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Page_DeliveryLocationOut_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/DeliveryLocationOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: Page[DeliveryLocationOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeliveryLocationOut:
      properties:
        id:
          type: string
          title: Id
          description: Opaque unique identifier of the delivery location.
        relation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Relation Id
          description: >-
            Opaque identifier of the third party this address belongs to
            (resolvable via `GET /relations/{id}`).
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Label of the location, e.g. `Warehouse Liège`.
        address:
          anyOf:
            - $ref: '#/components/schemas/AddressOut'
            - type: 'null'
          description: The address itself.
        identifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Identifier
          description: Identifier of the location itself, typically a GLN.
        identifier_scheme:
          anyOf:
            - type: string
            - type: 'null'
          title: Identifier Scheme
          description: >-
            Scheme `identifier` belongs to — 4-digit Peppol scheme code, e.g.
            `0088` for a GLN.
      type: object
      required:
        - id
      title: DeliveryLocationOut
      description: A delivery address saved on a third party.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AddressOut:
      properties:
        street:
          anyOf:
            - type: string
            - type: 'null'
          title: Street
          description: Street name.
        street_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Street Number
          description: Street/house number.
        street2:
          anyOf:
            - type: string
            - type: 'null'
          title: Street2
          description: Additional address line.
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Postal Code
          description: Postal/ZIP code.
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: City.
        province:
          anyOf:
            - type: string
            - type: 'null'
          title: Province
          description: Province, state or region.
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
          description: ISO 3166-1 alpha-2 country code (e.g. `BE`).
      type: object
      title: AddressOut
      description: >-
        Postal address of a relation. The object itself is `null` when none is
        stored.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````