Public API v2: Common objects

Fields shared by many modules. Each module’s reference folds them into one row and lists the values it takes.

Which module has which

Module	Customers	Exclude customers	Products	Exclude products	Markets	Schedule
Custom Pricing	✓	✓	✓	✓	✓	✓
Price List	✓	✓	-	✓	✓	✓
Volume Pricing	✓	✓	✓	✓	✓	✓
Order Limit	✓	✓	✓	✓	✓	-
Quantity Increment	✓	✓	✓	-	-	-
Extra Fee	✓	✓	✓	✓	-	✓
Shipping Rate	✓	✓	✓	✓	✓	✓
Discount Code	✓	✓	✓	-	-	✓
Tax Display	✓	✓	✓	-	-	-
Buy X Get Y	✓	-	-	-	-	✓
Auto Tag	-	-	-	-	-	-
Net Terms	✓	-	✓	-	-	-

Customers

Field	Notes
`apply_to`	`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. A rule made in the app for All company locations reads as `all_company_locations`; the API does not accept it as a value you write.
`customer_ids`, `customer_tags`, `company_location_ids`	The list `apply_to` selects; required and not empty for that type.
`exclude_from`	`none` (default) · `customer_tags` · `customer_ids` · `company_location`. Excluded customers stay out even when `apply_to` includes them.
`exc_customer_tags`, `exc_customers`, `exc_company_location_ids`	The list `exclude_from` selects.

Products

Field	Notes
`product_condition_type`	`all` every product · `by_ids` · `by_collections` · `by_tags` · `by_variants`.
`product_ids`, `product_collections`, `product_tags`, `variant_ids`	The list the type selects; required and not empty for that type.
`exc_product_type`	`none` (default) or one of the types above: these products are left out.
`exc_specific_products`, `exc_product_collections`, `exc_product_tags`, `exc_product_variants`	The list `exc_product_type` selects.

Markets

Field	Notes
`market_condition_type`	`all` (default) every market · `by_ids` the listed markets.
`market_ids`	Shopify market ids. Custom Pricing, Price List and Volume Pricing take region markets only.

Schedule

Field	Notes
`start_at`	UTC date and time ending in `Z`; `null` or left out: starts at once.
`end_at`	After `start_at`; `null` or left out: never ends.

Lists in general

Send only the list the type selects. Lists of other types are cleared when the rule is saved, and read back as [].
Lists hold no duplicates, and tags hold no commas.