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/flipdish:flipdish-lightspeed-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Flipdish Lightspeed API
  version: v1.0
  x-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-last-validated differs across the merged source definitions and was not carried
  description: 'Operations tagged Lightspeed across 2 of this provider''s published API definitions: flipdish-openapi.json, flipdish-platform-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.flipdish.co
tags:
- name: Lightspeed
paths:
  /api/v1.0/lightspeed/{storeId}/settings:
    get:
      tags:
      - Lightspeed
      operationId: Lightspeed_GetStoreSettings
      parameters:
      - name: storeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
        '404':
          description: NotFound
      security:
      - oauth2:
        - api
      summary: Lightspeed get store settings
      x-summary-source: derived
    post:
      tags:
      - Lightspeed
      operationId: Lightspeed_SaveStoreSettings
      parameters:
      - name: storeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_LightspeedSettings'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LightspeedSettings'
          text/json:
            schema:
              $ref: '#/components/schemas/LightspeedSettings'
          application/xml:
            schema:
              $ref: '#/components/schemas/LightspeedSettings'
          text/xml:
            schema:
              $ref: '#/components/schemas/LightspeedSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LightspeedSettings'
        required: true
      summary: Lightspeed save store settings
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
  /api/v1.0/lightspeed/{storeId}/menu/generate:
    post:
      tags:
      - Lightspeed
      operationId: Lightspeed_GenerateMenu
      parameters:
      - name: storeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiErrorResult'
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiUnauthorizedResult'
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiForbiddenResult'
      security:
      - oauth2:
        - api
      summary: Lightspeed generate menu
      x-summary-source: derived
    servers:
    - url: https://api.flipdish.co
components:
  schemas:
    RestApiForbiddenResult:
      description: Rest Api Forbidden Result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    LightspeedSettings:
      description: Ligthspeed store settings
      type: object
      properties:
        CompanyId:
          description: Company Id
          type: string
        UseOAuth:
          description: Use OAuth for authentication
          type: boolean
        Enabled:
          description: Enabled
          type: boolean
        EstimatedMinutesForDelivery:
          format: int32
          description: Estimated minutes for delivery
          type: integer
        EstimatedMinutesForCollection:
          format: int32
          description: Estimated minutes for collection
          type: integer
        GeographicLocation:
          description: Geographic location (euc1, nae1, euw2, ....))
          type: string
        Establishment:
          description: Is the CompanyId an establishment (kind of the store of a group of store)
          type: boolean
        VoucherId:
          description: The Lightspeed voucher identifier to map with our
          type: string
        DeliveryFeeId:
          description: The Lightspeed delivery fee identifier to map with our
          type: string
        ProcessingFeeId:
          description: The Lightspeed processing fee identifier to map with our
          type: string
        PriceType:
          description: Which price to choose from Lightspeed menu
          enum:
          - Default
          - Takeaway
          - Delivery
          - null
          type:
          - string
          - 'null'
        MenuId:
          format: int32
          description: The menu id of the store
          type: integer
        CollectionTableId:
          format: int32
          description: Collection Table ID to send orders
          type:
          - integer
          - 'null'
        DeliveryTableId:
          format: int32
          description: Delivery Table ID to send orders
          type:
          - integer
          - 'null'
        CollectionTableIds:
          description: Collection Table IDs to send orders to
          type: object
          additionalProperties:
            type: string
        DeliveryTableIds:
          description: Delivery Table IDs to send orders to
          type: object
          additionalProperties:
            type: string
        UseTaxInclusivePrices:
          description: Exclude tax
          type: boolean
        SkipStatusCheckAndAcceptOrderAfterSending:
          description: 'WARNING: only use this option if the Liteserver is not synchronizing within max 5 minutes with Lightspeed cloud!'
          type: boolean
        SendTableNumberToTableId:
          description: Send Table Number to Table Id
          type: boolean
        AddChefNoteToProduct:
          description: Add ChefNote To Product
          type: boolean
        ChefNoteItemId:
          description: The Lightspeed Chef Note Item Id to map
          type: string
        ChefNoteModifierId:
          description: The Lightspeed Chef Note Modifier Id to map
          type: string
        ServiceChargeId:
          description: The Lightspeed Service Charge Id to map
          type: string
    RestApiUnauthorizedResult:
      description: Rest api unauthorized result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    RestApiResult_LightspeedSettings:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/LightspeedSettings'
          description: Generic data object.
    ValidationErrorResult:
      description: Validation error result
      type: object
      properties:
        FieldName:
          description: Field name
          type: string
        Errors:
          description: List of errors relates to field
          type: array
          items:
            type: string
    RestApiErrorResult:
      description: Rest api error result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Error message
          type: string
        ErrorCode:
          format: int32
          description: Error code
          type: integer
        StackTrace:
          description: Stack trace
          type: string
        Errors:
          description: List of errors grouped by field name
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorResult'
    RestApiResult_LightspeedSettings_:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/LightspeedSettings_2'
    LightspeedSettings_2:
      description: Ligthspeed store settings
      type: object
      properties:
        CompanyId:
          description: Company Id
          type: string
          example: '500123'
        UseOAuth:
          description: Use OAuth for authentication
          type: boolean
          example: true
        Enabled:
          description: Enabled
          type: boolean
          example: true
        EstimatedMinutesForDelivery:
          format: int32
          description: Estimated minutes for delivery
          type: integer
          example: 1
        EstimatedMinutesForCollection:
          format: int32
          description: Estimated minutes for collection
          type: integer
          example: 1
        GeographicLocation:
          description: Geographic location (euc1, nae1, euw2, ....))
          type: string
          example: string
        Establishment:
          description: Is the CompanyId an establishment (kind of the store of a group of store)
          type: boolean
          example: true
        VoucherId:
          description: The Lightspeed voucher identifier to map with our
          type: string
          example: '500123'
        DeliveryFeeId:
          description: The Lightspeed delivery fee identifier to map with our
          type: string
          example: '500123'
        ProcessingFeeId:
          description: The Lightspeed processing fee identifier to map with our
          type: string
          example: '500123'
        PriceType:
          description: Which price to choose from Lightspeed menu
          enum:
          - Default
          - Takeaway
          - Delivery
          - null
          type:
          - string
          - 'null'
          example: Default
        MenuId:
          format: int32
          description: The menu id of the store
          type: integer
          example: 500123
        CollectionTableId:
          format: int32
          description: Collection Table ID to send orders
          type:
          - integer
          - 'null'
          example: 500123
        DeliveryTableId:
          format: int32
          description: Delivery Table ID to send orders
          type:
          - integer
          - 'null'
          example: 500123
        CollectionTableIds:
          description: Collection Table IDs to send orders to
          type: object
          additionalProperties:
            type: string
        DeliveryTableIds:
          description: Delivery Table IDs to send orders to
          type: object
          additionalProperties:
            type: string
        UseTaxInclusivePrices:
          description: Exclude tax
          type: boolean
          example: true
        SkipStatusCheckAndAcceptOrderAfterSending:
          description: 'WARNING: only use this option if the Liteserver is not synchronizing within max 5 minutes with Lightspeed cloud!'
          type: boolean
          example: true
        SendTableNumberToTableId:
          description: Send Table Number to Table Id
          type: boolean
          example: true
        AddChefNoteToProduct:
          description: Add ChefNote To Product
          type: boolean
          example: true
        ChefNoteItemId:
          description: The Lightspeed Chef Note Item Id to map
          type: string
          example: '500123'
        ChefNoteModifierId:
          description: The Lightspeed Chef Note Modifier Id to map
          type: string
          example: '500123'
        ServiceChargeId:
          description: The Lightspeed Service Charge Id to map
          type: string
          example: '500123'
    FlipdishError:
      type: object
      description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).
      properties:
        error:
          type: object
          description: Error detail object.
          properties:
            errorMessage:
              type: string
              description: Descriptive explanation of the issue.
              example: Invalid or missing parameters.
            errorCode:
              type: string
              description: Unique identifier for programmatic error handling.
              example: BadRequest
            details:
              type: string
              description: Additional context returned in non-production environments.
              example: Validation failed for field 'storeId'.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            api: Access to Flipdish API
          authorizationUrl: https://api.flipdish.co/identity/connect/authorize
      description: OAuth2 Implicit Grant
x-refined-from:
- flipdish-openapi.json
- flipdish-platform-openapi.json