Skip to main content
GET
Returns the latest known forecast and granted purchase points for each order.

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Query Parameters

from
string<date-time>

Inclusive lower boundary of OrderPlacementDate (when the order was placed), in ISO 8601 format. If omitted, the minimum DateTimeOffset value is used, effectively including all earlier orders. Does not filter when points were granted.

to
string<date-time>

Inclusive upper boundary of OrderPlacementDate (when the order was placed), in ISO 8601 format. If omitted or default, the current UTC date and time is used. The supplied time is preserved; a date at midnight does not include the rest of that day.

state
enum<integer> | null

Optional points state: Granted (0) for granted points or Pending (1) for forecast points awaiting grant. This is not the order's fulfillment status. Omit to include both; use isCancelledOrReversed to filter cancellations or reversals separately. 0 = Granted 1 = Pending

Available options:
0,
1
isOrderReadyToGrant
boolean | null

Optional availability flag recorded in the snapshot. true selects orders whose grant availability date had arrived, or which had no availability date; false selects orders whose availability date was still in the future. This flag alone does not mean points were granted. Combine with state=Pending to select pending orders whose availability date is no longer in the future. Omit to include both.

isCancelledOrReversed
boolean | null

Optional cancellation/reversal flag recorded in the snapshot. true includes only orders marked as cancelled or with reversed points; false excludes them. Omit to include both. Inspect Grant, NetPoints, NetCashback and Reversal for the granted and remaining values.

orderOriginalId
string | null

Optional exact match on the order ID from the source platform, not the internal BonifiQ order ID. Leading and trailing whitespace is ignored; an empty value does not filter.

customerOriginalId
string | null

Optional exact match on the customer's original ID from the source platform, not the customer's BonifiQ public ID, email or document. Leading and trailing whitespace is ignored; an empty value does not filter.

campaignIds
integer<int32>[] | null

Optional campaign IDs, matched across both Legacy purchase schedules and AdvancedRule sources. Ignored when nonempty campaignKeys is supplied. Repeat the query parameter for multiple IDs, for example campaignIds=123&campaignIds=456. Selects orders with an allocation for at least one supplied campaign, not necessarily all of them. Omit to include orders regardless of campaign.

attributionSource
enum<integer> | null

Optional campaign allocation source: Exact (0) for attribution based on persisted per-campaign calculation details, or Inferred (1) for attribution reconstructed from available calculation data. Selects orders with at least one allocation of that source. Omit to include all sources and orders without campaign allocations. 0 = Exact 1 = Inferred

Available options:
0,
1
pageNumber
integer<int32>
default:1

Page number, starting at 1. Default: 1. Values below 1 return HTTP 400.

pageSize
integer<int32>
default:10

Requested number of orders per page. Default: 10; maximum: 10000. Values below 1 return HTTP 400. A configured tenant report page size overrides this request, subject to the same maximum. Check PageSize in the response for the effective size.

campaignKeys
object[] | null

Optional campaign IDs qualified by source, taking precedence over campaignIds. Example: campaignKeys[0].CampaignId=5&campaignKeys[0].CampaignSource=AdvancedRule. CampaignSource accepts Legacy (0) or AdvancedRule (1). Use consecutive indexes [1], [2], etc. for additional keys. An allocation matching any supplied key qualifies.

Response

200 - application/json

Snapshot metadata, a summary of all matching orders, and the requested page of orders with forecast, grant, reversal and campaign allocation details.

HasPublishedSnapshot
boolean
SnapshotStartedAt
string<date-time> | null
SnapshotCompletedAt
string<date-time> | null
LatestRunStatus
string | null
StatusMessage
string | null
IsInitialLoadComplete
boolean
HasPendingWork
boolean
LastSuccessfulSyncAt
string<date-time> | null
Summary
object
Items
object[]
TotalItemCount
integer<int32>
PageSize
integer<int32>
PageNumber
integer<int32>
HasNextPage
boolean