SMsmile
Reward Fulfillments

List reward fulfillments

Retrieves a list of reward fulfillments.

get/reward_fulfillments

Request

  • Base URL
    https://api.smile.io/v1
  • URL
    https://api.smile.io/v1/reward_fulfillments
  • Auth
    HTTP bearer

Query parameters

customer_idinteger

Filter results to only reward fulfillments with the provided Smile customer ID.

fulfillment_status'pending' | 'issued' | 'cancelled' | 'failed'

Filter results to only reward fulfillments whose fulfillment status matches the provided value.

usage_status'used' | 'unused' | 'untracked'

Filter results to only reward fulfillments whose usage status matches the provided values.

updated_at_minstring date-time

Filter results to only reward fulfillments updated after the provided date and time.

limitinteger

The maximum number of reward fulfillments to retrieve.

Example:1
cursorstring

Cursor for the page of reward fulfillments to retrieve.

Response

Example response

{
  "reward_fulfillments": [
    {
      "id": 625478984,
      "name": "$5 off coupon",
      "code": "5off-e26d02e39149",
      "customer_id": 304169228,
      "fulfillment_status": "issued",
      "image_url": "https://platform-images.smilecdn.co/9283449.png",
      "usage_instructions": "Use this discount code on your next order!",
      "terms_and_conditions": "Reward expires on June 7, 2025. Reward can only be used on purchase of $50 or more. Reward can only be used on select product collections.",
      "expires_at": "2025-06-07T23:59:59.999Z",
      "usage_status": "unused",
      "created_at": "2024-12-07T20:15:27.893Z",
      "updated_at": "2024-12-07T20:15:27.893Z"
    }
  ],
  "metadata": {
    "next_cursor": "aWQ6MixkaXJlY3Rpb246bmV4dA=="
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.