v4

latestOpenAPI 3.0.02026-07-31811,0021.1 MB
Objectives

Returns all active objectives for the client.

Purchase schedules are returned as standalone objective items when they are active and still valid. Schedule items have IsSchedule set to true, ScheduleId set to the schedule identifier, and ObjectiveId set to the parent purchase objective identifier. For regular objectives, IsSchedule is false and ScheduleId and ObjectiveId are null.

get/v1/pvt/Objectives/active

Query parameters

CustomerIdstring nullable

ID of the logged in customer. Could be e-mail or document. Used to return if a customer already accomplished an objective. If null, all objectives will be returned.

PageNumberinteger

Pagenation number

PageSizeinteger

Amount of items per page, Max size is 50 items per page.

Response

Paginated list of active objectives and active purchase schedules.

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages