GET api/magento/customers/{customerId}/addresses

Gets customer address list

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	customer id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Customer Address List

Collection of SuiteBridge.MagentoWebService.customerAddressEntityItem

Name	Type	Additional information
customer_address_id	integer	None.
created_at	string	None.
updated_at	string	None.
increment_id	string	None.
city	string	None.
company	string	None.
country_id	string	None.
fax	string	None.
firstname	string	None.
lastname	string	None.
middlename	string	None.
postcode	string	None.
prefix	string	None.
region	string	None.
region_id	integer	None.
street	string	None.
suffix	string	None.
telephone	string	None.
is_default_billing	boolean	None.
is_default_shipping	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "customer_address_id": 1,
    "customer_address_idSpecified": true,
    "created_at": "sample string 3",
    "updated_at": "sample string 4",
    "increment_id": "sample string 5",
    "city": "sample string 6",
    "company": "sample string 7",
    "country_id": "sample string 8",
    "fax": "sample string 9",
    "firstname": "sample string 10",
    "lastname": "sample string 11",
    "middlename": "sample string 12",
    "postcode": "sample string 13",
    "prefix": "sample string 14",
    "region": "sample string 15",
    "region_id": 16,
    "region_idSpecified": true,
    "street": "sample string 18",
    "suffix": "sample string 19",
    "telephone": "sample string 20",
    "is_default_billing": true,
    "is_default_billingSpecified": true,
    "is_default_shipping": true,
    "is_default_shippingSpecified": true
  },
  {
    "customer_address_id": 1,
    "customer_address_idSpecified": true,
    "created_at": "sample string 3",
    "updated_at": "sample string 4",
    "increment_id": "sample string 5",
    "city": "sample string 6",
    "company": "sample string 7",
    "country_id": "sample string 8",
    "fax": "sample string 9",
    "firstname": "sample string 10",
    "lastname": "sample string 11",
    "middlename": "sample string 12",
    "postcode": "sample string 13",
    "prefix": "sample string 14",
    "region": "sample string 15",
    "region_id": 16,
    "region_idSpecified": true,
    "street": "sample string 18",
    "suffix": "sample string 19",
    "telephone": "sample string 20",
    "is_default_billing": true,
    "is_default_billingSpecified": true,
    "is_default_shipping": true,
    "is_default_shippingSpecified": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerAddressEntityItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <customerAddressEntityItem>
    <customer_address_id>1</customer_address_id>
    <created_at>sample string 3</created_at>
    <updated_at>sample string 4</updated_at>
    <increment_id>sample string 5</increment_id>
    <city>sample string 6</city>
    <company>sample string 7</company>
    <country_id>sample string 8</country_id>
    <fax>sample string 9</fax>
    <firstname>sample string 10</firstname>
    <lastname>sample string 11</lastname>
    <middlename>sample string 12</middlename>
    <postcode>sample string 13</postcode>
    <prefix>sample string 14</prefix>
    <region>sample string 15</region>
    <region_id>16</region_id>
    <street>sample string 18</street>
    <suffix>sample string 19</suffix>
    <telephone>sample string 20</telephone>
    <is_default_billing>true</is_default_billing>
    <is_default_shipping>true</is_default_shipping>
  </customerAddressEntityItem>
  <customerAddressEntityItem>
    <customer_address_id>1</customer_address_id>
    <created_at>sample string 3</created_at>
    <updated_at>sample string 4</updated_at>
    <increment_id>sample string 5</increment_id>
    <city>sample string 6</city>
    <company>sample string 7</company>
    <country_id>sample string 8</country_id>
    <fax>sample string 9</fax>
    <firstname>sample string 10</firstname>
    <lastname>sample string 11</lastname>
    <middlename>sample string 12</middlename>
    <postcode>sample string 13</postcode>
    <prefix>sample string 14</prefix>
    <region>sample string 15</region>
    <region_id>16</region_id>
    <street>sample string 18</street>
    <suffix>sample string 19</suffix>
    <telephone>sample string 20</telephone>
    <is_default_billing>true</is_default_billing>
    <is_default_shipping>true</is_default_shipping>
  </customerAddressEntityItem>
</ArrayOfCustomerAddressEntityItem>