Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Supplier Delivery Address

🔒 List supplier delivery addresses V3

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.

get/api/v3/suppliers/{supplierId}/deliveryAddresses

Path parameters

supplierIdstring required

Query parameters

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

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

deliveryAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

deliveryAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

taxType: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

defaultDeliveryAddress: equals, notEquals

termsOfDelivery: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

vatId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

remark: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

note: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

id: equals, notEquals, in, notIn

sortstring[]

Sort via id, -id, name, -name, city, -city, country, -country, zipCode and -zipCode. Default sort is -created_at

perPageinteger
Example:15

Number of items per page. Default: 15, Max: 100

pageinteger
Example:1

Page number.

Response

Paginated list of delivery addresses for a supplier.

Example response

{
  "data": [
    {
      "id": "1",
      "type": "company",
      "name": "Acme Logistics Hub Berlin",
      "title": "Dr.",
      "contactPerson": "Marco Schmidt",
      "salutation": "Hallo Logistics Team",
      "department": "Logistics",
      "subDepartment": "Distribution Center",
      "addressSupplement": "Hall B",
      "street": "Lagerweg 22",
      "zipCode": "10437",
      "city": "Berlin",
      "state": "BE",
      "country": "DE",
      "gln": "4012345000300",
      "phone": "+491231234567",
      "mobile": "+49170123456",
      "fax": "+491231234567-1",
      "email": "name@provider.com",
      "deliveryDetails": {
        "taxType": "domestic",
        "defaultDeliveryAddress": true,
        "termsOfDelivery": "EXW",
        "vatId": "DE123456789",
        "remark": "Main Berlin hub open 06:00 to 22:00",
        "note": "Deliveries after 10am only"
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.example.com/items",
    "perPage": 15,
    "to": 15
  },
  "links": {
    "first": "https://api.example.com/items?page=1",
    "next": "https://api.example.com/items?page=17"
  }
}