Deprecating multi-reward orders

We are deprecating support for multi-reward orders.

What these are

You can submit multiple rewards per order via the Create order endpoint. This changes the behavior of the endpoint though - the rewards are created and delivered asynchronously, and a different response code is returned.

The original rationale for this approach was because in 2021, Tremendous had low rate limits. Multi-reward order functionality would allow clients to submit more rewards in a single request.

Why deprecate

But in 2022, we released performance optimizations that allowed us to bump rate limits to 10 requests / second for all API clients. So the original rationale is no longer valid. See Rate limiting

The alternative, when creating a batch of rewards, is to create them in a loop. There are considerable benefits to this approach– synchronous processing and immediate error handling. These benefits lead to a simpler integration process.

Who is affected

Only ~2% of API clients. use multi-reward orders, and so nearly all integrations are unaffected.

Note that affected API clients will only need to modify their integrations according to the sunset plan below. This is not a breaking change.

Sunset plan

Changes will be rolled out in a three-phase process:

1. Removal of documentation. Our docs explain how to create multi-reward orders, which leads developers astray. We've modified the docs to omit this.
2. Notice of migration. We'll notify integrations using this functionalty across environments that they will need to modify their integrations to submit one reward per order. The migration window will be 6 months.
3. Sunset of functionality. Once all API clients have migrated, we will no longer support this functionality. We are targeting late Q4 for this sunset.