| Name | Description | Type | Additional information |
|---|---|---|---|
| apiKey |
Please contact Caliq support to get your key |
string |
Required |
| ChannelID |
List of channels can be retrieved via API |
integer |
Required |
| CustomerID |
Caliq internal unique customer identifier |
integer |
None. |
| AccountNo |
User entered unique customer account number |
string |
Required Max length: 10 |
| AddressID |
Internal ID of the address to be changed |
integer |
Required |
| Active |
Should the address be set to active or inactive? |
boolean |
Required |
| AddressRef |
Alias for this address |
string |
Max length: 30 |
| CompanyName |
Override company name if different to the account name |
string |
Max length: 40 |
| Line1 | string |
Required Max length: 50 |
|
| Line2 | string |
Max length: 50 |
|
| Line3 | string |
Max length: 50 |
|
| Town | string |
Max length: 50 |
|
| County | string |
Max length: 25 |
|
| Postcode | string |
Max length: 15 |
|
| Country |
Country code from the country list in ISO3 format |
string |
Required Max length: 3 |
| AllowDeliveries |
Can orders be delivered to this address? |
boolean |
None. |
| AllowInvoices |
Can invoices be sent to this address? |
boolean |
None. |