Rewards extension (3.0.33)

mirasvitRewardsRepositoryTransactionRepositoryV1

mirasvitRewardsRepositoryTransactionRepositoryV1GetGet

path Parameters

transactionId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}

mirasvitRewardsRepositoryTransactionRepositoryV1SavePut

path Parameters

transactionId

required

string

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-transaction-interface)

Responses

Request samples

Payload

Content type

{"transaction": {"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}

mirasvitRewardsRepositoryTransactionRepositoryV1DeleteByIdDelete

path Parameters

transactionId

required

integer

Responses

Response samples

200
400
401
default

Content type

true

mirasvitRewardsRepositoryTransactionRepositoryV1SavePost

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-transaction-interface)

Responses

Request samples

Payload

Content type

{"transaction": {"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}

mirasvitRewardsRepositoryTransactionRepositoryV1GetListGet

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
400
401
default

Content type

{"items": [{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

mirasvitRewardsServiceCustomerManagementSearchV1

mirasvitRewardsServiceCustomerManagementSearchV1GetTransactionsGet

path Parameters

customerId

required

integer

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
401
default

Content type

[{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}
]

mirasvitRewardsServiceCustomerManagementSearchV1GetTransactionsGet

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
401
default

Content type

[{"id": 0,
"customer_id": 0,
"amount": 0,
"amount_used": 0,
"comment": "string",
"code": "string",
"is_expired": 0,
"is_expiration_email_sent": 0,
"expires_at": "string",
"created_at": "string",
"activated_at": "string",
"is_activated": true
}
]

mirasvitRewardsRepositoryPurchaseRepositoryV1

mirasvitRewardsRepositoryPurchaseRepositoryV1GetGet

path Parameters

orderId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"quote_id": 0,
"order_id": 0,
"spend_points": 0,
"spend_amount": 0,
"base_spend_amount": 0,
"spend_min_points": 0,
"spend_max_points": 0,
"earn_points": 0,
"lock_quote": "string"
}

mirasvitRewardsRepositoryPurchaseRepositoryV1GetGet

path Parameters

orderId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"quote_id": 0,
"order_id": 0,
"spend_points": 0,
"spend_amount": 0,
"base_spend_amount": 0,
"spend_min_points": 0,
"spend_max_points": 0,
"earn_points": 0,
"lock_quote": "string"
}

mirasvitRewardsV1

Interface for rewards quote calculation

mirasvitRewardsV1GetBalancesGet

Responses

Response samples

200
401
default

Content type

[{"customer_id": 0,
"amount": 0
}
]

mirasvitRewardsV1GetBalanceGet

path Parameters

customerId

required

integer

Responses

Response samples

200
401
default

Content type

0

mirasvitRewardsV1ApplyPost

path Parameters

cartId required	integer
pointAmount required	integer

Responses

Response samples

200
401
default

Content type

true

mirasvitRewardsV1UpdatePost

Request Body schema:
application/json
application/json
application/xml

shippingCarrier	string //we need mixed type here
shippingMethod	string //we need mixed type here
paymentMethod	string //we need mixed type here

Responses

Request samples

Payload

Content type

{"shippingCarrier": "string",
"shippingMethod": "string",
"paymentMethod": "string"
}

Response samples

200
401
default

Content type

{"chechout_rewards_is_show": true,
"chechout_rewards_points": "string",
"chechout_rewards_points_max": 0,
"chechout_rewards_points_spend": "string",
"chechout_rewards_points_availble": "string",
"chechout_rewards_points_used": 0
}

mirasvitRewardsV1GetBalanceGet

Responses

Response samples

200
401
default

Content type

0

mirasvitRewardsV1ApplyPost

Request Body schema:
application/json
application/json
application/xml

pointAmount

required

integer

Responses

Request samples

Payload

Content type

{"pointAmount": 0
}

Response samples

200
401
default

Content type

true

mirasvitRewardsProductPointsV1

Interface for product points calculation

mirasvitRewardsProductPointsV1GetPost

Request Body schema:
application/json
application/json
application/xml

sku required	string
price required	number
customerId required	integer
websiteId required	integer
tierId required	integer

Responses

Request samples

Payload

Content type

{"sku": "string",
"price": 0,
"customerId": 0,
"websiteId": 0,
"tierId": 0
}

Response samples

200
401
default

Content type

0

mirasvitRewardsProductPointsV1GetListPost

Request Body schema:
application/json
application/json
application/xml

required

Array of objects (mirasvit-rewards-data-product-points-interface)

Responses

Request samples

Payload

Content type

{"productInfo": [{"sku": "string",
"price": 0,
"customer_id": 0,
"website_id": 0,
"tier_id": 0
}
]
}

Response samples

200
401
default

Content type

[{"sku": "string",
"points": 0
}
]

mirasvitRewardsRepositoryTierRepositoryV1

mirasvitRewardsRepositoryTierRepositoryV1GetGet

path Parameters

tierId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}

mirasvitRewardsRepositoryTierRepositoryV1SavePut

path Parameters

tierId

required

string

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-tier-interface)

Responses

Request samples

Payload

Content type

{"tier": {"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}
}

Response samples

200
400
401
default

Content type

{"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}

mirasvitRewardsRepositoryTierRepositoryV1DeleteByIdDelete

path Parameters

tierId

required

integer

Responses

Response samples

200
400
401
default

Content type

true

mirasvitRewardsRepositoryTierRepositoryV1GetTiersGet

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
401
default

Content type

{"items": [{"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

mirasvitRewardsRepositoryTierRepositoryV1SavePost

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-tier-interface)

Responses

Request samples

Payload

Content type

{"tier": {"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}
}

Response samples

200
400
401
default

Content type

{"tier_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"min_earn_points": 0,
"tier_logo": "string",
"template_id": 0,
"website_ids": [0
]
}

mirasvitRewardsRepositoryEarningRuleRepositoryV1

mirasvitRewardsRepositoryEarningRuleRepositoryV1GetRulesGet

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
401
default

Content type

{"items": [{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

mirasvitRewardsRepositoryEarningRuleRepositoryV1SavePost

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-earning-rule-interface)

Responses

Request samples

Payload

Content type

{"rule": {"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositoryEarningRuleRepositoryV1GetGet

path Parameters

ruleId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositoryEarningRuleRepositoryV1SavePut

path Parameters

ruleId

required

string

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-earning-rule-interface)

Responses

Request samples

Payload

Content type

{"rule": {"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"behavior_trigger": "string",
"sort_order": 0,
"is_stop_processing": 0,
"param1": "string",
"history_message": "string",
"email_message": "string",
"front_name": "string",
"tiers": [{"tier_id": 0,
"earning_style": "string",
"earn_points": 0,
"monetary_step": 0,
"points_limit": 0,
"qty_step": 0,
"transfer_to_group": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositoryEarningRuleRepositoryV1DeleteByIdDelete

path Parameters

ruleId

required

integer

Responses

Response samples

200
400
401
default

Content type

true

mirasvitRewardsRepositorySpendingRuleRepositoryV1

mirasvitRewardsRepositorySpendingRuleRepositoryV1GetRulesGet

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

Response samples

200
401
default

Content type

{"items": [{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

mirasvitRewardsRepositorySpendingRuleRepositoryV1SavePost

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-spending-rule-interface)

Responses

Request samples

Payload

Content type

{"rule": {"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositorySpendingRuleRepositoryV1GetGet

path Parameters

ruleId

required

integer

Responses

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositorySpendingRuleRepositoryV1SavePut

path Parameters

ruleId

required

string

Request Body schema:
application/json
application/json
application/xml

required

object (mirasvit-rewards-data-spending-rule-interface)

Responses

Request samples

Payload

Content type

{"rule": {"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}
}

Response samples

200
400
401
default

Content type

{"id": 0,
"rule_id": 0,
"name": "string",
"description": "string",
"is_active": true,
"active_from": "string",
"active_to": "string",
"type": "string",
"condition": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"action": {"condition_type": "string",
"conditions": [{ }
],
"aggregator_type": "string",
"operator": "string",
"attribute_name": "string",
"value": "string",
"extension_attributes": { }
},
"sort_order": 0,
"is_stop_processing": 0,
"front_name": "string",
"tiers": [{"tier_id": 0,
"spending_style": "string",
"spend_points": 0,
"monetary_step": 0,
"spend_min_points": 0,
"spend_max_points": 0
}
],
"website_ids": [0
],
"customer_group_ids": ["string"
]
}

mirasvitRewardsRepositorySpendingRuleRepositoryV1DeleteByIdDelete

path Parameters

ruleId

required

integer

Responses

Response samples

200
400
401
default

Content type

true

mirasvitRewardsRepositoryReferralRepositoryV1

mirasvitRewardsRepositoryReferralRepositoryV1GetCodeGet

Responses

Response samples

200
401
default

Content type

"string"

mirasvitRewardsRepositoryReferralRepositoryV1AddReferralPost

Request Body schema:
application/json
application/json
application/xml

code required	string
storeId required	integer

Responses

Request samples

Payload

Content type

{"code": "string",
"storeId": 0
}

Response samples

200
401
default

Content type

0

mirasvitRewardsRepositoryReferralRepositoryV1AddGuestReferralPost

Request Body schema:
application/json
application/json
application/xml

code required	string
quoteId required	integer
storeId required	integer

Responses

Request samples

Payload

Content type

{"code": "string",
"quoteId": 0,
"storeId": 0
}

Response samples

200
default

Content type

0

Rewards extension (3.0.33)

mirasvitRewardsRepositoryTransactionRepositoryV1

mirasvitRewardsRepositoryTransactionRepositoryV1GetGet

path Parameters

Responses

Response samples

mirasvitRewardsRepositoryTransactionRepositoryV1SavePut

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

mirasvitRewardsRepositoryTransactionRepositoryV1DeleteByIdDelete

path Parameters

Responses

Response samples

mirasvitRewardsRepositoryTransactionRepositoryV1SavePost

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

mirasvitRewardsRepositoryTransactionRepositoryV1GetListGet

query Parameters

Responses

Response samples

mirasvitRewardsServiceCustomerManagementSearchV1

mirasvitRewardsServiceCustomerManagementSearchV1GetTransactionsGet

path Parameters

query Parameters

Responses

Response samples

mirasvitRewardsServiceCustomerManagementSearchV1GetTransactionsGet

query Parameters

Responses

Response samples

mirasvitRewardsRepositoryPurchaseRepositoryV1

mirasvitRewardsRepositoryPurchaseRepositoryV1GetGet

path Parameters

Responses

Response samples

mirasvitRewardsRepositoryPurchaseRepositoryV1GetGet

path Parameters

Responses

Response samples

mirasvitRewardsV1

mirasvitRewardsV1GetBalancesGet

Responses

Response samples

mirasvitRewardsV1GetBalanceGet

path Parameters

Responses

Response samples

mirasvitRewardsV1ApplyPost

path Parameters

Responses

Response samples

mirasvitRewardsV1UpdatePost

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

mirasvitRewardsV1GetBalanceGet

Responses

Response samples

mirasvitRewardsV1ApplyPost

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

mirasvitRewardsProductPointsV1

mirasvitRewardsProductPointsV1GetPost

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

mirasvitRewardsProductPointsV1GetListPost

Request Body schema: application/jsonapplication/jsonapplication/xml

Responses

Request samples

Response samples

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml