API Reference
Addresses

Create address

1min
POST
This endpoint will provide the ability to create a new address against an account and link default address types.
Authentication
Authorization
Path Parameters
accountReference
*
Header Parameters
X-TokenId
X-SessionId
X-Version
*
Origin
Body Parameters
address
*
Description
Address base details
houseName
houseNumber
street
townCity
district
state
county
postCode
country
isDefault
defaultInvoice
defaultShipping
Responses
204
No Content
Description
Address base details
addressIdentifier
houseName
houseNumber
street
townCity
district
state
county
postCode
country
isDefault
defaultInvoice
defaultShipping
400
Account must have an eWallet attached to create / modify the billing address.
401
Not Authorized
409
Provided address is currently default and cannot remove the default link with this call
500
Internal Server Error
Curl
JS
Ruby
Python
Responses
204
400
401
409
500




Updated 22 Sep 2023
Doc contributor
Did this page help you?