POST v1/Customer/CustomerListByCustomerID

Request Information

URI Parameters

None.

Body Parameters

CustomerListByCustomerIDRequest
NameDescriptionTypeAdditional information
CustomerID

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerID": 1
}

application/xml, text/xml

Sample: 
<CustomerListByCustomerIDRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerID>1</CustomerID>
</CustomerListByCustomerIDRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerListByCustomerIDRequest'.

Response Information

Resource Description

Collection of CustomerListByCustomerIDResponse
NameDescriptionTypeAdditional information
CustomerID

integer

None.
CustomerCode

string

None.
CustomerName

string

None.
EmailAddress

string

None.
ShippingAddress

ShippingAddress

None.
BillingAddress

BillingAddress

None.
CustomerAddress

CustomerAddress

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerID": 1,
    "CustomerCode": "sample string 2",
    "CustomerName": "sample string 3",
    "EmailAddress": "sample string 4",
    "ShippingAddress": {
      "ShippingAddressName": "sample string 1",
      "ShippingAddressLine1": "sample string 2",
      "ShippingAddressLine2": "sample string 3",
      "ShippingAddressLine3": "sample string 4",
      "ShippingAddressCity": "sample string 5",
      "ShippingAddressState": "sample string 6",
      "ShippingAddressZip": "sample string 7",
      "ShippingAddressCountry": "sample string 8",
      "ShippingMethod": "sample string 9"
    },
    "BillingAddress": {
      "BillingAddressName": "sample string 1",
      "BillingAddressLine1": "sample string 2",
      "BillingAddressLine2": "sample string 3",
      "BillingAddressLine3": "sample string 4",
      "BillingAddressCity": "sample string 5",
      "BillingAddressState": "sample string 6",
      "BillingAddressZip": "sample string 7",
      "BillingAddressCountry": "sample string 8"
    },
    "CustomerAddress": {
      "CustomerAddressLine1": "sample string 1",
      "CustomerAddressLine2": "sample string 2",
      "CustomerAddressLine3": "sample string 3",
      "CustomerAddressCity": "sample string 4",
      "CustomerAddressState": "sample string 5",
      "CustomerAddressZip": "sample string 6",
      "CustomerAddressCountry": "sample string 7"
    }
  },
  {
    "CustomerID": 1,
    "CustomerCode": "sample string 2",
    "CustomerName": "sample string 3",
    "EmailAddress": "sample string 4",
    "ShippingAddress": {
      "ShippingAddressName": "sample string 1",
      "ShippingAddressLine1": "sample string 2",
      "ShippingAddressLine2": "sample string 3",
      "ShippingAddressLine3": "sample string 4",
      "ShippingAddressCity": "sample string 5",
      "ShippingAddressState": "sample string 6",
      "ShippingAddressZip": "sample string 7",
      "ShippingAddressCountry": "sample string 8",
      "ShippingMethod": "sample string 9"
    },
    "BillingAddress": {
      "BillingAddressName": "sample string 1",
      "BillingAddressLine1": "sample string 2",
      "BillingAddressLine2": "sample string 3",
      "BillingAddressLine3": "sample string 4",
      "BillingAddressCity": "sample string 5",
      "BillingAddressState": "sample string 6",
      "BillingAddressZip": "sample string 7",
      "BillingAddressCountry": "sample string 8"
    },
    "CustomerAddress": {
      "CustomerAddressLine1": "sample string 1",
      "CustomerAddressLine2": "sample string 2",
      "CustomerAddressLine3": "sample string 3",
      "CustomerAddressCity": "sample string 4",
      "CustomerAddressState": "sample string 5",
      "CustomerAddressZip": "sample string 6",
      "CustomerAddressCountry": "sample string 7"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerListByCustomerIDResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerListByCustomerIDResponse>
    <CustomerID>1</CustomerID>
    <CustomerCode>sample string 2</CustomerCode>
    <CustomerName>sample string 3</CustomerName>
    <EmailAddress>sample string 4</EmailAddress>
    <ShippingAddress>
      <ShippingAddressName>sample string 1</ShippingAddressName>
      <ShippingAddressLine1>sample string 2</ShippingAddressLine1>
      <ShippingAddressLine2>sample string 3</ShippingAddressLine2>
      <ShippingAddressLine3>sample string 4</ShippingAddressLine3>
      <ShippingAddressCity>sample string 5</ShippingAddressCity>
      <ShippingAddressState>sample string 6</ShippingAddressState>
      <ShippingAddressZip>sample string 7</ShippingAddressZip>
      <ShippingAddressCountry>sample string 8</ShippingAddressCountry>
      <ShippingMethod>sample string 9</ShippingMethod>
    </ShippingAddress>
    <BillingAddress>
      <BillingAddressName>sample string 1</BillingAddressName>
      <BillingAddressLine1>sample string 2</BillingAddressLine1>
      <BillingAddressLine2>sample string 3</BillingAddressLine2>
      <BillingAddressLine3>sample string 4</BillingAddressLine3>
      <BillingAddressCity>sample string 5</BillingAddressCity>
      <BillingAddressState>sample string 6</BillingAddressState>
      <BillingAddressZip>sample string 7</BillingAddressZip>
      <BillingAddressCountry>sample string 8</BillingAddressCountry>
    </BillingAddress>
    <CustomerAddress>
      <CustomerAddressLine1>sample string 1</CustomerAddressLine1>
      <CustomerAddressLine2>sample string 2</CustomerAddressLine2>
      <CustomerAddressLine3>sample string 3</CustomerAddressLine3>
      <CustomerAddressCity>sample string 4</CustomerAddressCity>
      <CustomerAddressState>sample string 5</CustomerAddressState>
      <CustomerAddressZip>sample string 6</CustomerAddressZip>
      <CustomerAddressCountry>sample string 7</CustomerAddressCountry>
    </CustomerAddress>
  </CustomerListByCustomerIDResponse>
  <CustomerListByCustomerIDResponse>
    <CustomerID>1</CustomerID>
    <CustomerCode>sample string 2</CustomerCode>
    <CustomerName>sample string 3</CustomerName>
    <EmailAddress>sample string 4</EmailAddress>
    <ShippingAddress>
      <ShippingAddressName>sample string 1</ShippingAddressName>
      <ShippingAddressLine1>sample string 2</ShippingAddressLine1>
      <ShippingAddressLine2>sample string 3</ShippingAddressLine2>
      <ShippingAddressLine3>sample string 4</ShippingAddressLine3>
      <ShippingAddressCity>sample string 5</ShippingAddressCity>
      <ShippingAddressState>sample string 6</ShippingAddressState>
      <ShippingAddressZip>sample string 7</ShippingAddressZip>
      <ShippingAddressCountry>sample string 8</ShippingAddressCountry>
      <ShippingMethod>sample string 9</ShippingMethod>
    </ShippingAddress>
    <BillingAddress>
      <BillingAddressName>sample string 1</BillingAddressName>
      <BillingAddressLine1>sample string 2</BillingAddressLine1>
      <BillingAddressLine2>sample string 3</BillingAddressLine2>
      <BillingAddressLine3>sample string 4</BillingAddressLine3>
      <BillingAddressCity>sample string 5</BillingAddressCity>
      <BillingAddressState>sample string 6</BillingAddressState>
      <BillingAddressZip>sample string 7</BillingAddressZip>
      <BillingAddressCountry>sample string 8</BillingAddressCountry>
    </BillingAddress>
    <CustomerAddress>
      <CustomerAddressLine1>sample string 1</CustomerAddressLine1>
      <CustomerAddressLine2>sample string 2</CustomerAddressLine2>
      <CustomerAddressLine3>sample string 3</CustomerAddressLine3>
      <CustomerAddressCity>sample string 4</CustomerAddressCity>
      <CustomerAddressState>sample string 5</CustomerAddressState>
      <CustomerAddressZip>sample string 6</CustomerAddressZip>
      <CustomerAddressCountry>sample string 7</CustomerAddressCountry>
    </CustomerAddress>
  </CustomerListByCustomerIDResponse>
</ArrayOfCustomerListByCustomerIDResponse>