Cdn API

<back to all web services

AddressListReportRequest

Cdn.Api

The following routes are available for this service:
GET/AddressListReportRequest
AddressListReportRequest Parameters:
NameParameterData TypeRequiredDescription
Categoriesquerylong[]No
ShipMethodquerystringNo
Pagequeryint?No
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
AddressListReportResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAddressListReportItemDto[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
AddressListReportItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
Customer_IdformlongNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
ProductCategoryNameformstringNo
ProductCategory_IdformlongNo
IssuesRemainingformintNo
ExpirationDateformDateTimeNo
ExpirationDateDisplayformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipCodeformstringNo
ProvinceRegionformstringNo
CountryformstringNo
ShipMethodformstringNo
IsFirstClassCustomerformboolNo
IsFirstClassformstringNo
IsFirstClassBoolformboolNo
AddressListReportResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAddressListReportItemDto[]No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /AddressListReportRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddressListReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:AddressListReportItemDto>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Customer_Id>0</d2p1:Customer_Id>
      <d2p1:ExpirationDate>0001-01-01T00:00:00</d2p1:ExpirationDate>
      <d2p1:ExpirationDateDisplay>String</d2p1:ExpirationDateDisplay>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsFirstClass>String</d2p1:IsFirstClass>
      <d2p1:IsFirstClassBool>false</d2p1:IsFirstClassBool>
      <d2p1:IsFirstClassCustomer>false</d2p1:IsFirstClassCustomer>
      <d2p1:IssuesRemaining>0</d2p1:IssuesRemaining>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:ProductCategoryName>String</d2p1:ProductCategoryName>
      <d2p1:ProductCategory_Id>0</d2p1:ProductCategory_Id>
      <d2p1:ProvinceRegion>String</d2p1:ProvinceRegion>
      <d2p1:ShipMethod>String</d2p1:ShipMethod>
      <d2p1:State>String</d2p1:State>
      <d2p1:ZipCode>String</d2p1:ZipCode>
    </d2p1:AddressListReportItemDto>
  </Data>
</AddressListReportResponse>