Skip to content
BSS B2B SuiteBSS B2B Help Center

Public API v2: Extra Fee

Fees added to an order by quantity or by amount, such as a small-order fee.
Scopes extra-fee:read, extra-fee:write
Plan Plans with Extra Fee; 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

Section titled “Good to know”
  • A table has 1–50 rows in ascending order without overlaps; only the last row may leave to empty. PUT replaces both tables.
  • A fee can be negative and a percentage fee is not capped at 100, as in the app.
  • With by_variants or exc_product_variants, the fee applies to, or skips, only those variants. A by_variants type without its list is refused with 422. A list is kept only while its type selects it, so a PUT that changes the type clears the other lists.

The rule object

Section titled “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, by_variants.

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.

variant_ids[string]

Used when the type is by_variants; required and not empty then. Numeric Shopify variant ids as strings.

exc_product_typeenum

none (default) or one of the types above: these products are left out. Accepted here: none, by_ids, by_collections, by_tags, by_variants.

exc_specific_products[string]

Used when exc_product_type is by_ids.

exc_product_collections[string]

Used when exc_product_type is by_collections.

exc_product_tags[string]

Used when exc_product_type is by_tags.

exc_product_variants[string]

Used when exc_product_type is by_variants.

rule_settingenum

One of quantity, amount.

rule_typeenum

One of all_applied_items, per_item.

qty_options[object]

[] unless rule_setting is quantity.

Show fields

frominteger

tointeger or null

feestring

fee_typeenum

One of fixed, percentage_item, percentage_original, fixed_per_item.

free_shipboolean

amount_options[object]

[] unless rule_setting is amount.

Show fields

fromstring

tostring or null

feestring

fee_typeenum

One of fixed, percentage_item, percentage_original, fixed_per_item.

free_shipboolean

ScheduleCommon object

When the rule applies.

Show fields

start_atstring

UTC date and time ending in Z; null or left out: starts at once.

end_atstring

After start_at; null or left out: never ends.

created_atstring or nullread-only

UTC, ending in Z.

updated_atstring or nullread-only

UTC, ending in Z.

The rule object
{
  "id": "19",
  "name": "Handling per item",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_ids": [],
  "customer_tags": [
    "wholesale"
  ],
  "exclude_from": "none",
  "exc_customer_tags": [],
  "exc_customers": [],
  "product_condition_type": "by_collections",
  "product_ids": [],
  "product_collections": [
    "3001"
  ],
  "product_tags": [],
  "variant_ids": [],
  "exc_product_type": "none",
  "exc_specific_products": [],
  "exc_product_collections": [],
  "exc_product_tags": [],
  "exc_product_variants": [],
  "rule_setting": "quantity",
  "rule_type": "per_item",
  "qty_options": [
    {
      "from": 1,
      "to": 9,
      "fee": "5.00",
      "fee_type": "fixed",
      "free_ship": true
    },
    {
      "from": 10,
      "to": null,
      "fee": "-1.50",
      "fee_type": "percentage_item",
      "free_ship": false
    }
  ],
  "amount_options": [],
  "start_at": null,
  "end_at": null,
  "created_at": "2026-10-21T09:33:41.000Z",
  "updated_at": "2026-10-21T09:33:41.000Z"
}

List rules

GET/api/v2/extra-fee/rules

Scope extra-fee:readCost 10

List rules, newest first.

Query parameters

Section titled “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.

filter_rule_settingenum

One of quantity, amount.

filter_rule_typeenum

One of all_applied_items, per_item.

Returns

Section titled “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.

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

Create a rule

POST/api/v2/extra-fee/rules

Scope extra-fee: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

Section titled “Arguments”

namestringrequired

Rule name. 1–200 characters.

priorityintegerrequired

Lower number wins; see Rules. 0–32,767.

statusenumrequired

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

CustomersCommon objectrequired

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 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, by_variants.

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.

variant_ids[string]

Used when the type is by_variants; required and not empty then. Numeric Shopify variant ids as strings.

exc_product_typeenum

none (default) or one of the types above: these products are left out. Accepted here: none, by_ids, by_collections, by_tags, by_variants.

exc_specific_products[string]

Used when exc_product_type is by_ids.

exc_product_collections[string]

Used when exc_product_type is by_collections.

exc_product_tags[string]

Used when exc_product_type is by_tags.

exc_product_variants[string]

Used when exc_product_type is by_variants.

rule_settingenumrequired

  • quantity: Fee by quantity range; send qty_options.
  • amount: Fee by amount range; send amount_options.

rule_typeenumrequired

  • all_applied_items: The range is checked on the total of all matching items in the cart.
  • per_item: The range is checked on each matching item.

qty_options[object]

Required when rule_setting is quantity; rows ascend and do not overlap. 1–50 items.

Show fields

fromintegerrequired

0–2,147,483,647.

tointeger

null or left out: no upper bound, last row only. 1–2,147,483,647.

feestringrequired

Percentages are not capped at 100, as in the admin. Decimal string, up to 2 decimals.

fee_typeenumrequired

  • fixed: A fixed fee.
  • fixed_per_item: A fixed fee for each item.
  • percentage_item: A percentage of the matching items’ subtotal.
  • percentage_original: A percentage of the original price.

free_shipboolean

Default false.

amount_options[object]

Required when rule_setting is amount; rows ascend and do not overlap. 1–50 items.

Show fields

fromstringrequired

An amount in the shop currency. Decimal string, up to 2 decimals.

tostring

null or left out: no upper bound, last row only. Decimal string, up to 2 decimals.

feestringrequired

Percentages are not capped at 100, as in the admin. Decimal string, up to 2 decimals.

fee_typeenumrequired

  • fixed: A fixed fee.
  • fixed_per_item: A fixed fee for each item.
  • percentage_item: A percentage of the matching items’ subtotal.
  • percentage_original: A percentage of the original price.

free_shipboolean

Default false.

ScheduleCommon object

When the rule applies.

Show fields

start_atstring

UTC date and time ending in Z; null or left out: starts at once.

end_atstring

After start_at; null or left out: never ends.

Returns

Section titled “Returns”

dataRule

The new rule.

cURL
curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/extra-fee/rules" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Handling per item",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "wholesale"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "3001"
  ],
  "rule_setting": "quantity",
  "rule_type": "per_item",
  "qty_options": [
    {
      "from": 1,
      "to": 9,
      "fee": "5",
      "fee_type": "fixed",
      "free_ship": true
    },
    {
      "from": 10,
      "to": null,
      "fee": "-1.50",
      "fee_type": "percentage_item"
    }
  ]
}'

Get a rule

GET/api/v2/extra-fee/rules/{id}

Scope extra-fee:readCost 10

Get a rule.

Path parameters

Section titled “Path parameters”

idstringrequired

Rule id.

Returns

Section titled “Returns”

dataRule

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

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

Replace a rule

PUT/api/v2/extra-fee/rules/{id}

Scope extra-fee:writeCost 11

Replace a rule and its fee table; optional fields left out go back to their defaults.

Path parameters

Section titled “Path parameters”

idstringrequired

Rule id.

Arguments

Section titled “Arguments”

The same fields as Create a rule.

Returns

Section titled “Returns”

dataRule

The rule after the change.

cURL
curl -X PUT "https://solution-public-api.bss-b2b.solutions/api/v2/extra-fee/rules/19" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Handling per item (updated)",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "wholesale"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "3001"
  ],
  "rule_setting": "quantity",
  "rule_type": "per_item",
  "qty_options": [
    {
      "from": 1,
      "to": 9,
      "fee": "5",
      "fee_type": "fixed",
      "free_ship": true
    },
    {
      "from": 10,
      "to": null,
      "fee": "-1.50",
      "fee_type": "percentage_item"
    }
  ]
}'

Delete a rule

DEL/api/v2/extra-fee/rules/{id}

Scope extra-fee:writeCost 11

Delete a rule.

Path parameters

Section titled “Path parameters”

idstringrequired

Rule id.

Returns

Section titled “Returns”

data.idstring

Id of the deleted rule.

data.deletedboolean

true.

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

Create or replace rules in bulk

POST/api/v2/extra-fee/rules/bulk-upsert

Scope extra-fee: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

Section titled “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

Section titled “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.

cURL
curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/extra-fee/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": "Handling per item B",
      "priority": 2,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "wholesale"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "3001"
      ],
      "rule_setting": "quantity",
      "rule_type": "per_item",
      "qty_options": [
        {
          "from": 1,
          "to": 9,
          "fee": "5",
          "fee_type": "fixed",
          "free_ship": true
        },
        {
          "from": 10,
          "to": null,
          "fee": "-1.50",
          "fee_type": "percentage_item"
        }
      ]
    },
    {
      "name": "Handling per item (bulk)",
      "priority": 2,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "wholesale"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "3001"
      ],
      "rule_setting": "quantity",
      "rule_type": "per_item",
      "qty_options": [
        {
          "from": 1,
          "to": 9,
          "fee": "5",
          "fee_type": "fixed",
          "free_ship": true
        },
        {
          "from": 10,
          "to": null,
          "fee": "-1.50",
          "fee_type": "percentage_item"
        }
      ],
      "id": "19"
    }
  ]
}'

Delete rules in bulk

POST/api/v2/extra-fee/rules/bulk-delete

Scope extra-fee:writeCost ceil(10 + 0.4 × rules)

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

See Bulk & idempotency.

Arguments

Section titled “Arguments”

ids[string]required

1–250 rule ids.

Returns

Section titled “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.

cURL
curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/extra-fee/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": [
    "20",
    "999999999"
  ]
}'

Upload rules to the storefront

POST/api/v2/extra-fee/rules/upload

Scope extra-fee:writeCost 20

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

The body is empty. See Upload.

Returns

Section titled “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.

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