BSS B2B Solution MCP by usefulapi

List quantity-break (volume) pricing rules for the store, with pagination, sorting and filters. Pass `ids` (max 100) to read specific rules. Returns rules with their quantity tiers and a pageInfo cursor. API: GET /api/v2/vp/rules.

{
  "type": "object",
  "properties": {
    "limit": {
      "description": "Rules per page (1–250, default 30).",
      "type": "integer",
      "minimum": 1,
      "maximum": 250
    },
    "sort": {
      "description": "Sort field (default id).",
      "type": "string",
      "enum": [
        "id",
        "priority",
        "createdAt"
      ]
    },
    "order": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "status": {
      "description": "Only enabled or only disabled rules.",
      "type": "string",
      "enum": [
        "enable",
        "disable"
      ]
    },
    "name": {
      "description": "Case-insensitive substring of the rule name.",
      "type": "string"
    },
    "ruleSetting": {
      "description": "Setting type filter.",
      "type": "string",
      "enum": [
        "quantity",
        "value"
      ]
    },
    "ruleType": {
      "description": "Scope filter.",
      "type": "string",
      "enum": [
        "product",
        "order",
        "variant"
      ]
    },
    "ids": {
      "description": "Comma-separated rule ids (max 100). Ignores pagination params.",
      "type": "string"
    },
    "fields": {
      "description": "Comma-separated rule fields to return. id is always included.",
      "type": "string"
    },
    "nextCursor": {
      "description": "Cursor for the next page (from pageInfo.nextCursor).",
      "type": "string"
    },
    "previousCursor": {
      "description": "Cursor for the previous page (from pageInfo.previousCursor).",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List all custom (B2B) pricing rules of the store: discount type and value, priority, status, and the customers, tags, products and markets each rule applies to. API: POST /api/v1/rule/get-by-domain.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Get one custom pricing rule by its numeric id. API: POST /api/v1/rule/get-by-id.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "The rule id (from bssb2b_list_custom_pricing_rules)."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Find which custom pricing rules apply to the given product ids or product tags. API: POST /api/v1/rule/get-rules-by-products.

{
  "type": "object",
  "properties": {
    "product_ids": {
      "description": "Shopify product ids.",
      "type": "array",
      "items": {
        "type": [
          "string",
          "number"
        ]
      }
    },
    "product_tags": {
      "description": "Product tags.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Find which custom pricing rules apply to the given customer ids or customer tags. API: POST /api/v1/rule/get-rules-by-customers.

{
  "type": "object",
  "properties": {
    "customer_ids": {
      "description": "Shopify customer ids.",
      "type": "array",
      "items": {
        "type": [
          "string",
          "number"
        ]
      }
    },
    "customer_tags": {
      "description": "Customer tags, for example b2b.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Search the store's products by text. Returns one page; pass the returned cursor (afterIndex) to fetch the next page. API: POST /api/v1/product/search.

{
  "type": "object",
  "properties": {
    "searchQuery": {
      "description": "Text to search, for example ocean.",
      "type": "string"
    },
    "first": {
      "description": "Products per page (default 20).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "afterIndex": {
      "description": "Cursor from the last page; null starts at the beginning.",
      "type": [
        "string",
        "number",
        "null"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Get a wholesale registration form definition by its numeric id: fields, labels, types and whether each is required. API: GET /api/v1/rf/form/{id}.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "The registration form id."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List wholesale applicants filtered by status and submission date range. Use status pending to see the accounts waiting for approval. API: POST /api/v1/rf/wholesaler/filter.

{
  "type": "object",
  "properties": {
    "status": {
      "description": "Applicant status, for example pending.",
      "type": "string"
    },
    "start_date": {
      "description": "First submission date, yyyy-mm-dd.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "end_date": {
      "description": "Last submission date, yyyy-mm-dd.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Create a custom pricing rule, or update one when `rule.id` is set. Changes live B2B prices in the store. `rule` holds the rule fields (name, priority, status, apply_to, product_condition_type, product_ids, discount_type, discount_value, exc_product_variants, ...). API: POST /api/v1/rule/save.

{
  "type": "object",
  "properties": {
    "rule": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "description": "The rule object. Include id to update an existing rule."
    }
  },
  "required": [
    "rule"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Delete one or more custom pricing rules by id. Deleted rules stop changing store prices at once. API: POST /api/v1/rule/mass-delete.

{
  "type": "object",
  "properties": {
    "ids": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      },
      "description": "Rule ids to delete (max 100)."
    }
  },
  "required": [
    "ids"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Approve or reject wholesale applicants by email. Only accounts in PENDING status can change; others are not touched. Approval gives the account wholesale prices. API: POST /api/v1/rf/wholesaler/{approve|reject}.

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "approve",
        "reject"
      ],
      "description": "approve or reject."
    },
    "emails": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "format": "email",
        "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
      },
      "description": "Applicant email addresses (max 100)."
    }
  },
  "required": [
    "action",
    "emails"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}