Mavrck Reward Wins API

openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO Reward Wins API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: RewardWins
paths:
  /influencers/{influencerId}/reward-wins:
    get:
      x-handler: reward_wins/influencer_reward_wins_controller.js
      x-access:
      - administrator
      - root
      tags:
      - RewardWins
      summary: Retrieve all reward wins for an influencer.
      operationId: getAllInfluencerRewardWins
      parameters:
      - name: influencerId
        in: path
        required: true
        schema:
          type: integer
      - name: isFulfilled
        in: query
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/orderByParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: An array of reward wins.
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RewardWin'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API Key invalid or access denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/reward-wins/fulfill-objects/bulk:
    put:
      operationId: bulkFulfillRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/fulfill-objects-with-params/bulk:
    put:
      operationId: bulkFulfillRewardWinsObjectsWithParams
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '422':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/RewardWinBulkFulfillmentParams'
              type: array
        required: true
  /v1/reward-wins/unfulfill-objects/bulk:
    put:
      operationId: bulkUnfulfillRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/update-objects/bulk:
    put:
      operationId: bulkUpdateRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/RewardWinBulkUpdateBody'
              type: array
        required: true
  /v1/reward-wins/unarchive-objects/bulk:
    put:
      operationId: bulkUnarchiveRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/update-filter/bulk:
    put:
      operationId: bulkUpdateRewardWinsFilterValue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateWithFilterRequestBody'
        required: true
  /v1/reward-wins/unarchive-filter/bulk:
    put:
      operationId: bulkUnarchiveRewardWinsFilterValue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActionWithFilterRequestBody'
        required: true
  /v1/reward-wins:
    get:
      operationId: getAllRewardWins
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRewardWinsResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: query
        name: fulfillmentStatus
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: isArchived
        required: false
        schema:
          type: boolean
      - in: query
        name: userFilterData
        required: false
        schema:
          type: string
      - in: query
        name: type
        required: false
        schema:
          type: string
          enum:
          - STRIPE
          - PAYPAL
          - MAVELY
          - TIPALTI
          - TANGO_CARDS
          - MANUAL_CASH_PAYMENT
          - MANUAL_GIFT_CARD
          - SHOPIFY_DISCOUNT
          - PRODUCT
          - PROMO_CODE
          - OTHER
          - GIFT_CARD
      - in: query
        name: q
        required: false
        schema:
          type: string
      - in: query
        name: excludedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: includedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: actionGroupId
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: daysReady
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: globalUserIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: orderField
        required: false
        schema:
          type: string
      - in: query
        name: orderDirection
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - in: query
        name: includeListMember
        required: false
        schema:
          type: boolean
  /v1/reward-wins/{id}:
    put:
      operationId: updateRewardWin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRewardWin'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
  /v1/reward-wins/{id}/fulfillment:
    put:
      operationId: fulfillRewardWin
      responses:
        '200':
          description: Fulfillment successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RewardWinFulfillmentParams'
  /v1/reward-wins/{id}/unfulfillment:
    put:
      operationId: unfulfillRewardWin
      responses:
        '200':
          description: Fulfillment successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/reversal:
    put:
      operationId: reverseRewardWin
      responses:
        '200':
          description: Reversal successful
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/void-payment:
    post:
      operationId: voidTipaltiPayment
      responses:
        '200':
          description: Payment voided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/unarchival:
    put:
      operationId: unarchiveRewardWin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/dashboard/summary:
    get:
      operationId: getSummary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSummaryResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: query
        name: fulfillmentStatus
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: isArchived
        required: false
        schema:
          type: boolean
      - in: query
        name: userFilterData
        required: false
        schema:
          type: string
      - in: query
        name: type
        required: false
        schema:
          type: string
      - in: query
        name: q
        required: false
        schema:
          type: string
      - in: query
        name: excludedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: includedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: actionGroupId
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: daysReady
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: orderField
        required: false
        schema:
          type: string
      - in: query
        name: orderDirection
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
components:
  schemas:
    ResponseMetadata:
      properties:
        limit:
          type: number
          format: double
        offset:
          type: number
          format: double
        status:
          type: string
          enum:
          - failure
          - success
        totalCount:
          type: number
          format: double
      type: object
      additionalProperties: false
    BrandDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for a brand.
        name:
          type: string
          description: Name of the brand.
        logo:
          type: string
        accentColor:
          type: string
        buttonColor:
          type: string
        associatedWithCampaign:
          type: boolean
          description: A flag indicating whether this brand has been associated with a campaign. If this is true, then this brand cannot be deleted.
    GetRewardWinGlobalUser:
      type: object
      properties: {}
    BulkActionSuccesfulInstance:
      properties:
        rewardWinId:
          type: number
          format: double
      required:
      - rewardWinId
      type: object
      additionalProperties: false
    RewardWin:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for a reward win.
        influencerId:
          type: integer
        influencerFirstName:
          type: string
        influencerLastName:
          type: string
        influencerEmail:
          type: string
        influencerAddress:
          type: string
        contactInfo:
          $ref: '#/components/schemas/MembershipContactInfoDeprecated'
        source:
          type: string
          description: How this RewardWin was generated, e.g. incentive or spot.
        incentive:
          $ref: '#/components/schemas/IncentiveDeprecated'
        rewardTitle:
          type: string
          description: Title for the associated reward.
        rewardImage:
          type: string
          description: Image of the associated reward.
        orderNumber:
          type: string
          description: For physically-fulfilled rewards, this contains the order number for tracking purposes.
        trackingNumber:
          type: string
          description: For physically-fulfilled rewards, this contains the tracking number of the order.
        comment:
          type: string
          description: Any custom comment associated with this reward win.
        verifiedAddress:
          type: boolean
          description: A flag to track whether an administrator has verified this influencer's email or postal address, depending on the delivery method of the reward.
        isFulfilled:
          type: boolean
          description: A flag informing whether this reward win has been fulfilled yet.
        isArchived:
          type: boolean
          description: A flag informing whether this reward win has been archived. An fulfilled reward win cannot be archived.
        fulfilledAt:
          type:
          - string
          - 'null'
          format: date-time
          description: If the reward win has been fulfilled, this will display the time at which fulfillment occurred.
        fulfilledBy:
          type: string
          description: If the reward win has been fulfilled, this will display the account email of the user who fulfilled it.
        fulfillmentStatus:
          type: string
        type:
          type: string
        value:
          type: number
        valueCurrencyCode:
          type: string
        cost:
          type: number
        costCurrencyCode:
          type: string
        description:
          type: string
        createdBy:
          $ref: '#/components/schemas/AdministratorDeprecated'
        lastModifiedBy:
          $ref: '#/components/schemas/AdministratorDeprecated'
        cashPayment:
          type: object
          properties:
            externalId:
              type: string
            id:
              type: integer
        giftCardOrder:
          type: object
          properties:
            externalId:
              type: string
            id:
              type: integer
        giftCardOption:
          type: object
          properties:
            id:
              type: integer
        cashPaymentApp:
          type: object
          properties:
            id:
              type: integer
            provider:
              type: string
              description: The cash payment app provider of the reward win.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        readiedAt:
          type: string
          format: date-time
        completedDate:
          type: string
          format: date-time
        actionGroup:
          $ref: '#/components/schemas/ActionGroupDeprecated'
        user:
          $ref: '#/components/schemas/GlobalUserDeprecated'
        cashPaymentAppId:
          type:
          - integer
          - 'null'
          description: ID the associated cash payment app.
        giftCardOptionId:
          type:
          - integer
          - 'null'
          description: ID the associated gift card option.
        giftCardEmailTemplateId:
          type:
          - string
          - 'null'
          description: ID the associated gift card email template (External Id).
        listMemberRewardWin:
          type: object
          properties:
            id:
              type: integer
            listMemberId:
              type: integer
            eligibleOnEventType:
              type: string
        communityId:
          type: string
          description: The communityId of the reward win.
        mostRecentTransaction:
          $ref: '#/components/schemas/PaymentsLedger'
        discountCodeId:
          type:
          - string
          - 'null'
          description: Discount ID for SHOPIFY_DISCOUNT type rewards
        discountCodeRedeemId:
          type:
          - string
          - 'null'
          description: ID of shopify transaction where a SHOPIFY_DISCOUNT was used
        shippingCodeId:
          type:
          - string
          - 'null'
          description: Shipping ID for SHOPIFY_DISCOUNT type rewards
        shippingCodeRedeemId:
          type:
          - string
          - 'null'
          description: ID of shopify transaction where a SHOPIFY_DISCOUNT shipping code was used
        couponActivation:
          type:
          - string
          - 'null'
          description: Coupon Activation for SHOPIFY_DISCOUNT type rewards
        incentiveId:
          type:
          - string
          - 'null'
          description: The incentive ID associated with the reward win if used.
        invoiceNumber:
          type:
          - string
          - 'null'
          description: Invoice number for the reward win
        taxId:
          type:
          - string
          - 'null'
          description: Tax ID for the reward win
        bonusTierCurrencyCode:
          type:
          - string
          - 'null'
        bonusTiers:
          type:
          - array
          - 'null'
          description: Sorted tiered bonus payout ladder
          items:
            $ref: '#/components/schemas/BonusTier'
        attainedBonusTierIndex:
          type:
          - integer
          - 'null'
          description: Zero-based index of the tier attained when this reward win was fulfilled
        taxLineItems:
          type:
          - array
          - 'null'
          items:
            type: object
            properties:
              type:
                type: string


# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-rewardwins-api-openapi.yml