Public API v2: Tax Display

How prices show with and without tax, per customer group and product.


Scopes	`tax-display:read`, `tax-display:write`
Plan	Plans with Tax Display; otherwise `403`
Takes effect	Saved in the app; reaches the storefront at the next upload.

Every response has the same envelope (success, status, data, meta; see Responses). Returns below describes data. The examples are real calls; the rules were created disabled.

Good to know

No schedule. Tax overrides, translations and theme setup stay in the app.

The rule object

What every read returns. Lists come back as [] when empty, never null.

idstringread-only

Rule id.

namestring

Rule name.

priorityinteger

Lower number wins; see Rules.

statusenum

disabled rules are kept but not applied. One of disabled, enabled.

CustomersCommon object

Who gets the rule.

Show fields

apply_toenum

all everyone, logged in or not · logged_in any logged-in customer · non_logged_in visitors who are not logged in · customer_ids the listed customers · customer_tags customers with any of the tags · company_location the listed B2B company locations. Accepted here: all, logged_in, non_logged_in, customer_ids, customer_tags.

customer_ids[string]

Used when apply_to is customer_ids; required and not empty then.

customer_tags[string]

Used when apply_to is customer_tags; required and not empty then.

exclude_fromenum

none (default) · customer_tags · customer_ids · company_location. Excluded customers stay out even when apply_to includes them. Accepted here: none, customer_tags, customer_ids.

exc_customer_tags[string]

Used when exclude_from is customer_tags.

exc_customers[string]

Used when exclude_from is customer_ids.

ProductsCommon object

Which products the rule covers.

Show fields

product_condition_typeenum

all every product · by_ids · by_collections · by_tags · by_variants. Accepted here: all, by_ids, by_collections, by_tags.

product_ids[string]

Used when the type is by_ids; required and not empty then.

product_collections[string]

Used when the type is by_collections; required and not empty then.

product_tags[string]

Used when the type is by_tags; required and not empty then.

display_priceenum

One of both, incl_tax, excl_tax, toggle.

price_emphasisenum

One of incl_x2, incl_x3, incl_x4, same, excl_x4, excl_x3, excl_x2.

apply_to_pageenum

One of product_main, cart_item, other_pages, all.

incl_colorstring or null

excl_colorstring or null

created_atstring or nullread-only

UTC, ending in Z.

updated_atstring or nullread-only

UTC, ending in Z.

{
  "id": "13",
  "name": "EU VAT",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_ids": [],
  "customer_tags": [
    "eu"
  ],
  "exclude_from": "customer_tags",
  "exc_customer_tags": [
    "exempt"
  ],
  "exc_customers": [],
  "product_condition_type": "by_collections",
  "product_ids": [],
  "product_collections": [
    "3001"
  ],
  "product_tags": [],
  "display_price": "both",
  "price_emphasis": "excl_x2",
  "apply_to_page": "product_main",
  "incl_color": "#eb4f47",
  "excl_color": "#000",
  "created_at": "2026-10-21T09:34:09.000Z",
  "updated_at": "2026-10-21T09:34:09.000Z"
}

List rules

GET/api/v2/tax-display/rules

Scope tax-display:readCost 10

List rules, newest first.

Query parameters

limitinteger

1–250, default 50. See Paging.

cursorstring

next_cursor or prev_cursor of the last page; leave out for the first page. Keep the same filters on every page.

filter_statusenum

One of disabled, enabled.

filter_namestring

Part of the name, any case. 1–200 characters.

Returns

data[Rule]

The rules of this page; [] when there are none.

meta.paginationobject

limit, next_cursor, prev_cursor and links to the next and previous pages.

Request
Response

curl -X GET "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules?limit=2&filter_name=EU" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": [
    {
      "id": "13",
      "name": "EU VAT",
      "priority": 2,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_ids": [],
      "customer_tags": [
        "eu"
      ],
      "exclude_from": "customer_tags",
      "exc_customer_tags": [
        "exempt"
      ],
      "exc_customers": [],
      "product_condition_type": "by_collections",
      "product_ids": [],
      "product_collections": [
        "3001"
      ],
      "product_tags": [],
      "display_price": "both",
      "price_emphasis": "excl_x2",
      "apply_to_page": "product_main",
      "incl_color": "#eb4f47",
      "excl_color": "#000",
      "created_at": "2026-10-21T09:34:09.000Z",
      "updated_at": "2026-10-21T09:34:09.000Z"
    }
  ],
  "meta": {
    "timestamp": "2026-10-21T09:34:11.857Z",
    "version": "v2",
    "request_id": "b6ebe52d-c18f-4bba-806b-1bf312ca2345",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    },
    "pagination": {
      "limit": 2,
      "next_cursor": null,
      "prev_cursor": null,
      "links": {
        "self": "/api/v2/tax-display/rules?limit=2&filter_name=EU",
        "next": null,
        "prev": null
      }
    }
  }
}

Create a rule

POST/api/v2/tax-display/rules

Scope tax-display:writeCost 11

Create a rule.

The body of POST /rules, PUT /rules/{id} and each element of bulk-upsert (add id to replace a rule). PUT replaces the whole rule: optional fields left out go back to their defaults. Fields not listed here are refused with 422.

Arguments

namestringrequired

Rule name. 1–200 characters.

priorityintegerrequired

Lower number wins; see Rules. 0–99.

statusenumrequired

disabled rules are kept but not applied. One of disabled, enabled.

CustomersCommon objectrequired

Who gets the rule.

Show fields

apply_toenum

customer_ids[string]

Used when apply_to is customer_ids; required and not empty then.

customer_tags[string]

Used when apply_to is customer_tags; required and not empty then.

exclude_fromenum

none (default) · customer_tags · customer_ids · company_location. Excluded customers stay out even when apply_to includes them. Accepted here: none, customer_tags, customer_ids.

exc_customer_tags[string]

Used when exclude_from is customer_tags.

exc_customers[string]

Used when exclude_from is customer_ids.

ProductsCommon objectrequired

Which products the rule covers.

Show fields

product_condition_typeenum

all every product · by_ids · by_collections · by_tags · by_variants. Accepted here: all, by_ids, by_collections, by_tags.

product_ids[string]

Used when the type is by_ids; required and not empty then.

product_collections[string]

Used when the type is by_collections; required and not empty then.

product_tags[string]

Used when the type is by_tags; required and not empty then.

display_priceenumrequired

toggle lets the customer switch between both prices; only with apply_to_page and product_condition_type both all.

both: Show the price with and without tax.
incl_tax: Show the price with tax only.
excl_tax: Show the price without tax only.
toggle: Let the customer switch; needs apply_to_page = all and product_condition_type = all.

price_emphasisenum

Which price is drawn larger, and how many times: incl_x2 is the price with tax at 2×. Default "same".

incl_x2, incl_x3, incl_x4: The price with tax is shown 2, 3 or 4 times larger.
same: Both prices at the same size.
excl_x2, excl_x3, excl_x4: The price without tax is shown 2, 3 or 4 times larger.

apply_to_pageenum

Default "all".

product_main, cart_item, other_pages, all: Product page, cart, other pages, or all pages.

incl_colorstring

Text colour of the price with tax. Default "#000000".

excl_colorstring

Text colour of the price without tax. Default "#000000".

Returns

dataRule

The new rule.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "EU VAT",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "eu"
  ],
  "exclude_from": "customer_tags",
  "exc_customer_tags": [
    "exempt"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "3001"
  ],
  "display_price": "both",
  "price_emphasis": "excl_x2",
  "apply_to_page": "product_main",
  "incl_color": "#eb4f47",
  "excl_color": "#000"
}'

{
  "success": true,
  "status": "success",
  "data": {
    "id": "13",
    "name": "EU VAT",
    "priority": 2,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "eu"
    ],
    "exclude_from": "customer_tags",
    "exc_customer_tags": [
      "exempt"
    ],
    "exc_customers": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "3001"
    ],
    "product_tags": [],
    "display_price": "both",
    "price_emphasis": "excl_x2",
    "apply_to_page": "product_main",
    "incl_color": "#eb4f47",
    "excl_color": "#000",
    "created_at": "2026-10-21T09:34:09.000Z",
    "updated_at": "2026-10-21T09:34:09.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:09.238Z",
    "version": "v2",
    "request_id": "ce765b42-cdca-47a7-a338-39ea66257cc5",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Get a rule

GET/api/v2/tax-display/rules/{id}

Scope tax-display:readCost 10

Get a rule.

Path parameters

idstringrequired

Rule id.

Returns

dataRule

The rule. An id that does not exist answers 404 RESOURCE_NOT_FOUND.

Request
Response

curl -X GET "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/13" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": {
    "id": "13",
    "name": "EU VAT",
    "priority": 2,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "eu"
    ],
    "exclude_from": "customer_tags",
    "exc_customer_tags": [
      "exempt"
    ],
    "exc_customers": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "3001"
    ],
    "product_tags": [],
    "display_price": "both",
    "price_emphasis": "excl_x2",
    "apply_to_page": "product_main",
    "incl_color": "#eb4f47",
    "excl_color": "#000",
    "created_at": "2026-10-21T09:34:09.000Z",
    "updated_at": "2026-10-21T09:34:09.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:10.549Z",
    "version": "v2",
    "request_id": "1fcbe112-7818-4d8f-83e4-0901c1d25bf4",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    }
  }
}

Replace a rule

PUT/api/v2/tax-display/rules/{id}

Scope tax-display:writeCost 11

Replace a rule; optional fields left out go back to their defaults.

Path parameters

idstringrequired

Rule id.

Arguments

The same fields as Create a rule.

Returns

dataRule

The rule after the change.

Request
Response

curl -X PUT "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/13" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "EU VAT (updated)",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "eu"
  ],
  "exclude_from": "customer_tags",
  "exc_customer_tags": [
    "exempt"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "3001"
  ],
  "display_price": "both",
  "price_emphasis": "excl_x2",
  "apply_to_page": "product_main",
  "incl_color": "#eb4f47",
  "excl_color": "#000"
}'

{
  "success": true,
  "status": "success",
  "data": {
    "id": "13",
    "name": "EU VAT (updated)",
    "priority": 2,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "eu"
    ],
    "exclude_from": "customer_tags",
    "exc_customer_tags": [
      "exempt"
    ],
    "exc_customers": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "3001"
    ],
    "product_tags": [],
    "display_price": "both",
    "price_emphasis": "excl_x2",
    "apply_to_page": "product_main",
    "incl_color": "#eb4f47",
    "excl_color": "#000",
    "created_at": "2026-10-21T09:34:09.000Z",
    "updated_at": "2026-10-21T09:34:13.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:13.177Z",
    "version": "v2",
    "request_id": "51cf9c5b-454a-4413-82bc-09e15e427254",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Delete a rule

DEL/api/v2/tax-display/rules/{id}

Scope tax-display:writeCost 11

Delete a rule.

Path parameters

idstringrequired

Rule id.

Returns

data.idstring

Id of the deleted rule.

data.deletedboolean

true.

Request
Response

curl -X DELETE "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/13" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": {
    "id": "13",
    "deleted": true
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:17.139Z",
    "version": "v2",
    "request_id": "989bce84-04aa-400a-a94c-36c72ffad330",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Create or replace rules in bulk

POST/api/v2/tax-display/rules/bulk-upsert

Scope tax-display:writeCost ceil(10 + 0.4 × rules)

Create or replace up to 250 rules; each one succeeds or fails on its own.

See Bulk & idempotency.

Arguments

rules[object]required

1–250 rules, each with the fields of Create a rule.

Show fields

idstring

Set it to replace that rule, as Replace a rule does; leave it out to create one.

Returns

data.results[object]

One entry per rule, in the order sent.

Show fields

indexinteger

Position of the rule in rules.

idstring

Rule id.

resultenum

created, updated or error.

errorobject

code and message, only when result is error.

data.summaryobject

total, succeeded, failed.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/bulk-upsert" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "rules": [
    {
      "name": "EU VAT B",
      "priority": 2,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "eu"
      ],
      "exclude_from": "customer_tags",
      "exc_customer_tags": [
        "exempt"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "3001"
      ],
      "display_price": "both",
      "price_emphasis": "excl_x2",
      "apply_to_page": "product_main",
      "incl_color": "#eb4f47",
      "excl_color": "#000"
    },
    {
      "name": "EU VAT (bulk)",
      "priority": 2,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "eu"
      ],
      "exclude_from": "customer_tags",
      "exc_customer_tags": [
        "exempt"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "3001"
      ],
      "display_price": "both",
      "price_emphasis": "excl_x2",
      "apply_to_page": "product_main",
      "incl_color": "#eb4f47",
      "excl_color": "#000",
      "id": "13"
    }
  ]
}'

{
  "success": true,
  "status": "success",
  "data": {
    "results": [
      {
        "index": 0,
        "id": "14",
        "result": "created"
      },
      {
        "index": 1,
        "id": "13",
        "result": "updated"
      }
    ],
    "summary": {
      "total": 2,
      "succeeded": 2,
      "failed": 0
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:14.516Z",
    "version": "v2",
    "request_id": "7fd7229e-c800-456b-8f82-fda4e6d99ad9",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Delete rules in bulk

POST/api/v2/tax-display/rules/bulk-delete

Scope tax-display:writeCost ceil(10 + 0.4 × rules)

Delete up to 250 rules; an unknown id fails on its own.

See Bulk & idempotency.

Arguments

ids[string]required

1–250 rule ids.

Returns

data.results[object]

One entry per id: index, id, result (deleted or error) and error (code, message) when it failed.

data.summaryobject

total, succeeded, failed.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/bulk-delete" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "14",
    "999999999"
  ]
}'

{
  "success": true,
  "status": "success",
  "data": {
    "results": [
      {
        "index": 0,
        "id": "14",
        "result": "deleted"
      },
      {
        "index": 1,
        "id": "999999999",
        "result": "error",
        "error": {
          "code": "RESOURCE_NOT_FOUND",
          "message": "Resource not found"
        }
      }
    ],
    "summary": {
      "total": 2,
      "succeeded": 1,
      "failed": 1
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:15.831Z",
    "version": "v2",
    "request_id": "7bb6c80f-e6d7-4c12-b1b3-ff5459eaa6f8",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Upload rules to the storefront

POST/api/v2/tax-display/rules/upload

Scope tax-display:writeCost 20

Upload the rules to the storefront, as the app does.

The body is empty. See Upload.

Returns

data.statusenum

uploaded, or partial_success when some rules did not reach the storefront.

data.skippedobject

capacity_exceeded, write_failed and rule_id_range; see Upload.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/tax-display/rules/upload" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

Answer of the Net Terms upload; every module answers in this shape.

{
  "success": true,
  "status": "success",
  "data": {
    "status": "uploaded",
    "skipped": {
      "capacity_exceeded": 0,
      "write_failed": 0,
      "rule_id_range": null
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:46.663Z",
    "version": "v2",
    "request_id": "db2079e7-e134-412e-9943-e2c2b29a9e8c",
    "rate_limit": {
      "cost": 20,
      "limit": 600,
      "remaining": 580,
      "restore_rate": 10
    }
  }
}