VOvoucherifyio
Loyalties

List Campaign Pending Points

Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.

👍 Configuring pending points

Pending points are configured as part of an earning rule with POST Create earning rule or PUT Update earning rule.

get/v1/loyalties/{campaignId}/pending-points

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/{campaignId}/pending-points
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

Query parameters

limitinteger

Limit the number of the pending point entries that the API returns in the response.

order'id' | '-id'

Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.

starting_after_idstring

A cursor for pagination. It retrieves the results starting after a result with the given ID.

Response

Returns all pending point entries for all loyalty cards in the campaign.

object'list' required

The type of the object represented by JSON.

data_ref'data' required

Identifies the name of the attribute that contains the array of pending point objects.

has_moreboolean required

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.

more_starting_afterstring

Returns an ID that can be used to return another page of results. Use the pending point entry ID in the starting_after_id query parameter to display another page of the results starting after the entry with that ID.

Example response

{
  "data": [
    {
      "id": "lopp_0ffd593d5ad207ba6b",
      "voucher_id": "v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc",
      "campaign_id": "camp_weer1c3p5ZgktqfW56RfoNaG",
      "customer_id": "cust_IdgAFZxYwwHctOk9ppZMu319",
      "order_id": "ord_0ffc0fa65f15d2df17",
      "details": {
        "event": {
          "event_source": {
            "channel": "API",
            "user": {
              "id": "user_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7"
            },
            "api_key": {
              "app_id": "1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX"
            }
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.