Flipdish Address API

openapi: 3.2.0
info:
  version: v1.0
  title: Flipdish Open API v1.0 Address API
servers:
- url: https://api.flipdish.co
tags:
- name: Address
paths:
  /api/v1.0/address/countries:
    get:
      tags:
      - Address
      operationId: GetCountries
      parameters:
      - name: language
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_CountryFormResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_CountryFormResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_CountryFormResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_CountryFormResponse'
        '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: Get countries
      x-summary-source: derived
  /api/v1.0/app/{appId}/address/form:
    get:
      tags:
      - Address
      operationId: FormByApp
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: language
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
        '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: Form by app
      x-summary-source: derived
  /api/v1.0/address/country/{countryCode}/form:
    get:
      tags:
      - Address
      operationId: FormByCountry
      parameters:
      - name: countryCode
        in: path
        required: true
        schema:
          type: string
      - name: language
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
        '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: Form by country
      x-summary-source: derived
  /api/v1.0/address/templates:
    post:
      tags:
      - Address
      operationId: AddressTemplates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiStringResult'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiStringResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiStringResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiStringResult'
        '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/StoreAddressForm'
          text/json:
            schema:
              $ref: '#/components/schemas/StoreAddressForm'
          application/xml:
            schema:
              $ref: '#/components/schemas/StoreAddressForm'
          text/xml:
            schema:
              $ref: '#/components/schemas/StoreAddressForm'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/StoreAddressForm'
        required: true
      summary: Address templates
      x-summary-source: derived
  /api/v1.0/address/google:
    post:
      tags:
      - Address
      operationId: FormatGoogleAddress
      parameters:
      - name: language
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestApiResult_AddressFormResponse'
        '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/GoogleAddress'
          text/json:
            schema:
              $ref: '#/components/schemas/GoogleAddress'
          application/xml:
            schema:
              $ref: '#/components/schemas/GoogleAddress'
          text/xml:
            schema:
              $ref: '#/components/schemas/GoogleAddress'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GoogleAddress'
        required: true
      summary: Format google address
      x-summary-source: derived
components:
  schemas:
    AddressFormDisplayFormat:
      type: object
      properties:
        OneLine:
          type: string
        TwoLines:
          type: array
          items:
            type: string
    RestApiUnauthorizedResult:
      description: Rest api unauthorized result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    AddressFormResponse:
      description: A response of a dyanmic form definition.
      type: object
      properties:
        FormData:
          description: List of field definitions.
          type: array
          items:
            $ref: '#/components/schemas/DynamicFormField'
        CountryCode:
          description: ISO two letter code.
          type: string
        Language:
          description: ISO culture code.
          type: string
        DisplayFormat:
          $ref: '#/components/schemas/AddressFormDisplayFormat'
          description: Templates used to format form fields when displaying items in a list.
    StoreAddressForm:
      description: Address form payload.
      required:
      - AddressFields
      - CountryCode
      type: object
      properties:
        AddressFields:
          description: The dynamic fields generated by the address form.
          type: object
          additionalProperties:
            type: object
        CountryCode:
          description: ISO 2 letters code for the country, should be the same as the form that generates the fields.
          type: string
    GoogleCoordinates:
      type: object
      properties:
        Lat:
          format: float
          type: number
        Lng:
          format: float
          type: number
    RestApiResult_CountryFormResponse:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/CountryFormResponse'
          description: Generic data object.
    DynamicFormField:
      type: object
      properties:
        Identifier:
          type: string
        Label:
          type: string
        Placeholder:
          type: string
        Rules:
          $ref: '#/components/schemas/DynamicFormRules'
        Mapping:
          type: object
          additionalProperties:
            type: string
        Modifiers:
          type: array
          items:
            type: string
        Value:
          type: object
        Scopes:
          type: string
    DynamicFormRule:
      type: object
      properties:
        Value:
          type: object
        Message:
          type: string
        Scopes:
          type: string
    RestApiResult_AddressFormResponse:
      description: Rest api result
      required:
      - Data
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/AddressFormResponse'
          description: Generic data object.
    DynamicFormRules:
      type: object
      properties:
        MaxLength:
          $ref: '#/components/schemas/DynamicFormRule'
        MinLength:
          $ref: '#/components/schemas/DynamicFormRule'
        Required:
          $ref: '#/components/schemas/DynamicFormRule'
        Pattern:
          $ref: '#/components/schemas/DynamicFormRule'
        Predefined:
          type: array
          items:
            $ref: '#/components/schemas/DynamicFormFieldOption'
    GoogleLocation:
      type: object
      properties:
        Lat:
          format: float
          type: number
        Lng:
          format: float
          type: number
    DynamicFormFieldOption:
      type: object
      properties:
        Display:
          type: string
        Value:
          type: string
    GoogleAddressResult:
      type: object
      properties:
        Address_components:
          type: array
          items:
            $ref: '#/components/schemas/GoogleAddressComponent'
        Formatted_address:
          type: string
        Geometry:
          $ref: '#/components/schemas/GoogleGeometry'
        Place_id:
          type: string
        Types:
          type: array
          items:
            type: string
    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
    GoogleAddress:
      type: object
      properties:
        Results:
          type: array
          items:
            $ref: '#/components/schemas/GoogleAddressResult'
        Result:
          $ref: '#/components/schemas/GoogleAddressResult'
        Status:
          type: string
    RestApiForbiddenResult:
      description: Rest Api Forbidden Result
      required:
      - Message
      type: object
      properties:
        Message:
          description: Message
          type: string
          readOnly: true
    GoogleViewport:
      type: object
      properties:
        Northeast:
          $ref: '#/components/schemas/GoogleCoordinates'
        Southwest:
          $ref: '#/components/schemas/GoogleCoordinates'
    GoogleAddressComponent:
      type: object
      properties:
        Long_name:
          type: string
        Short_name:
          type: string
        Types:
          type: array
          items:
            type: string
    CountryFormResponse:
      description: Country
      type: object
      properties:
        Value:
          description: ISO two letter code.
          type: string
        Label:
          description: Label
          type: string
    GoogleGeometry:
      type: object
      properties:
        Location:
          $ref: '#/components/schemas/GoogleLocation'
        Location_type:
          type: string
        Viewport:
          $ref: '#/components/schemas/GoogleViewport'
    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'
    RestApiStringResult:
      description: Rest api string result
      required:
      - Data
      type: object
      properties:
        Data:
          description: Data string
          type: string
  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-samples-languages:
- curl
- node
- csharp
- ruby
- javascript
- python
- swift
x-send-defaults: true
x-flipdish-signalr:
- hubName: AnalyticsHub
  events:
  - eventName: analytics.website
    eventType: AnalyticsClientEvent
- hubName: AppHub
  events:
  - eventName: app.created
    eventType: AppCreatedEvent
  - eventName: app.updated
    eventType: AppUpdatedEvent
- hubName: AuthorizationHub
  events: []
- hubName: BankAccountHub
  events:
  - eventName: bankaccount.created
    eventType: BankAccountCreatedEvent
  - eventName: bankaccount.updated
    eventType: BankAccountUpdatedEvent
  - eventName: bankaccount.deleted
    eventType: BankAccountDeletedEvent
- hubName: CampaignHub
  events: []
- hubName: CardReaderHub
  events:
  - eventName: cardreaders.kiosk.bluetooth.initiatepairingmode
    eventType: KioskBluetoothPairingModeEvent
  - eventName: cardreaders.kiosk.bluetooth.unpaired
    eventType: KioskBluetoothTerminalUnpairedEvent
  - eventName: cardreaders.kiosk.bluetooth.updated
    eventType: KioskBluetoothTerminalUpdatedEvent
  - eventName: cardreaders.kiosk.bluetooth.checkforupdates
    eventType: KioskBluetoothTerminalInitiateUpdateCheckEvent
  - eventName: cardreaders.kiosk.bluetooth.initiateinstallupdatemode
    eventType: KioskBluetoothInstallUpdateInitiateEvent
  - eventName: cardreaders.kiosk.bluetooth.cancelupdateinstall
    eventType: KioskBluetoothTerminalCancelUpdateEvent
  - eventName: cardreaders.kiosk.bluetooth.installationstatus
    eventType: KioskBluetoothTerminalInstallationStatusEvent
  - eventName: cardreaders.kiosk.bluetooth.firmwareupdateversion
    eventType: KioskBluetoothTerminalFirmwareVersionStatusEvent
  - eventName: cardreaders.kiosk.bluetooth.terminalactionstatechanged
    eventType: KioskTerminalActionStateChangedEvent
- hubName: ChannelHub
  events: []
- hubName: CustomerHub
  events:
  - eventName: customer.created
    eventType: CustomerCreatedEvent
  - eventName: customer.updated
    eventType: CustomerUpdatedEvent
  - eventName: customer.consent.updated
    eventType: CustomerConsentUpdatedEvent
- hubName: HydraHub
  events:
  - eventName: hydra.assigned
    eventType: HydraAssignedEvent
  - eventName: hydra.request_reset
    eventType: HydraRequestResetEvent
  - eventName: hydra.setting_changed
    eventType: HydraSettingChangedEvent
  - eventName: hydra.conection_status_changed
    eventType: HydraConnectionStatusChangedEvent
  - eventName: hydra.unassigned
    eventType: HydraUnAssignedEvent
  - eventName: hydra.store.assigned
    eventType: HydraStoreAssignedEvent
  - eventName: hydra.store.unassigned
    eventType: HydraStoreUnassignedEvent
- hubName: MenuCheckpointHub
  events: []
- hubName: MenuHub
  events: []
- hubName: OrderHub
  events:
  - eventName: order.created
    eventType: OrderCreatedEvent
  - eventName: order.rejected
    eventType: OrderRejectedEvent
  - eventName: order.accepted
    eventType: OrderAcceptedEvent
  - eventName: order.refunded
    eventType: OrderRefundedEvent
- hubName: PhoneCallHub
  events: []
- hubName: PrinterHub
  events: []
- hubName: StoreGroupHub
  events:
  - eventName: store_group.created
    eventType: StoreGroupCreatedEvent
  - eventName: store_group.updated
    eventType: StoreGroupUpdatedEvent
  - eventName: store_group.deleted
    eventType: StoreGroupDeletedEvent
- hubName: StoreHub
  events:
  - eventName: store.created
    eventType: StoreCreatedEvent
  - eventName: store.updated
    eventType: StoreUpdatedEvent
  - eventName: store.archived
    eventType: StoreArchivedEvent
  - eventName: store.unarchived
    eventType: StoreUnarchivedEvent
  - eventName: store.published
    eventType: StorePublishedEvent
  - eventName: store.unpublished
    eventType: StoreUnpublishedEvent
  - eventName: store.deleted
    eventType: StoreDeletedEvent
  - eventName: store.address.updated
    eventType: StoreAddressUpdatedEvent
  - eventName: store.opening_hours.updated
    eventType: StoreOpeningHoursUpdatedEvent
  - eventName: store.menu.assigned
    eventType: StoreMenuAssignedEvent
  - eventName: store.delivery_zone.created
    eventType: DeliveryZoneCreatedEvent
  - eventName: store.delivery_zone.updated
    eventType: DeliveryZoneUpdatedEvent
  - eventName: store.delivery_zone.deleted
    eventType: DeliveryZoneDeletedEvent
  - eventName: store_group.created
    eventType: StoreGroupCreatedEvent
  - eventName: store_group.updated
    eventType: StoreGroupUpdatedEvent
  - eventName: store_group.deleted
    eventType: StoreGroupDeletedEvent
  - eventName: store.business_hours_override.created
    eventType: StoreBusinessHoursOverrideCreatedEvent
  - eventName: store.business_hours_override.deleted
    eventType: StoreBusinessHoursOverrideDeletedEvent
  - eventName: store.preorder_config.updated
    eventType: StorePreOrderConfigUpdatedEvent
  - eventName: store.logo.created
    eventType: StoreLogoCreatedEvent
  - eventName: store.logo.updated
    eventType: StoreLogoUpdatedEvent
  - eventName: store.logo.deleted
    eventType: StoreLogoDeletedEvent
  - eventName: store.kiosk_setting.updated
    eventType: StoreKioskSettingUpdatedEvent
  - eventName: store.fee_config.updated
    eventType: StoreFeeConfigUpdatedEvent
- hubName: TeammateHub
  events:
  - eventName: teammate.invite.sent
    eventType: TeammateInviteSentEvent
  - eventName: teammate.invite.accepted
    eventType: TeammateInviteAcceptedEvent
  - eventName: teammate.updated
    eventType: TeammateUpdatedEvent
  - eventName: teammate.deleted
    eventType: TeammateDeletedEvent
- hubName: TelephonyConfigHub
  events: []
- hubName: VoucherHub
  events:
  - eventName: voucher.created
    eventType: VoucherCreatedEvent
  - eventName: voucher.deleted
    eventType: VoucherDeletedEvent
  - eventName: voucher.updated
    eventType: VoucherUpdatedEvent
  - eventName: voucher.applied
    eventType: VoucherAppliedEvent
- hubName: WebhookHub
  events: []
- hubName: WebsiteHub
  events: []