GET api/account/customer/address

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerAddress

Name	Type	Additional information
ID	integer	None.
CustomerID	integer	None.
TitleID	integer	None.
Title	PersonTitle	None.
Active	boolean	None.
Nickname	string	None.
FirstName	string	None.
LastName	string	None.
Name	string	None.
Organisation	string	None.
AddressLine1	string	Required
AddressLine2	string	None.
City	string	Required
Region	string	None.
Postcode	string	Required
CountryID	integer	Required
Country	Country	None.
Phone	string	None.
Email	string	None.
DeliveryInstructions	string	Max length: 64
IsDefault	boolean	None.
IsBilling	boolean	None.
DeliveryOffset	integer	None.
DeliveryAreaID	integer	None.
DeliveryArea	DeliveryArea	None.
CourierID	integer	None.
Courier	Courier	None.
DisplayAddress	string	None.
DisplayName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "CustomerID": 2,
    "TitleID": 1,
    "Title": {
      "ID": 1,
      "Name": "sample string 2"
    },
    "Active": true,
    "Nickname": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Name": "sample string 5 sample string 6",
    "Organisation": "sample string 7",
    "AddressLine1": "sample string 8",
    "AddressLine2": "sample string 9",
    "City": "sample string 10",
    "Region": "sample string 11",
    "Postcode": "sample string 12",
    "CountryID": 13,
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    },
    "Phone": "sample string 14",
    "Email": "sample string 15",
    "DeliveryInstructions": "sample string 16",
    "IsDefault": true,
    "IsBilling": true,
    "DeliveryOffset": 19,
    "DeliveryAreaID": 1,
    "DeliveryArea": {
      "ID": 1,
      "Name": "sample string 2",
      "Codename": "sample string 3",
      "SortOrder": 4,
      "Active": true,
      "IsDefault": true,
      "BoxOrderMargin": 1.0,
      "BoxOrderTolerance": 1.0,
      "FishboxMargin": 1.0,
      "DefaultCourierID": 1,
      "DefaultCourier": {
        "ID": 1,
        "TypeID": 2,
        "CourierType": {
          "ID": 1,
          "Name": "sample string 2"
        },
        "Key": 2,
        "Name": "sample string 3",
        "Active": true,
        "IsDefault": true
      }
    },
    "CourierID": 1,
    "Courier": {
      "ID": 1,
      "TypeID": 2,
      "CourierType": {
        "ID": 1,
        "Name": "sample string 2"
      },
      "Key": 2,
      "Name": "sample string 3",
      "Active": true,
      "IsDefault": true
    },
    "DisplayAddress": "sample string 8\nsample string 9\nsample string 10\nsample string 11\nsample string 12\nsample string 2",
    "DisplayName": "sample string 5 sample string 6sample string 8"
  },
  {
    "ID": 1,
    "CustomerID": 2,
    "TitleID": 1,
    "Title": {
      "ID": 1,
      "Name": "sample string 2"
    },
    "Active": true,
    "Nickname": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Name": "sample string 5 sample string 6",
    "Organisation": "sample string 7",
    "AddressLine1": "sample string 8",
    "AddressLine2": "sample string 9",
    "City": "sample string 10",
    "Region": "sample string 11",
    "Postcode": "sample string 12",
    "CountryID": 13,
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    },
    "Phone": "sample string 14",
    "Email": "sample string 15",
    "DeliveryInstructions": "sample string 16",
    "IsDefault": true,
    "IsBilling": true,
    "DeliveryOffset": 19,
    "DeliveryAreaID": 1,
    "DeliveryArea": {
      "ID": 1,
      "Name": "sample string 2",
      "Codename": "sample string 3",
      "SortOrder": 4,
      "Active": true,
      "IsDefault": true,
      "BoxOrderMargin": 1.0,
      "BoxOrderTolerance": 1.0,
      "FishboxMargin": 1.0,
      "DefaultCourierID": 1,
      "DefaultCourier": {
        "ID": 1,
        "TypeID": 2,
        "CourierType": {
          "ID": 1,
          "Name": "sample string 2"
        },
        "Key": 2,
        "Name": "sample string 3",
        "Active": true,
        "IsDefault": true
      }
    },
    "CourierID": 1,
    "Courier": {
      "ID": 1,
      "TypeID": 2,
      "CourierType": {
        "ID": 1,
        "Name": "sample string 2"
      },
      "Key": 2,
      "Name": "sample string 3",
      "Active": true,
      "IsDefault": true
    },
    "DisplayAddress": "sample string 8\nsample string 9\nsample string 10\nsample string 11\nsample string 12\nsample string 2",
    "DisplayName": "sample string 5 sample string 6sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Customers">
  <CustomerAddress>
    <Active>true</Active>
    <AddressLine1>sample string 8</AddressLine1>
    <AddressLine2>sample string 9</AddressLine2>
    <City>sample string 10</City>
    <Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Country>
    <CountryID>13</CountryID>
    <Courier xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:CourierType>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CourierType>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:IsDefault>true</d3p1:IsDefault>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:TypeID>2</d3p1:TypeID>
    </Courier>
    <CourierID>1</CourierID>
    <CustomerID>2</CustomerID>
    <DeliveryArea xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Delivery">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:BoxOrderMargin>1</d3p1:BoxOrderMargin>
      <d3p1:BoxOrderTolerance>1</d3p1:BoxOrderTolerance>
      <d3p1:Codename>sample string 3</d3p1:Codename>
      <d3p1:DefaultCourier xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CourierType>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CourierType>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:TypeID>2</d4p1:TypeID>
      </d3p1:DefaultCourier>
      <d3p1:DefaultCourierID>1</d3p1:DefaultCourierID>
      <d3p1:FishboxMargin>1</d3p1:FishboxMargin>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:IsDefault>true</d3p1:IsDefault>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:SortOrder>4</d3p1:SortOrder>
    </DeliveryArea>
    <DeliveryAreaID>1</DeliveryAreaID>
    <DeliveryInstructions>sample string 16</DeliveryInstructions>
    <DeliveryOffset>19</DeliveryOffset>
    <Email>sample string 15</Email>
    <FirstName>sample string 5</FirstName>
    <ID>1</ID>
    <IsBilling>true</IsBilling>
    <IsDefault>true</IsDefault>
    <LastName>sample string 6</LastName>
    <Nickname>sample string 4</Nickname>
    <Organisation>sample string 7</Organisation>
    <Phone>sample string 14</Phone>
    <Postcode>sample string 12</Postcode>
    <Region>sample string 11</Region>
    <Title xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Title>
    <TitleID>1</TitleID>
  </CustomerAddress>
  <CustomerAddress>
    <Active>true</Active>
    <AddressLine1>sample string 8</AddressLine1>
    <AddressLine2>sample string 9</AddressLine2>
    <City>sample string 10</City>
    <Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Country>
    <CountryID>13</CountryID>
    <Courier xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:CourierType>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:CourierType>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:IsDefault>true</d3p1:IsDefault>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:TypeID>2</d3p1:TypeID>
    </Courier>
    <CourierID>1</CourierID>
    <CustomerID>2</CustomerID>
    <DeliveryArea xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Delivery">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:BoxOrderMargin>1</d3p1:BoxOrderMargin>
      <d3p1:BoxOrderTolerance>1</d3p1:BoxOrderTolerance>
      <d3p1:Codename>sample string 3</d3p1:Codename>
      <d3p1:DefaultCourier xmlns:d4p1="http://schemas.datacontract.org/2004/07/cag.Data.Couriers">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CourierType>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CourierType>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsDefault>true</d4p1:IsDefault>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:TypeID>2</d4p1:TypeID>
      </d3p1:DefaultCourier>
      <d3p1:DefaultCourierID>1</d3p1:DefaultCourierID>
      <d3p1:FishboxMargin>1</d3p1:FishboxMargin>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:IsDefault>true</d3p1:IsDefault>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:SortOrder>4</d3p1:SortOrder>
    </DeliveryArea>
    <DeliveryAreaID>1</DeliveryAreaID>
    <DeliveryInstructions>sample string 16</DeliveryInstructions>
    <DeliveryOffset>19</DeliveryOffset>
    <Email>sample string 15</Email>
    <FirstName>sample string 5</FirstName>
    <ID>1</ID>
    <IsBilling>true</IsBilling>
    <IsDefault>true</IsDefault>
    <LastName>sample string 6</LastName>
    <Nickname>sample string 4</Nickname>
    <Organisation>sample string 7</Organisation>
    <Phone>sample string 14</Phone>
    <Postcode>sample string 12</Postcode>
    <Region>sample string 11</Region>
    <Title xmlns:d3p1="http://schemas.datacontract.org/2004/07/cag.Data.Crm">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Title>
    <TitleID>1</TitleID>
  </CustomerAddress>
</ArrayOfCustomerAddress>