Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
MerchantAddress

MerchantAddress:Get

Get the details of a specific address. Note you need to have access to the merchant if the address is not available under your own merchant registration

get/v2/merchantaddresses/{addressCode}

Path parameters

addressCodestring required

Provide the CA-code of the address that you want to retrieve

Response

OK

codestring

The address code identifier.

streetNamestring

The name of the street.

streetNumberstring

The street number.

zipCodestring

A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.

citystring

The name of a city.

countryCodestring nullable

The country code consisting of 2 uppercase letters.

regionstring nullable

Region code (iso-3166-2).

type'VISIT' | 'POSTAL' | 'COMPANY'

The address type

createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "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"
}