younifyd
Menu

Retrieve Tax By Id

This API lets you retrieve and view a specific tax by ID.

GET/taxes/{id}

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the Retrieve Tax By Id action (under Taxes).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveTaxById.response.data}}.

Request

Path parameters

idintegerrequired

ID of tax to return

Query parameters

contextstring

Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.

One ofvieweditDefault "view"

Response

Returns 200 with an object. Read it in later steps with {{retrieveTaxById.response.data.<field>}}.

idinteger

Unique identifier for the resource. read-only

countrystring

Country ISO 3166 code. mandatory

statestring

State code.

postcodestring

Postcode/ZIP code.

citystring

City name.

ratestring

Tax rate. mandatory

namestring

Tax rate name. mandatory

priorityinteger

Tax priority.

Default 1

compoundboolean

Whether or not this is a compound rate.

Default false

shippingboolean

Whether or not this tax rate also gets applied to shipping.

Default true

orderinteger

Indicates the order that will appear in queries.

Default 0

classstring

Tax class.

Default "standard"

json
{
  "id": 0,
  "country": "string",
  "state": "string",
  "postcode": "string",
  "city": "string",
  "rate": "string",
  "name": "string",
  "priority": 1,
  "compound": false,
  "shipping": true,
  "order": 0,
  "class": "standard"
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.