PUT
Set order taxes
Company space For: Manager, Accountant · Permission: tax_settings.update Conditions
  • taxes must be present (an empty list is accepted and clears the selection); each tax_id must appear once.
  • Every tax must exist in the current tax profile with the order scope and be active.
  • calculation_base must be one of items_net_total, items_tax_total or items_gross_total.
  • The selection must be calculable: dependency cycles, inapplicable dependencies or an inactive dependency refuse the call.
What else happens
  • Deletes the previous selection of the current tax profile and replaces it with the list sent, keeping its order.
  • The selected taxes are the ones applied on new orders.
Part of Apply taxes to products and orders.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, tax_id, calculation_base, sort_order, tax.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
taxes
object[]
required

Complete list of order taxes to apply, in the order they apply. Always required; an empty list clears the selection. It replaces the previous list.

Response

Resource (only with response=resource).

data
TaxSettingResource · object[]
required

Items of this page.