Incentivio

Incentivio Store Controller API

The store-controller API from Incentivio — 13 operation(s) for store-controller.

GitHub OpenAPI

Operations 15

PUT /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{storeid} #
DELETE /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{storeid} #
POST /incentivio-client-domain/reach/display #
GET /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores #
POST /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores #
GET /incentivio-client-domain/clients/{clientid}/storetypes #
GET /incentivio-client-domain/clients/{clientid}/stores #
GET /incentivio-client-domain/clients/{clientid}/stores/{identifier} #
GET /incentivio-client-domain/clients/{clientid}/reach #
GET /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{identifier} #
GET /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/admins/{adminid}/stores #
GET /incentivio-client-domain/clients/{clientid}/all/stores #
GET /incentivio-client-domain/clients/all/stores #
GET /incentivio-client-domain/admin/stores #
GET /incentivio-client-domain/admin/stores/overall #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/authentication/incentivio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/openapi/incentivio-store-controller-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/conventions/incentivio-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/errors/incentivio-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/data-model/incentivio-data-model.yml
🔗
WellKnown
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/well-known/incentivio-well-known.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/incentivio-store-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

incentivio-store-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Store Controller API
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
tags:
- name: store-controller
paths:
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{storeid}:
    put:
      tags:
      - store-controller
      operationId: updateStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStoreRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - store-controller
      operationId: deleteStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/reach/display:
    post:
      tags:
      - store-controller
      operationId: readReachDisplayInfo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReachStringDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByMerchant
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
    post:
      tags:
      - store-controller
      operationId: createStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStoreRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateStoreResponseDTO'
  /incentivio-client-domain/clients/{clientid}/storetypes:
    get:
      tags:
      - store-controller
      operationId: listStoreTypeByClientId
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoreTypesResponseDTO'
  /incentivio-client-domain/clients/{clientid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByClient
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: latitude
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: longitude
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: radius
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      - name: iscatering
        in: query
        required: false
        schema:
          type: boolean
      - name: ismenubrowsing
        in: query
        required: false
        schema:
          type: boolean
      - name: istest
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
  /incentivio-client-domain/clients/{clientid}/stores/{identifier}:
    get:
      tags:
      - store-controller
      operationId: readStoreByClientAndIdentifier
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      - name: idtype
        in: query
        required: false
        schema:
          type: string
          default: id
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StoreDTO'
  /incentivio-client-domain/clients/{clientid}/reach:
    get:
      tags:
      - store-controller
      operationId: readClientReachString
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{identifier}:
    get:
      tags:
      - store-controller
      operationId: readStoreByMerchantAndIdentifier
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: identifier
        in: path
        required: true
        schema:
          type: string
      - name: idtype
        in: query
        required: false
        schema:
          type: string
          default: id
      - name: langCode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StoreDTO'
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/admins/{adminid}/stores:
    get:
      tags:
      - store-controller
      operationId: searchStoreByAdmin
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: count
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: sortby
        in: query
        required: false
        schema:
          type: string
          default: title
      - name: sortdirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: title
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindStoresResponseDTO'
  /incentivio-client-domain/clients/{clientid}/all/stores:
    get:
      tags:
      - store-controller
      operationId: listStoreByClientId
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAllStoresResponseDTO'
  /incentivio-client-domain/clients/all/stores:
    get:
      tags:
      - store-controller
      operationId: listStore
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAllStoresResponseDTO'
  /incentivio-client-domain/admin/stores:
    get:
      tags:
      - store-controller
      operationId: listStoresForAdmin
      parameters:
      - name: excludenames
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminStoresResponseDTO'
  /incentivio-client-domain/admin/stores/overall:
    get:
      tags:
      - store-controller
      operationId: listStoresForAdminOverall
      parameters:
      - name: excludenames
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminStoresResponseDTO'
components:
  schemas:
    CreateStoreResponseDTO:
      type: object
      properties:
        storeId:
          type: string
    CreateStoreRequestDTO:
      type: object
      properties:
        title:
          type: string
        regionId:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
      required:
      - title
    FindAdminStoresResponseDTO:
      type: object
      properties:
        stores:
          type: array
          items:
            $ref: '#/components/schemas/AdminStoreDTO'
    UpdateStoreRequestDTO:
      type: object
      properties:
        title:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        regionId:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
        regionEmpty:
          type: boolean
    StoreTypeDTO:
      type: object
      properties:
        storeTypeId:
          type: string
        type:
          type: string
        description:
          type: string
    FindAllStoresResponseDTO:
      type: object
      properties:
        stores:
          type: array
          items:
            $ref: '#/components/schemas/StoreDTO'
    Direction:
      type: string
      enum:
      - ASC
      - DESC
    FindStoreTypesResponseDTO:
      type: object
      properties:
        storeTypes:
          type: array
          items:
            $ref: '#/components/schemas/StoreTypeDTO'
    StoreDTO:
      type: object
      properties:
        storeId:
          type: string
        title:
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        regionId:
          type: string
        storeCode:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        storeType:
          type: string
        beaconId:
          type: string
        beaconName:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        displayInfo:
          type: array
          items:
            $ref: '#/components/schemas/StoreDisplayInfo'
          uniqueItems: true
        isCatering:
          type: boolean
        isMenuBrowsing:
          type: boolean
        viewOnlyLocationEnabled:
          type: boolean
        isTest:
          type: boolean
    PagingDto:
      type: object
      properties:
        count:
          type: integer
          format: int32
        currentPage:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    StoreDisplayInfo:
      type: object
      properties:
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
    AdminStoreDTO:
      type: object
      properties:
        storeId:
          type: string
        merchantId:
          type: string
        title:
          type: string
    FindStoresResponseDTO:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingDto'
        stores:
          type: array
          items:
            $ref: '#/components/schemas/StoreDTO'
    AddressDTO:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        postalCode:
          type: string
        region:
          type: string
        streetAddress1:
          type: string
        streetAddress2:
          type: string
    ReachStringDTO:
      type: object
      properties:
        reach:
          type: string