POST | /AddressCheckRequest |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustId | body | long | No | |
ShipName | body | string | No | |
ShipCompany | body | string | No | |
ShipAddress1 | body | string | No | |
ShipAddress2 | body | string | No | |
ShipAddress3 | body | string | No | |
ShipCity | body | string | No | |
ShipState | body | string | No | |
ShipZipCode | body | string | No | |
ShipProvince | body | string | No | |
ShipCountry | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<AddressDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
OpCode | form | int | No | |
ErrorText | form | string | No | |
RequestTime | form | string | No | |
ResponseTime | form | string | No | |
TotalExecutionTime | form | string | No | |
CachedResponse | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountryId | form | long | No | |
StateId | form | long | No | |
Label | form | string | No | |
FullName | form | string | No | |
CompanyName | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
Address3 | form | string | No | |
City | form | string | No | |
ZipCode | form | string | No | |
ProvinceRegion | form | string | No | |
IsPrimaryBilling | form | bool | No | |
IsPrimaryShipping | form | bool | No | |
IsTemporary | form | bool | No | |
IsDealerDirectory | form | bool | No | |
IsCdnx | form | bool | No | |
StartDt | form | DateTime | No | |
StartDtDisplay | form | string | No | |
EndDt | form | DateTime | No | |
EndDtDisplay | form | string | No | |
Country | form | CountryDto | No | |
CountryName | form | string | No | |
State | form | StateDto | No | |
StateAbbr | form | string | No | |
Countries | form | IList<CountryDto> | No | |
States | form | IList<StateDto> | No | |
CustomerId | form | long | No | |
OrganizationId | form | long | No | |
IsUspsValid | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Active | form | bool | No | |
LastMod | form | DateTime | No | |
LastModBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountryName | form | string | No | |
SortOrder | form | int | No | |
CountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StateName | form | string | No | |
Abbr | form | string | No | |
SortOrder | form | int? | No | |
IsTaxable | form | bool | No | |
IsTaxed | form | bool | No | |
UseTaxApi | form | bool | No | |
TaxRate | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }