---
title: "🔒 List supplier delivery addresses V3"
method: GET
path: "/api/v3/suppliers/{supplierId}/deliveryAddresses"
tags: ["Supplier Delivery Address"]
---

# 🔒 List supplier delivery addresses V3

`GET /api/v3/suppliers/{supplierId}/deliveryAddresses`

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: `supplier:read`.

Paginated list of delivery addresses for a supplier.

## Path parameters

- `supplierId` string, required

## Query parameters

- `filter` object[]
  - `key` 'deliveryAddress.name' | 'deliveryAddress.title' | 'deliveryAddress.contactPerson' | 'deliveryAddress.department' | 'deliveryAddress.subDepartment' | 'deliveryAddress.addressSupplement' | 'deliveryAddress.street' | 'deliveryAddress.zipCode' | 'deliveryAddress.city' | 'deliveryAddress.state' | 'deliveryAddress.country' | 'deliveryAddress.gln' | 'deliveryAddress.email' | 'deliveryAddress.phone' | 'deliveryAddress.fax' | 'taxType' | 'defaultDeliveryAddress' | 'termsOfDelivery' | 'vatId' | 'remark' | 'note' | 'id'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' — operator
  - `value` union — The property value.
    - string
    - string[]
- `sort` string[]
- `perPage` integer
- `page` integer

## Response `200`

Paginated list of delivery addresses for a supplier.

- object
  - `data` object[]
    - `id` string, required — Unique identifier for the delivery address
    - `type` 'company' | 'mrs' | 'mr' | 'other', required — Type of the delivery address recipient. Use 'company' for business addresses, 'mrs' for female recipients, 'mr' for male recipients, and 'other' for other types.
    - `name` string, required — Full name of the delivery address recipient. For companies, this is the company name. For persons, this is the full name.
    - `title` string — Title of the contact person.
    - `contactPerson` string — Name of the contact person at this delivery address. This is typically used for company addresses to specify who should receive the delivery.
    - `salutation` string — Salutation or greeting phrase for the delivery address. Can be used for personalized communication.
    - `department` string — Department name at the delivery address. Useful for routing deliveries within larger organizations.
    - `subDepartment` string — Sub department name at the delivery address. Useful for routing deliveries within larger organizations.
    - `addressSupplement` string — Additional address information such as building name, floor, hall, or specific delivery instructions for the location
    - `street` string, required — Street name and house number of the delivery address
    - `zipCode` string, required — Postal code (ZIP code) of the delivery address
    - `city` string, required — City name of the delivery address
    - `state` string — State or region code in ISO 3166-2 format (without country prefix). Required for countries with states/provinces.
    - `country` string, required — Country code in ISO 3166-1 alpha-2 format
    - `gln` string — Global Location Number (GLN) - a 13-digit number used to uniquely identify physical locations or legal entities globally. Used in supply chain and logistics for automated identification.
    - `phone` string — Primary phone number for the delivery address. Used for delivery coordination and communication.
    - `mobile` string — Mobile phone number for the delivery address contact. Useful for urgent delivery notifications.
    - `fax` string — Fax number for the delivery address. Still used by some organizations for official communications.
    - `email` string, email — Email address for delivery notifications and communication
    - `deliveryDetails` object, required — Delivery-specific settings and information for the address
      - `taxType` 'domestic' | 'eu' | 'export' | 'exempt' — Tax classification for deliveries to this address. 'domestic' for same-country deliveries, 'eu' for EU cross-border, 'export' for non-EU international, 'exempt' for tax-exempt deliveries.
      - `defaultDeliveryAddress` boolean — Indicates whether this is the default delivery address. Only one delivery address per customer/supplier should be set as default.
      - `termsOfDelivery` string — Incoterms or delivery terms code (e.g., EXW, FOB, CIF, DAP). Defines the responsibilities and costs between buyer and seller during shipping.
      - `vatId` string — VAT identification number for this delivery address. May differ from the main VAT ID for multi-location businesses.
      - `remark` string — Internal notes about this delivery address. Not visible externally. Used for operational information like opening hours, special handling instructions, or access codes.
      - `note` string — Public notes or delivery instructions for this address. May be shared with carriers or printed on delivery documents.
  - `meta` object — Pagination meta data
    - `currentPage` integer — The current page number
    - `from` integer, nullable — The first item being returned in the current page
    - `path` string — The base path for the paginated results
    - `perPage` integer — The number of items shown per page
    - `to` integer, nullable — The last item being returned in the current page
  - `links` object — Pagination links
    - `first` string, nullable — URL to the first page
    - `last` string, nullable — URL to the last page
    - `prev` string, nullable — URL to the previous page
    - `next` string, nullable — URL to the next page

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)