Retrieve address

2min

GET
This endpoint will provide the ability to retrieve a specific address from the eSuite platform
AUTHENTICATION
Authorization
Bearer
Bearer
PATH PARAMETERS
accountReference
string
*
The account reference identifier.
addressReference
string
*
The address reference.
HEADER PARAMETERS
X-TokenId
string
The eSuite Token Id
X-SessionId
string
The eSuite Session Id
X-Version
string
*
The eSuite Version
Origin
string
The eSuite Origin
RESPONSES
200
OK
FictiveGlobal.Api.Rest.Dtos.v3.AddressResource
Address base details
addressIdentifier
string
The address identifier
houseName
string
House name
houseNumber
string
House number
street
string
Street name
townCity
string
Name of town city
district
string
Name of district
state
string
State
county
string
County
postCode
string
Post code
country
string
Country
isDefault
boolean
Is default
defaultInvoice
boolean
Is default invoice address
defaultShipping
boolean
Is default shipping address
401
Not Authorized
404
•Account cannot be found
            <br />•The ServiceGroup specified does not exist.
500
Internal Server Error
﻿
﻿

Updated 22 Sep 2023

Did this page help you?