Get customer addresses by card number
GET {{AppUrl}}/api/v1/carrier/customer/by-card/{{Card number}}
Introduction
Get customer address information for the specified card number.
Structure
| Item | Type | Plurality | Options | Required | Description | |
|---|---|---|---|---|---|---|
| id | integer | 1 | yes | Customer identifier. | ||
| adresses | array | N | yes | The customer's addresses. Includes at least home, post and billing addresses. | ||
| type | varchar(255) | 1 | home post billing custom | yes | Type of address (home, post, billing or custom). | |
| differsfromhome | boolean | 1 | 0 1 | yes | Indicates whether this address differs from the home address. | |
| label | varchar(255) | 1 | yes* | Label to identify the type of custom address. *Only required on addresses of type 'custom'. | ||
| street | varchar(255) | 1 | yes* | Street name. *Required on the home address and any addresses that have 'differsfromhome' set to 1. | ||
| number | varchar(255) | 1 | yes* | House number. *Required on the home address and any addresses that have 'differsfromhome' set to 1. | ||
| addition | varchar(255) | 1 | no | House number addition. | ||
| postcode | varchar(255) | 1 | yes* | Postal code. *Required on the home address and any addresses that have 'differsfromhome' set to 1. | ||
| city | varchar(255) | 1 | yes* | City. *Required on the home address and any addresses that have 'differsfromhome' set to 1. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"id":54,"blocked":false,"addresses":[{"type":"home","different_from_home":1,"label":null,"street":"van Salmring","number":"2382","addition":"a","postcode":"6871ZM","city":"Plasmolen"},{"type":"post","different_from_home":1,"label":null,"street":"Abdiweg","number":"3131","addition":"b","postcode":"7261CN","city":"Bolsward"},{"type":"billing","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"custom","different_from_home":0,"label":"Aliquid dolorem","street":"Duboisboulevard","number":"2560","addition":"b","postcode":"2922AG","city":"Heusden"}]}}