v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

MerchantAddress

MerchantAddresses:Browse

Get all addresses. If you do not supply a merchantCode we return the addresses that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant

get/v2/merchantaddresses

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

Response

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "merchantAddresses": [
    {
      "code": "CA-1234-4312",
      "streetName": "Delivery-Lane",
      "streetNumber": "70",
      "zipCode": "1234CD",
      "city": "Amsterdam",
      "countryCode": "NL",
      "region": "ZH",
      "type": "VISIT",
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "status": "ACTIVE"
      },
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}