YM REST Services

<back to all web services

TaxRateRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequires any of the permissions:/admin/store/, CanAdminMembers
The following routes are available for this service:
GET/Ams/{ClientID}/TaxRateReturns the tax rate for the given client and location - with cache.
TaxRateRequest Parameters:
NameParameterData TypeRequiredDescription
CountryquerystringNo
LocationquerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
TaxRate Parameters:
NameParameterData TypeRequiredDescription
RateformdoubleNo
BasicRateformdoubleNo
CountryRateformdoubleNo
LocationRateformdoubleNo
CountryNoShipformboolNo
CountryTaxShippingformboolNo
LocationNoShipformboolNo
LocationTaxShippingformboolNo
TaxShippingformboolNo

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.

GET /Ams/{ClientID}/TaxRate HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rate: 0,
	BasicRate: 0,
	CountryRate: 0,
	LocationRate: 0,
	CountryNoShip: False,
	CountryTaxShipping: False,
	LocationNoShip: False,
	LocationTaxShipping: False,
	TaxShipping: False
}