Get
/v26.4/Addresses
Security
HTTP
Type Bearer
Please enter a valid token
Query parameters
CustomerId
integer (int32)
ExternalCode
string
AddressType
string
Valid values[
"NotSpecified",
"DefaultAddress",
"AlternatePostalAddress",
"AlternateInvoiceAddress",
"AlternateDeliveryAddress"
]
CancelledOnly
string
Valid values[
"All",
"Yes",
"No"
]
DefaultDeliveryAddressOnly
string
Valid values[
"All",
"Yes",
"No"
]
Street
string
AddressDescription
string
ZipCode
string
NumberPart1
integer (int32)
NumberPart2
string
City
string
CountryId
integer (int32)
AttentionOf
string
NumbertPart1Specified
string
Valid values[
"All",
"Yes",
"No"
]
NumbertPart2Specified
string
Valid values[
"All",
"Yes",
"No"
]
AddressDescriptionFieldSpecified
string
Valid values[
"All",
"Yes",
"No"
]
AttentionOfFieldSpecified
string
Valid values[
"All",
"Yes",
"No"
]
Offset
integer (int32)
RecordCount
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
OrderBy
string
ModifiedSinceDateTime
string (date-time)
Responses
200
Success
Array of object
object
itemId
integer (int32) | null
createdByUserId
integer (int32) | null
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32) | null
lastModifiedDateTime
string (date-time)
organizationId
integer (int32) | null
companyId
integer (int32) | null
customerId
integer (int32) | null
externalCode
string | null
cancelled
boolean
Defaultfalse
addressType
string
Valid values[
"NotSpecified",
"DefaultAddress",
"AlternatePostalAddress",
"AlternateInvoiceAddress",
"AlternateDeliveryAddress"
]
defaultDeliveryAddress
boolean
Defaultfalse
street
string | null
numberPart1
integer (int32) | null
numberPart2
string | null
address
string | null
addressDescription
string | null
zipCode
string | null
city
string | null
county
string | null
countryId
integer (int32) | null
attentionOf
string | null
countryDescription
string | null
countryIsoCode
string | null
countryIsoDescription
string | null
eu
boolean
Defaultfalse
Array of object
object
itemId
integer (int32) | null
createdByUserId
integer (int32) | null
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32) | null
lastModifiedDateTime
string (date-time)
organizationId
integer (int32) | null
companyId
integer (int32) | null
customerId
integer (int32) | null
externalCode
string | null
cancelled
boolean
Defaultfalse
addressType
string
Valid values[
"NotSpecified",
"DefaultAddress",
"AlternatePostalAddress",
"AlternateInvoiceAddress",
"AlternateDeliveryAddress"
]
defaultDeliveryAddress
boolean
Defaultfalse
street
string | null
numberPart1
integer (int32) | null
numberPart2
string | null
address
string | null
addressDescription
string | null
zipCode
string | null
city
string | null
county
string | null
countryId
integer (int32) | null
attentionOf
string | null
countryDescription
string | null
countryIsoCode
string | null
countryIsoDescription
string | null
eu
boolean
Defaultfalse
Array of object
object
itemId
integer (int32) | null
createdByUserId
integer (int32) | null
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32) | null
lastModifiedDateTime
string (date-time)
organizationId
integer (int32) | null
companyId
integer (int32) | null
customerId
integer (int32) | null
externalCode
string | null
cancelled
boolean
Defaultfalse
addressType
string
Valid values[
"NotSpecified",
"DefaultAddress",
"AlternatePostalAddress",
"AlternateInvoiceAddress",
"AlternateDeliveryAddress"
]
defaultDeliveryAddress
boolean
Defaultfalse
street
string | null
numberPart1
integer (int32) | null
numberPart2
string | null
address
string | null
addressDescription
string | null
zipCode
string | null
city
string | null
county
string | null
countryId
integer (int32) | null
attentionOf
string | null
countryDescription
string | null
countryIsoCode
string | null
countryIsoDescription
string | null
eu
boolean
Defaultfalse
401
Unauthorized
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null
403
Forbidden
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null
404
Not Found
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null
object
type
string | null
message
string | null
stackTrace
string | null