API Reference

Arguments Files - addPinItemRule

Parameter	Type	Description
dates	RequiredDates!	The required dates for the rule. Example of use: dates: { start: "2024-09-01", end: "2024-10-01" }
description	String	A textual description of the rule
name	String!	The name of the rule. Example of use: name: "All Inclusive"
offers	[ID!]!	List of offer IDs related to the rule. Example of use: offers: [1, 2, 3]
status	RuleStatus!	The status of the rule (draft/active/inactive). Example of use: status: draft
triggers	Triggers!	The triggers that activate the rule. Example of use: triggers: { filters: { FilterName: value}, "query": {"query": String, "matcher": "contains" / "equals" } }

Arguments Files - deletePinItemRule

Parameter	Type	Description
id	ID!	The rule id. Example of use : id: 3

Arguments Files - updatePinItemRule

Parameter	Type	Description
dates	OptionalDates	The optional dates for the rule. Example of use: dates: { start: "2024-09-01", end: "2024-10-01" }
description	String	A textual description of the rule. Example of use: "description": "A rule that moves offer IDs 1, 2, and 3 higher in the results after entering the 'All inclusive' query."
id	ID!	The unique identifier for the rule.
name	String	The name of the rule. Example of use: name: "All Inclusive"
offers	[ID!]	List of offer IDs related to the rule. Example of use: offers: [1, 2, 3]
status	RuleStatus	The status of the rule (draft/active/inactive). Example of use: status: draft
triggers	Triggers	The triggers that activate the rule. Example of use: triggers: { filters: { FilterName: value}, "query": {"query": String, "matcher": "contains" / "equals" } }