GET api/Address/{id}?type={type}
Gets a list of address.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Customer Global Id. |
string |
Required |
| type |
List Type. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Address| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdateType | string |
None. |
|
| AddressId | integer |
None. |
|
| Label | string |
None. |
|
| Attn | string |
None. |
|
| Attn2 | string |
None. |
|
| Street | string |
None. |
|
| Street2 | string |
None. |
|
| City | string |
None. |
|
| StateCode | string |
None. |
|
| PostalCode | string |
None. |
|
| CountryCode | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedDate | date |
None. |
|
| GlobalId | string |
None. |
|
| Note | string |
None. |
|
| CustomerId | integer |
None. |
|
| CustomerGlobalId | string |
None. |
|
| SupplierId | integer |
None. |
|
| SupplierGlobalId | string |
None. |
|
| AddressTypeId | integer |
None. |
|
| AddressType | string |
None. |
|
| OrganizationId | integer |
None. |
|
| IsShippingAddress | boolean |
None. |
|
| IsBillingAddress | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"UpdateType": "sample string 1",
"AddressId": 2,
"Label": "sample string 3",
"Attn": "sample string 4",
"Attn2": "sample string 5",
"Street": "sample string 6",
"Street2": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"PostalCode": "sample string 10",
"CountryCode": "sample string 11",
"CreatedBy": "sample string 12",
"CreatedDate": "2026-01-04T15:55:42.4449544+00:00",
"UpdatedBy": "sample string 13",
"UpdatedDate": "2026-01-04T15:55:42.4449544+00:00",
"GlobalId": "sample string 14",
"Note": "sample string 15",
"CustomerId": 1,
"CustomerGlobalId": "sample string 16",
"SupplierId": 1,
"SupplierGlobalId": "sample string 17",
"AddressTypeId": 1,
"AddressType": "sample string 18",
"OrganizationId": 1,
"IsShippingAddress": true,
"IsBillingAddress": true
},
{
"UpdateType": "sample string 1",
"AddressId": 2,
"Label": "sample string 3",
"Attn": "sample string 4",
"Attn2": "sample string 5",
"Street": "sample string 6",
"Street2": "sample string 7",
"City": "sample string 8",
"StateCode": "sample string 9",
"PostalCode": "sample string 10",
"CountryCode": "sample string 11",
"CreatedBy": "sample string 12",
"CreatedDate": "2026-01-04T15:55:42.4449544+00:00",
"UpdatedBy": "sample string 13",
"UpdatedDate": "2026-01-04T15:55:42.4449544+00:00",
"GlobalId": "sample string 14",
"Note": "sample string 15",
"CustomerId": 1,
"CustomerGlobalId": "sample string 16",
"SupplierId": 1,
"SupplierGlobalId": "sample string 17",
"AddressTypeId": 1,
"AddressType": "sample string 18",
"OrganizationId": 1,
"IsShippingAddress": true,
"IsBillingAddress": true
}
]
application/xml, text/xml
Sample:
<ArrayOfAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models">
<Address>
<AddressId>2</AddressId>
<AddressType>sample string 18</AddressType>
<AddressTypeId>1</AddressTypeId>
<Attn>sample string 4</Attn>
<Attn2>sample string 5</Attn2>
<City>sample string 8</City>
<CountryCode>sample string 11</CountryCode>
<CreatedBy>sample string 12</CreatedBy>
<CreatedDate>2026-01-04T15:55:42.4449544+00:00</CreatedDate>
<CustomerGlobalId>sample string 16</CustomerGlobalId>
<CustomerId>1</CustomerId>
<GlobalId>sample string 14</GlobalId>
<IsBillingAddress>true</IsBillingAddress>
<IsShippingAddress>true</IsShippingAddress>
<Label>sample string 3</Label>
<Note>sample string 15</Note>
<OrganizationId>1</OrganizationId>
<PostalCode>sample string 10</PostalCode>
<StateCode>sample string 9</StateCode>
<Street>sample string 6</Street>
<Street2>sample string 7</Street2>
<SupplierGlobalId>sample string 17</SupplierGlobalId>
<SupplierId>1</SupplierId>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 13</UpdatedBy>
<UpdatedDate>2026-01-04T15:55:42.4449544+00:00</UpdatedDate>
</Address>
<Address>
<AddressId>2</AddressId>
<AddressType>sample string 18</AddressType>
<AddressTypeId>1</AddressTypeId>
<Attn>sample string 4</Attn>
<Attn2>sample string 5</Attn2>
<City>sample string 8</City>
<CountryCode>sample string 11</CountryCode>
<CreatedBy>sample string 12</CreatedBy>
<CreatedDate>2026-01-04T15:55:42.4449544+00:00</CreatedDate>
<CustomerGlobalId>sample string 16</CustomerGlobalId>
<CustomerId>1</CustomerId>
<GlobalId>sample string 14</GlobalId>
<IsBillingAddress>true</IsBillingAddress>
<IsShippingAddress>true</IsShippingAddress>
<Label>sample string 3</Label>
<Note>sample string 15</Note>
<OrganizationId>1</OrganizationId>
<PostalCode>sample string 10</PostalCode>
<StateCode>sample string 9</StateCode>
<Street>sample string 6</Street>
<Street2>sample string 7</Street2>
<SupplierGlobalId>sample string 17</SupplierGlobalId>
<SupplierId>1</SupplierId>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 13</UpdatedBy>
<UpdatedDate>2026-01-04T15:55:42.4449544+00:00</UpdatedDate>
</Address>
</ArrayOfAddress>