Skip to content
BSS B2B SuiteBSS B2B Help Center

Public API v2: Order Limit

A minimum or maximum quantity or amount a customer can order.
Scopes order-limit:read, order-limit:write
Plan Plans with Order Limit; 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 rule holds one limit; a minimum and a maximum on the same products are two rules.
  • Whether the limit counts per variant, per product or for the whole cart is a store setting in the app.

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.

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.

MarketsCommon object

Which markets the rule covers.

Show fields

market_condition_typeenum

all (default) every market · by_ids the listed markets. Accepted here: all, by_ids.

market_ids[string]

Shopify market ids.

limit_typeenum

One of min_amount, min_quantity, max_amount, max_quantity.

limit_valuestring

created_atstring or nullread-only

UTC, ending in Z.

updated_atstring or nullread-only

UTC, ending in Z.

The rule object
{
  "id": "48",
  "name": "At least 5 per order",
  "priority": 1,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_ids": [],
  "customer_tags": [
    "wholesale"
  ],
  "exclude_from": "none",
  "exc_customer_tags": [],
  "exc_customers": [],
  "product_condition_type": "by_ids",
  "product_ids": [
    "8123456787001"
  ],
  "product_collections": [],
  "product_tags": [],
  "variant_ids": [],
  "exc_product_type": "none",
  "exc_specific_products": [],
  "exc_product_collections": [],
  "exc_product_tags": [],
  "exc_product_variants": [],
  "market_condition_type": "all",
  "market_ids": [],
  "limit_type": "min_quantity",
  "limit_value": "5.00",
  "created_at": "2026-10-21T09:33:22.000Z",
  "updated_at": "2026-10-21T09:33:22.000Z"
}

List rules

GET/api/v2/order-limit/rules

Scope order-limit: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_limit_typeenum

One of min_amount, min_quantity, max_amount, max_quantity.

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/order-limit/rules?limit=2&filter_name=At" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

Create a rule

POST/api/v2/order-limit/rules

Scope order-limit: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–99.

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.

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.

MarketsCommon object

Which markets the rule covers.

Show fields

market_condition_typeenum

all (default) every market · by_ids the listed markets. Accepted here: all, by_ids.

market_ids[string]

Shopify market ids.

limit_typeenumrequired

  • min_amount: The order must reach at least this amount.
  • min_quantity: The order must have at least this many items.
  • max_amount: The order cannot go over this amount.
  • max_quantity: The order cannot have more than this many items.

limit_valuestringrequired

A quantity, or an amount in the shop currency for *_amount. Decimal string, up to 2 decimals.

Returns

Section titled “Returns”

dataRule

The new rule.

cURL
curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/order-limit/rules" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "At least 5 per order",
  "priority": 1,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "wholesale"
  ],
  "product_condition_type": "by_ids",
  "product_ids": [
    "8123456787001"
  ],
  "limit_type": "min_quantity",
  "limit_value": "5"
}'

Get a rule

GET/api/v2/order-limit/rules/{id}

Scope order-limit: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/order-limit/rules/48" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

Replace a rule

PUT/api/v2/order-limit/rules/{id}

Scope order-limit:writeCost 11

Replace a rule; 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/order-limit/rules/48" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "At least 5 per order (updated)",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "wholesale"
  ],
  "product_condition_type": "by_ids",
  "product_ids": [
    "8123456787001"
  ],
  "limit_type": "min_quantity",
  "limit_value": "5"
}'

Delete a rule

DEL/api/v2/order-limit/rules/{id}

Scope order-limit: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/order-limit/rules/48" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

Create or replace rules in bulk

POST/api/v2/order-limit/rules/bulk-upsert

Scope order-limit: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/order-limit/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": "At least 5 per order B",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "wholesale"
      ],
      "product_condition_type": "by_ids",
      "product_ids": [
        "8123456787001"
      ],
      "limit_type": "min_quantity",
      "limit_value": "5"
    },
    {
      "name": "At least 5 per order (bulk)",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "wholesale"
      ],
      "product_condition_type": "by_ids",
      "product_ids": [
        "8123456787001"
      ],
      "limit_type": "min_quantity",
      "limit_value": "5",
      "id": "48"
    }
  ]
}'

Delete rules in bulk

POST/api/v2/order-limit/rules/bulk-delete

Scope order-limit: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/order-limit/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": [
    "49",
    "999999999"
  ]
}'

Upload rules to the storefront

POST/api/v2/order-limit/rules/upload

Scope order-limit: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/order-limit/rules/upload" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"