Validations line item property

A JSON-encoded object used by Supercycle’s cart validation to enforce rules at checkout. Multiple validations are merged into a single object — only the relevant keys will be present for a given line item.

Example

{
  "membership": { "credits": 5 },
  "required_variant": { "id": 987654, "per_line": 1 },
  "quantity": { "max": 3 },
  "uniformity": { "key": "rental_start", "value": "2025-01-01" }
}

Validations

object

Validates that the customer has enough membership credits to complete the rental.

Show properties

integer

required

Number of credits required for this line item.

object

Validates that a specific variant (e.g. a deposit) is present in the cart alongside this line item.

Show properties

integer

required

Shopify variant ID that must be present in the cart.

integer

Required quantity per unit of the rental line item. Defaults to 1.

object

Validates that the quantity of this line item does not exceed available inventory.

Show properties

integer

required

Maximum quantity allowed in the cart for this line item.

object

Validates that all rental line items in the cart share the same value for a given property. Used to prevent mixing incompatible options (e.g. different rental start dates).

Show properties

string

required

The property key that must be uniform across all rental line items.

string

required

The expected value for that key.

Introduction

App blocks

Code snippets

Guides

Validations line item property

Validations

​Validations

Validations