Cdn API

<back to all web services

AddressRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/AddressRequest
AddressRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
CustIdbodylongNo
IncludeStatesAndCountriesbodyboolNo
CountryIdbodylongNo
StateIdbodylongNo
LabelbodystringNo
FullNamebodystringNo
CompanyNamebodystringNo
Address1bodystringNo
Address2bodystringNo
Address3bodystringNo
CitybodystringNo
ZipCodebodystringNo
ProvinceRegionbodystringNo
IsPrimaryBillingbodyboolNo
IsPrimaryShippingbodyboolNo
IsTemporarybodyboolNo
IsDealerDirectorybodyboolNo
IsCdnxbodyboolNo
StartDtbodyDateTimeNo
StartDtDisplaybodystringNo
EndDtbodyDateTimeNo
EndDtDisplaybodystringNo
CountryNamebodystringNo
StateAbbrbodystringNo
CustomerIdbodylongNo
OrganizationIdbodylongNo
IsUspsValidbodyboolNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<AddressDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
AddressDto Parameters:
NameParameterData TypeRequiredDescription
CountryIdformlongNo
StateIdformlongNo
LabelformstringNo
FullNameformstringNo
CompanyNameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
CityformstringNo
ZipCodeformstringNo
ProvinceRegionformstringNo
IsPrimaryBillingformboolNo
IsPrimaryShippingformboolNo
IsTemporaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
StartDtformDateTimeNo
StartDtDisplayformstringNo
EndDtformDateTimeNo
EndDtDisplayformstringNo
CountryformCountryDtoNo
CountryNameformstringNo
StateformStateDtoNo
StateAbbrformstringNo
CountriesformIList<CountryDto>No
StatesformIList<StateDto>No
CustomerIdformlongNo
OrganizationIdformlongNo
IsUspsValidformboolNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
CountryDto Parameters:
NameParameterData TypeRequiredDescription
CountryNameformstringNo
SortOrderformintNo
CountryCodeformstringNo
StateDto Parameters:
NameParameterData TypeRequiredDescription
StateNameformstringNo
AbbrformstringNo
SortOrderformint?No
IsTaxableformboolNo
IsTaxedformboolNo
UseTaxApiformboolNo
TaxRateformdecimalNo

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

HTTP + CSV

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

POST /AddressRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"CustId":0,"IncludeStatesAndCountries":false,"CountryId":0,"StateId":0,"Label":"String","FullName":"String","CompanyName":"String","Address1":"String","Address2":"String","Address3":"String","City":"String","ZipCode":"String","ProvinceRegion":"String","IsPrimaryBilling":false,"IsPrimaryShipping":false,"IsTemporary":false,"IsDealerDirectory":false,"IsCdnx":false,"StartDt":"\/Date(-62135596800000-0000)\/","StartDtDisplay":"String","EndDt":"\/Date(-62135596800000-0000)\/","EndDtDisplay":"String","CountryName":"String","StateAbbr":"String","CustomerId":0,"OrganizationId":0,"IsUspsValid":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"CountryId":0,"StateId":0,"Label":"String","FullName":"String","CompanyName":"String","Address1":"String","Address2":"String","Address3":"String","City":"String","ZipCode":"String","ProvinceRegion":"String","IsPrimaryBilling":false,"IsPrimaryShipping":false,"IsTemporary":false,"IsDealerDirectory":false,"IsCdnx":false,"StartDt":"\/Date(-62135596800000-0000)\/","StartDtDisplay":"String","EndDt":"\/Date(-62135596800000-0000)\/","EndDtDisplay":"String","Country":{"CountryName":"String","SortOrder":0,"CountryCode":"String","Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"CountryName":"String","State":{"StateName":"String","Abbr":"String","SortOrder":0,"IsTaxable":false,"IsTaxed":false,"UseTaxApi":false,"TaxRate":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"StateAbbr":"String","CustomerId":0,"OrganizationId":0,"IsUspsValid":false,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}