v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

MerchantAddress

MerchantAddress:List

Retrieve a simple list of all Addresses. You can supply a merchant code to retrieve the addresses for that merchant. If no merchant code is provided, the addresses associated with your own merchant registration will be returned.

get/v2/merchantaddresses/list

Query parameters

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

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

eqstring

Get results that equal the given value

Provides filtering based on address type.

{
  "eq": "VISIT"
}

Response

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",
      "type": "VISIT"
    }
  ],
  "total": 10
}