Cdn API

<back to all web services

AddressCheckRequest

Cdn.Api

The following routes are available for this service:
POST/AddressCheckRequest
AddressCheckRequest Parameters:
NameParameterData TypeRequiredDescription
CustIdbodylongNo
ShipNamebodystringNo
ShipCompanybodystringNo
ShipAddress1bodystringNo
ShipAddress2bodystringNo
ShipAddress3bodystringNo
ShipCitybodystringNo
ShipStatebodystringNo
ShipZipCodebodystringNo
ShipProvincebodystringNo
ShipCountrybodystringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	CustId: 0,
	ShipName: String,
	ShipCompany: String,
	ShipAddress1: String,
	ShipAddress2: String,
	ShipAddress3: String,
	ShipCity: String,
	ShipState: String,
	ShipZipCode: String,
	ShipProvince: String,
	ShipCountry: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
			StartDtDisplay: String,
			EndDt: 0001-01-01,
			EndDtDisplay: String,
			Country: 
			{
				CountryName: String,
				SortOrder: 0,
				CountryCode: String,
				Id: 0,
				Active: False,
				LastMod: 0001-01-01,
				LastModBy: String
			},
			CountryName: String,
			State: 
			{
				StateName: String,
				Abbr: String,
				SortOrder: 0,
				IsTaxable: False,
				IsTaxed: False,
				UseTaxApi: False,
				TaxRate: 0,
				Id: 0,
				Active: False,
				LastMod: 0001-01-01,
				LastModBy: String
			},
			StateAbbr: String,
			CustomerId: 0,
			OrganizationId: 0,
			IsUspsValid: False,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}