Get a list of supplier addresses

GET
/suppliers/{supplierID}/addresses

Roles

At least one of the roles below is required to access this endpoint

FullAccess
SupplierAddressAdmin
SupplierAddressReader

Parameters

NameTypeDescriptionDefault (ordered by priority)
supplierIDstringID of the supplier.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, AddressName, CompanyName, City, Street1, Street2, LastName, FirstName, State, Zip
sortByarrayComma-delimited list of fields to sort by.AddressName, ID, DateCreated, CompanyName, FirstName, LastName, Street1, Street2, City, State, Zip, Country, Phone, !AddressName, !ID, !DateCreated, !CompanyName, !FirstName, !LastName, !Street1, !Street2, !City, !State, !Zip, !Country, !Phone
pageintegerPage of results to return. Default: 1---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAny additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax Length
Itemsarray------
PropertyTypeFormatMax Length
IDstring------
DateCreated
Read Only
stringdate-time---
CompanyNamestring---100 characters
FirstNamestring---100 characters
LastNamestring---100 characters
Street1string---100 characters
Street2string---100 characters
Citystring---100 characters
Statestring---100 characters
Zipstring---100 characters
Countrystring---2 characters
Phonestring---100 characters
AddressNamestring---100 characters
xpobject------
Metaobject------
PropertyTypeFormatMax Length
Pageintegerint32---
PageSizeintegerint32---
TotalCountintegerint32---
TotalPagesintegerint32---
ItemRangearray------