mktp.yaml

swagger: '2.0'
schemes:
  - https
host: https://marketplace.test.4all.com
basePath: /mktplace/v1"
info:
  description: |
    Essa documentação foi gerada pelo JAXRS analyser
    e posteriormente editada manualmente.
  version: 0.0.1
  title: Marketplace
  contact:
    email: luis.alves@4all.com
    url: https://marketplace.test.4all.com
  x-logo:
    url: https://4all.com/wp-content/themes/bones/library/images/logotipo.png
tags:
  - name: unities
    description: Listagem de estabelecimentos
  - name: groupTrees
    description: Lista de categorias
  - name: vouchers
    description: Lista de vouchers
x-tagGroups:
  - name: Unity
    tags:
      - unities
      - vouchers
  - name: GroupTree
    tags:
      - groupTrees
x-servers:
  - url: //marketplace.test.4all.com/mktplace/v1
    description: Marketplace homologação
paths:
  '/unities':
    get:
      tags:
        - unities
      sumary: Lista estabelecimentos
      description: Lista estabelecimentos baseado em parâmetros.
      produces:
      - application/json
      parameters:
      - type: string
        name: Authorization
        in: header
        required: true
      - type: boolean
        name: banner
        in: query
        required: false
      - type: string
        name: cep
        in: query
        required: false
      - type: string
        name: city
        in: query
        required: false
      - type: string
        name: cnpj
        in: query
        required: false
      - type: number
        name: distance
        in: query
        required: false
      - type: number
        name: lat
        in: query
        required: false
      - type: integer
        name: limit
        in: query
        required: false
      - type: number
        name: lon
        in: query
        required: false
      - type: string
        name: neighborhood
        in: query
        required: false
      - type: boolean
        name: onlyActiveUnity
        in: query
        required: false
      - type: string
        name: state
        in: query
        required: false
      - type: string
        name: style
        in: query
        required: false
      - type: array
        name: unityTypeId
        in: query
        required: false
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Unity'
  '/groupTrees':
    get:
      tags:
        - groupTrees
      sumary: Lista categorias
      description: Lista todas as categorias.
      produces:
      - application/json
      parameters:
      - name: Authorization
        type: string
        in: header
        required: true
      - name: parentId
        type: integer
        in: query
        required: false
      - name: unityId
        type: integer
        in: query
        required: false
      - name: onlyActiveUnity
        type: boolean
        in: query
        required: false
      - name: state
        type: string
        in: query
        required: false
      - name: city
        type: string
        in: query
        required: false
      - name: style
        type: string
        in: query
        required: false
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/GroupTree'
  '/vouchers':
    get:
      tags:
        - vouchers
      sumary: Lista vouchers
      description: Lista os vouchers de um usuário.
      produces:
      - application/json
      parameters:
      - name: Authorization
        type: string
        in: header
        required: true
      - name: sessionToken
        description: sessionToken da conta 4all
        type: string
        in: query
        required: true
      - name: transactionId
        type: string
        in: query
        required: false
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Voucher'
  '/unities/{idUnity}/vouchers':
    get:
      tags:
        - vouchers
      sumary: Lista vouchers
      description: Lista os vouchers de um estabelecimento.
      produces:
      - application/json
      parameters:
      - name: Authorization
        type: string
        in: header
        required: true
      - name: idUnity
        type: integer
        in: path
        required: true
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Voucher'
definitions:
  Unity:
    properties:
      active:
        type: boolean
      address:
        type: string
      authKeyAll4Mobile:
        type: string
      children:
        type: array
        items:
          "$ref": "#/definitions/UnityShort"
      cnpj:
        type: string
      codename:
        type: string
      deliveryEstimatedIdUnitTime:
        type: integer
      deliveryEstimatedTime:
        type: integer
      desc:
        type: string
      discount:
        type: integer
      discountType:
        type: string
      distance:
        type: number
      eventEnabled:
        type: boolean
      facebookUrl:
        type: string
      favorite:
        type: boolean
      fidelity:
        "$ref": "#/definitions/Fidelity"
      forceClosed:
        type: boolean
      fourPayEnabled:
        type: boolean
      id:
        type: integer
      idIndoorMapLuc:
        type: integer
      idIntegrationSystem:
        type: integer
      idParent:
        type: integer
      idStoreAll4Mobile:
        type: string
      idStoreIntegrationSystem:
        type: string
      idSupportedCity:
        type: integer
      idUnityType:
        type: integer
      immediateScheduling:
        type: boolean
      indoorMapLuc:
        "$ref": "#/definitions/IndoorMapLuc"
      instagramUrl:
        type: string
      keywords:
        type: string
      latitude:
        type: number
      longitude:
        type: number
      marketplaces:
        type: array
        items:
          "$ref": "#/definitions/Marketplace"
      media:
        type: array
        items:
          "$ref": "#/definitions/Media"
      merchantKey:
        type: string
      name:
        type: string
      nfeBackup:
        type: boolean
      opened:
        type: boolean
      orderCheckEnabled:
        type: boolean
      orderDeliveryEnabled:
        type: boolean
      orderEnabled:
        type: boolean
      orderInStoreEnabled:
        type: boolean
      orderShortDeliveryEnabled:
        type: boolean
      orderShortTakeAwayEnabled:
        type: boolean
      orderTakeAwayEnabled:
        type: boolean
      orderVoucherEnabled:
        type: boolean
      paymentMethods:
        type: array
        items:
          "$ref": "#/definitions/PaymentMethod"
      phoneNumber:
        type: string
      portalUnicoIntegrated:
        type: boolean
      portalUnicoIntegratedTimestamp:
        type: object
      schedulingEnabled:
        type: boolean
      shifts:
        type: array
        items:
          "$ref": "#/definitions/UnityShift"
      siteUrl:
        type: string
      soon:
        type: boolean
      splitVoucher:
        type: boolean
      tableBookingEnabled:
        type: boolean
      takeAwayEstimatedIdUnitTime:
        type: integer
      takeAwayEstimatedTime:
        type: integer
      twitterUrl:
        type: string
      unityMerchantEstablishmentId:
        type: integer
      unityOperatingHourGroups:
        type: array
        items:
          "$ref": "#/definitions/UnityOperatingHourGroup"
      unityTypeName:
        type: string
      voucherTerms:
        "$ref": "#/definitions/VoucherTermsDTO"
      waitListEnabled:
        type: boolean
  UnityShort:
    properties:
      address:
        type: string
      desc:
        type: string
      id:
        type: integer
      name:
        type: string
  Fidelity:
    properties:
      active:
        type: boolean
      contentType:
        type: string
      desc:
        type: string
      extension:
        type: string
      id:
        type: integer
      idUnity:
        type: integer
      intervalStamp:
        type: integer
      minimumAmount:
        type: integer
      terms:
        type: string
      thumb:
        type: string
      totalStamp:
        type: integer
      winningDesc:
        type: string        
  IndoorMapLuc:
    properties:
      about:
        type: string
      description:
        type: string
      id:
        type: integer
      idIndoorMapLevel:
        type: integer
      idMarketPlace:
        type: integer
      luc:
        type: string
      pointX:
        type: number
      pointY:
        type: number
      title:
        type: string
  Marketplace:
    properties:
      androidMinVersionGastronomyModule:
        type: integer
      codename:
        type: string
      document:
        type: string
      id:
        type: integer
      iosMinVersionGastronomyModule:
        type: integer
      name:
        type: string
      subscriptionMerchantKey:
        type: string
      wpsKey:
        type: string
      wpsMerchantKey:
        type: string
      wpsUrl:
        type: string
  Media:
    properties:
      contentType:
        type: string
      extension:
        type: string
      id:
        type: integer
      idMediaContext:
        type: integer
      idMediaType:
        type: integer
      mediaContextName:
        type: string
      mediaTypeName:
        type: string
      value:
        type: string
  PaymentMethod:
    properties:
      brands:
        type: array
        items:
          "$ref": "#/definitions/Brand"
      id:
        type: integer
      name:
        type: string
  Brand:
    properties:
      codename:
        type: string
      id:
        type: integer
      name:
        type: string
      thumb:
        type: string
  UnityShift:
    properties:
      dayOfWeek:
        type: string
      endAt:
        type: string
      id:
        type: integer
      idUnity:
        type: integer
      startAt:
        type: string
  UnityOperatingHourGroup:
    properties:
      daysOfWeek:
        type: integer
      id:
        type: integer
      idOrderType:
        type: integer
      idUnity:
        type: integer
      name:
        type: string
      shifts:
        type: array
        items:
          "$ref": "#/definitions/OperatingHourGroupShift"
  OperatingHourGroupShift:
    properties:
      begin:
        type: timestamp
      end:
        type: timestamp
      id:
        type: integer
      idUnityOperatingHourGroup:
        type: integer
  VoucherTermsDTO:
    properties:
      desc:
        type: string
      id:
        type: integer
      idUnity:
        type: integer
      terms:
        type: array
        items:
          "$ref": "#/definitions/VoucherTermsUrl"
      title:
        type: string
  VoucherTermsUrl:
    properties:
      id:
        type: integer
      idVoucherTerms:
        type: integer
      title:
        type: string
      url:
        type: string
  GroupTree:
    properties:
      children:
        type: array
        items:
          "$ref": "#/definitions/GroupTree"
      contentType:
        type: string
      extension:
        type: string
      groupTreeTypeName:
        type: string
      id:
        type: integer
      idGroupTreeType:
        type: integer
      idMarketplace:
        type: integer
      name:
        type: string
      parentId:
        type: integer
      thumb:
        type: string
      unities:
        type: array
        items:
          "$ref": "#/definitions/Unity"
  Voucher:
    properties:
      customer4all:
        "$ref": "#/definitions/Customer4all"
      desc:
        type: string
      expires:
        type: boolean
      fact:
        "$ref": "#/definitions/Fact"
      fidelity:
        "$ref": "#/definitions/FidelityShort"
      id:
        type: integer
      id4all:
        type: string
      idTransaction4all:
        type: string
      idUserEmailReader:
        type: string
      idVoucherStatus:
        type: integer
      idVoucherType:
        type: integer
      order:
        "$ref": "#/definitions/Order"
      phoneNumber:
        type: string
      sessionToken:
        type: string
      ticket:
        "$ref": "#/definitions/Ticket"
      timestamp:
        type: object
      timestampExpiration:
        type: object
      timestampUsed:
        type: object
      title:
        type: string
      unity:
        "$ref": "#/definitions/Unity"
      uuid:
        type: string
  Customer4all:
    properties:
      cpf:
        type: string
      emailAddress:
        type: string
      id4all:
        type: string
      name:
        type: string
      phoneNumber:
        type: string
  Fact:
    properties:
      active:
        type: boolean
      address:
        type: string
      batches:
        type: array
        items:
          "$ref": "#/definitions/Batch"
      contentType:
        type: string
      desc:
        type: string
      extension:
        type: string
      factTypeId:
        type: integer
      hasVoucher:
        type: boolean
      id:
        type: integer
      idMarketplace:
        type: integer
      idUnity:
        type: integer
      labelLink:
        type: string
      position:
        type: integer
      qrRead:
        type: boolean
      season:
        type: boolean
      subtitle:
        type: string
      terms:
        type: string
      thumb:
        type: string
      timestampBegin:
        type: object
      timestampBeginStr:
        type: string
      timestampEnd:
        type: object
      timestampEndStr:
        type: string
      title:
        type: string
      unities:
        type: array
        items:
          "$ref": "#/definitions/Unity"
      urlLink:
        type: string
  Batch:
    properties:
      active:
        type: boolean
      desc:
        type: string
      eventSections:
        type: array
        items:
          "$ref": "#/definitions/EventSection"
      id:
        type: integer
      idFact:
        type: integer
      name:
        type: string
      sellingDateEnd:
        type: string
      sellingDateStart:
        type: string
      tickets:
        type: array
        items:
          "$ref": "#/definitions/Ticket"
  EventSection:
    properties:
      desc:
        type: string
      id:
        type: integer
      idFact:
        type: integer
      name:
        type: string
      tickets:
        type: array
        items:
          "$ref": "#/definitions/Ticket"
  FidelityShort:
    properties:
      id:
        type: integer
      idUnity:
        type: integer
      winningDesc:
        type: string
  Order:
    properties:
      accessCode:
        type: string
      brand:
        "$ref": "#/definitions/Brand"
      change:
        type: integer
      customer:
        "$ref": "#/definitions/Customer4all"
      customerInfo:
        "$ref": "#/definitions/CustomerInfo"
      deliveryFee:
        type: integer
      discount:
        type: integer
      estimatedTimestamp:
        type: object
      id:
        type: integer
      id4all:
        type: string
      idDevice:
        type: integer
      idFact:
        type: integer
      idMarketplace:
        type: integer
      idOrderType:
        type: integer
      idTokPdv:
        type: integer
      idTransaction4all:
        type: string
      idUnity:
        type: integer
      idUnityReceived:
        type: integer
      observation:
        type: string
      orderAddress:
        "$ref": "#/definitions/OrderAddress"
      orderItems:
        type: array
        items:
          "$ref": "#/definitions/OrderItem"
      orderStatusLog:
        type: array
        items:
          "$ref": "#/definitions/OrderStatusLog"
      paymentMethod:
        "$ref": "#/definitions/PaymentMethod"
      paymentStatus:
        type: integer
      pdvOrderId:
        type: string
      placeLabel:
        type: string
      productTotal:
        type: integer
      status:
        type: integer
      timestamp:
        type: object
      tips:
        type: integer
      total:
        type: integer
      unity:
        "$ref": "#/definitions/Unity"
      voucher:
        "$ref": "#/definitions/Voucher"
  OrderStatusLog:
    properties:
      id:
        type: integer
      idOrder:
        type: integer
      idOrderSource:
        type: integer
      idOrderStatus:
        type: integer
      timestampCreation:
        type: object
  CustomerInfo:
    properties:
      cardId:
        type: string
      paymentMode:
        type: integer
      pin:
        type: string
      sessionToken:
        type: string
  OrderAddress:
    properties:
      cep:
        type: string
      city:
        type: string
      complement:
        type: string
      id:
        type: integer
      idOrder:
        type: integer
      neighborhood:
        type: string
      number:
        type: string
      reference:
        type: string
      street:
        type: string
      uf:
        type: string
  OrderItem:
    properties:
      desc:
        type: string
      discount:
        type: integer
      id:
        type: integer
      idDevice:
        type: integer
      idExternal:
        type: string
      idFact:
        type: integer
      idOrder:
        type: integer
      idOrderItem:
        type: integer
      idUnityItem:
        type: integer
      itemPrice:
        type: integer
      observation:
        type: string
      parentId:
        type: integer
      price:
        type: integer
      quantity:
        type: number
      subItems:
        type: array
        items:
          "$ref": "#/definitions/OrderItem"
      thumb:
        type: string
      title:
        type: string
      total:
        type: integer
      unityItem:
        "$ref": "#/definitions/UnityItem"
  UnityItem:
    properties:
      active:
        type: boolean
      barcode:
        type: string
      contentType:
        type: string
      desc:
        type: string
      duration:
        type: string
      extension:
        type: string
      id:
        type: integer
      idExternal:
        type: string
      idUnityItemType:
        type: integer
      media:
        type: array
        items:
          "$ref": "#/definitions/Media"
      originalPrice:
        type: integer
      position:
        type: integer
      price:
        type: integer
      special:
        type: boolean
      thumb:
        type: string
      title:
        type: string
      unityId:
        type: integer
      unityItemModifiers:
        type: array
        items:
          "$ref": "#/definitions/UnityItemModifier"
  UnityItemModifier:
    properties:
      contentType:
        type: string
      desc:
        type: string
      extension:
        type: string
      id:
        type: integer
      idProductCategory:
        type: integer
      idUnityItem:
        type: integer
      idUnityItemModifierPriceType:
        type: integer
      maxQuantity:
        type: integer
      minQuantity:
        type: integer
      name:
        type: string
      position:
        type: integer
      productCategory:
        "$ref": "#/definitions/ProductCategory"
      thumb:
        type: string
      unityItems:
        type: array
        items:
          "$ref": "#/definitions/UnityItem"
  ProductCategory:
    properties:
      active:
        type: boolean
      children:
        type: array
        items:
          "$ref": "#/definitions/ProductCategory"
      id:
        type: integer
      idExternal:
        type: string
      name:
        type: string
      parentId:
        type: integer
      position:
        type: integer
      productCategoryTypeId:
        type: integer
      thumb:
        type: string
      unityId:
        type: integer
      unityItems:
        type: array
        items:
          "$ref": "#/definitions/UnityItem"
  Ticket:
    properties:
      batch:
        "$ref": "#/definitions/Batch"
      eventSection:
        "$ref": "#/definitions/EventSection"
      id:
        type: integer
      idBatch:
        type: integer
      idEventSection:
        type: integer
      name:
        type: string
      price:
        type: integer
      ticketLimit:
        type: integer
      ticketSold:
        type: integer