Menu

Tax Providers API Routes

A tax provider is a third-party integration or custom logic used to calculate taxes for a cart or an order. These API routes allow admin users to manage tax providers installed in their MedusaGo application.

GET /admin/tax-providers#

List Tax Providers

Retrieve a list of tax providers installed in the MedusaGo application through Tax Module Providers. The tax providers can be filtered by fields such as id. The tax providers can also be sorted or paginated.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
offsetnumberOptional
The number of items to skip when retrieving a list.
limitnumberOptional
Limit the number of items returned in the list.
orderstringOptional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
idstring | string[]Optional
Filter by a tax provider's ID.
is_enabledbooleanOptional
Filter by whether the tax provider is enabled.
$andobject[]Optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
$orobject[]Optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
with_deletedbooleanOptional
Whether to include deleted records in the result.

Request examples

Responses

200 OK

limitnumber
The maximum number of items retrieved.
offsetnumber
The number of items skipped before retrieving the returned items.
countnumber
The total number of items available.
estimate_countnumberOptional
The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
tax_providersobject[]
The list of tax providers.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue
Edited Nov 14·Edit this page