Optimizely Tax Exemptions API
The Tax Exemptions API from Optimizely — 11 operation(s) for tax exemptions.
Operations 15
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/v1/admin/TaxExemptions
List and filter tax exemptions · Returns the EntitySet TaxExemptions
#
Ask an LLM
“How can I see all the tax exemptions configured in my commerce site?”
“Can I filter tax exemptions by name or only get the ones active this year?”
Tell an agent
List every tax exemption.
List tax exemptions matching {filter}, ordered by {orderby}.
POST
/api/v1/admin/TaxExemptions
Create a tax exemption · Post a new entity to EntitySet TaxExemptions
#
Ask an LLM
“How do I set up a new tax exemption with an exempt amount?”
“What does a new tax exemption require besides a name and description?”
Tell an agent
Create a tax exemption named {name} described as {description}.
Add tax exemption {name} ({description}) for amount {amount}, active from {activateOn}.
GET
/api/v1/admin/TaxExemptions({id})
Get one tax exemption by id · Returns the entity with the key from TaxExemptions
#
Ask an LLM
“How can I look up the details of a single tax exemption?”
“Can I pick which fields come back when fetching one tax exemption?”
Tell an agent
Show tax exemption {id}.
Fetch only {select} for tax exemption {id}.
PUT
/api/v1/admin/TaxExemptions({id})
Replace a tax exemption entirely · Replace entity in EntitySet TaxExemptions
#
Ask an LLM
“How do I overwrite all fields of an existing tax exemption at once?”
“Does a full replace of a tax exemption clear dates I don't send?”
Tell an agent
Replace tax exemption {id} with name {name} and description {description}.
Overwrite the complete record of tax exemption {id}.
DELETE
/api/v1/admin/TaxExemptions({id})
Delete one tax exemption · Delete entity in EntitySet TaxExemptions
#
Ask an LLM
“How do I remove a single tax exemption permanently?”
“Can I make a tax exemption delete conditional on an ETag?”
Tell an agent destructive · confirm first
Delete tax exemption {id}.
Remove tax exemption {id} if its ETag is still {etag}.
PATCH
/api/v1/admin/TaxExemptions({id})
Update some fields of a tax exemption · Update entity in EntitySet TaxExemptions
#
Ask an LLM
“How can I change just the exempt amount on a tax exemption?”
“Can I push back the end date of a tax exemption without resending everything?”
Tell an agent
Change the amount on tax exemption {id} to {amount}.
Make tax exemption {id} expire on {deactivateOn}.
GET
/api/v1/admin/TaxExemptions/Default.Default()
Get default values for a new tax exemption · Call operation Default
#
Ask an LLM
“What defaults does a new tax exemption start with?”
“Where do I get an empty tax exemption template?”
Tell an agent
Fetch the default tax exemption template.
Show the starting values used for new tax exemptions.
POST
/api/v1/admin/TaxExemptions/Default.archive
Archive tax exemptions with the archive action · Call operation archive
#
Ask an LLM
“How do I archive tax exemptions I no longer use via the archive action?”
“Can I retire several tax exemptions at once rather than deleting them?”
Tell an agent destructive · confirm first
Archive tax exemptions {ids} via the archive action.
Call the tax exemption archive operation for {ids}.
DELETE
/api/v1/admin/taxexemptions/archive
Archive tax exemptions via the DELETE route · Tax exemptions archive route
#
Ask an LLM
“Is there a DELETE route that archives tax exemptions by id?”
“Can I use /taxexemptions/archive to archive a batch of exemptions?”
Tell an agent destructive · confirm first
Send the archive DELETE for tax exemptions {ids}.
Archive tax exemptions {ids} through the taxexemptions/archive route.
DELETE
/api/v1/admin/taxexemptions/delete
Bulk delete tax exemptions by ids · Tax exemptions delete route
#
Ask an LLM
“How do I delete a batch of tax exemptions in one go?”
“Can I pass several ids to remove multiple tax exemptions?”
Tell an agent destructive · confirm first
Bulk delete tax exemptions {ids}.
Permanently delete every tax exemption in {ids}.
GET
/api/v1/admin/taxexemptions({key})/categories({categoryKey})
Get a category covered by a tax exemption · Tax exemptions get category by key and categorykey
#
Ask an LLM
“Which product categories does a tax exemption apply to?”
“How do I check one category linked to a tax exemption?”
Tell an agent
Get category {categoryKey} on tax exemption {key}.
Check whether category {categoryKey} is covered by tax exemption {key}.
GET
/api/v1/admin/taxexemptions({key})/customproperties({custompropertyKey})
Get a custom property of a tax exemption · Tax exemptions get custom property by key and custompropertykey
#
Ask an LLM
“Where can I read a custom property saved on a tax exemption?”
“How do I fetch one custom attribute from a tax exemption?”
Tell an agent
Get custom property {custompropertyKey} of tax exemption {key}.
Read custom field {custompropertyKey} on tax exemption {key}.
GET
/api/v1/admin/taxexemptions({key})/localtaxrates({localtaxrateKey})
Get a local tax rate tied to a tax exemption · Tax exemptions get local tax rate by key and localtaxratekey
#
Ask an LLM
“Which local tax rates are affected by a tax exemption?”
“How do I read one local tax rate linked to an exemption?”
Tell an agent
Get local tax rate {localtaxrateKey} on tax exemption {key}.
Show the local rate {localtaxrateKey} tied to tax exemption {key}.
GET
/api/v1/admin/taxexemptions({key})/products({productKey})
Get a product covered by a tax exemption · Tax exemptions get product by key and productkey
#
Ask an LLM
“Is a particular product tax exempt under a given exemption?”
“How do I look up one product attached to a tax exemption?”
Tell an agent
Get product {productKey} on tax exemption {key}.
Confirm product {productKey} is exempted by tax exemption {key}.
GET
/api/v1/admin/taxexemptions({key})/states({stateKey})
Get a state covered by a tax exemption · Tax exemptions get state by key and statekey
#
Ask an LLM
“Which states or provinces does a tax exemption apply in?”
“Can I check one state linked to a tax exemption?”
Tell an agent
Get state {stateKey} on tax exemption {key}.
Check if tax exemption {key} applies in state {stateKey}.