API Workflows

Asynchronous Order Processing

Handle large or complex reward orders without blocking your system by monitoring fulfillment as it completes in the background.

Overview

Common asynchronous scenarios include:

  • Large bulk reward orders
  • High-volume campaign distributions
  • Complex fulfillment workflows
  • Orders requiring additional processing time

Instead of waiting for full completion, the API responds quickly and processes fulfillment asynchronously.

How the API is Used

  • Submit large or complex orders without blocking your system
  • Receive immediate acknowledgment of the order
  • Track order status as it progresses from Pending to Completed
  • Use webhooks or polling to monitor fulfillment

Example Workflow

  • Your system submits a large or complex order
  • The API responds with order status as Pending
  • The system processes the order asynchronously
  • Your system monitors status updates
  • The order is completed and rewards are delivered

API Integration Flow

API Integration Flow

1
Authenticate
POST /v1/Tokens
2
Retrieve products
GET /v1/Products
3
Send order
POST /v1/Orders
4
Monitor status
GET /v1/Orders/{id}or webhook

Example Request

JSON
{
  "Type": "Links",
  "LineItems": [
    {
      "ProductId": "CVS",
      "Value": 10,
      "Quantity": 100
    }
  ],
  "PONumber": "ASYNC-17001"
}

Delivery Options

  • DigitalDelivery – Processed asynchronously for large orders
  • Links – Bulk link generation for campaigns
  • PhysicalShipment – Orders processed with fulfillment timelines

Benefits

  • Prevents system timeouts for large requests
  • Enables high-volume reward processing
  • Improves API performance and responsiveness
  • Supports scalable program execution

Compliance Considerations

  • Monitor order status before assuming completion
  • Implement retry and polling strategies
  • Ensure proper handling of delayed fulfillment

Common Program Types

  • Large-scale incentive programs
  • Bulk campaign distributions
  • High-volume survey rewards
  • Enterprise-level reward operations

Related Use Cases