GET,POST,PUT,DELETE | /AddressRequest |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | body | long | No | |
CustId | body | long | No | |
IncludeStatesAndCountries | body | bool | No | |
CountryId | body | long | No | |
StateId | body | long | No | |
Label | body | string | No | |
FullName | body | string | No | |
CompanyName | body | string | No | |
Address1 | body | string | No | |
Address2 | body | string | No | |
Address3 | body | string | No | |
City | body | string | No | |
ZipCode | body | string | No | |
ProvinceRegion | body | string | No | |
IsPrimaryBilling | body | bool | No | |
IsPrimaryShipping | body | bool | No | |
IsTemporary | body | bool | No | |
IsDealerDirectory | body | bool | No | |
IsCdnx | body | bool | No | |
StartDt | body | DateTime | No | |
StartDtDisplay | body | string | No | |
EndDt | body | DateTime | No | |
EndDtDisplay | body | string | No | |
CountryName | body | string | No | |
StateAbbr | body | string | No | |
CustomerId | body | long | No | |
IsUspsValid | body | bool | 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 | |
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 .csv suffix or ?format=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-cdnx.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,"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,"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}