Picker user API

swagger: '2.0'
info:
  title: Picker Production Documentation accounting user API
  version: V1.0.0
  contact:
    name: RV
    email: rachit.verma@nextjuggernaut.com
host: api.pickerexpress.com
basePath: /
schemes:
- http
tags:
- name: user
paths:
  /{param*}:
    get:
      summary: for front end static rendering
      operationId: getParam
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /angular4-docs/{param*}:
    get:
      summary: for angular 4 docs
      operationId: getAngular4docsParam
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /bookings/getAllBookingsDashBoard:
    get:
      summary: Get General info about businesses
      operationId: getBookingsGetallbookingsdashboard
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: integer
        name: limit
        in: query
        required: false
      - type: integer
        name: page
        in: query
        required: false
      - type: string
        name: status
        in: query
        required: false
      - type: string
        name: from
        in: query
        required: false
      - type: string
        name: to
        in: query
        required: false
      - type: string
        name: orderBy
        in: query
        required: false
      - type: boolean
        name: onlyPast
        in: query
        required: false
      - type: boolean
        name: onlyActives
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /bookings/getCoportatesAllBookings:
    get:
      summary: Get General info about businesses
      operationId: getBookingsGetcoportatesallbookings
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: integer
        name: limit
        in: query
        required: false
      - type: integer
        name: page
        in: query
        required: false
      - type: string
        name: status
        in: query
        required: false
      - type: string
        name: from
        in: query
        required: false
      - type: string
        name: to
        in: query
        required: false
      - type: string
        name: orderBy
        in: query
        required: false
      - type: boolean
        name: onlyPast
        in: query
        required: false
      - type: boolean
        name: onlyActives
        in: query
        required: false
      - type: string
        description: ID of the selected user to filter its bookings
        name: userID
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /bookings/getCorporateBookingsByUserId:
    get:
      summary: Get coportates orders by businessId
      operationId: getBookingsGetcorporatebookingsbyuserid
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: integer
        name: limit
        in: query
        required: false
      - type: integer
        name: page
        in: query
        required: false
      - type: string
        name: userId
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/categories:
    get:
      summary: Get all the products from a business
      operationId: getBusinessCategories
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/categoriesByUserId:
    get:
      summary: Get all the products from a business
      operationId: getBusinessCategoriesbyuserid
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      - type: string
        name: businessUserId
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/checkAvailableNames:
    get:
      summary: Check if the name of the business is available
      operationId: getBusinessCheckavailablenames
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: name
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getAccountInfoIntegrationDashboard:
    get:
      summary: Get General info about specific business
      operationId: getBusinessGetaccountinfointegrationdashboard
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: userId
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getAssociatedBusiness:
    get:
      summary: Get General info about businesses
      operationId: getBusinessGetassociatedbusiness
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: storeType
        in: query
        required: false
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      - type: string
        name: search
        in: query
        required: false
      - type: string
        name: sortField
        in: query
        required: false
      - type: string
        name: sortOrder
        in: query
        required: false
      - type: boolean
        name: status
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBookingsDataByDatesDashboard:
    get:
      summary: Get General info about businesses
      operationId: getBusinessGetbookingsdatabydatesdashboard
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: fromDate
        in: query
        required: true
      - type: string
        name: toDate
        in: query
        required: true
      - type: boolean
        name: isSemester
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBookingsIntegrationDashboard:
    get:
      summary: Get General info about businesses
      operationId: getBusinessGetbookingsintegrationdashboard
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: userID
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessCategories:
    get:
      summary: Get the business categories in order
      operationId: getBusinessGetbusinesscategories
      parameters:
      - type: string
        enum:
        - VISIBLE
        - NOT_VISIBLE
        - ALL
        name: visibility
        in: query
        required: false
      - type: number
        description: The number of catgeories that will be returned for each page
        name: limit
        in: query
        required: false
      - type: number
        description: For pagination effect. On first page it is 0, then for each next page is (page x limit) so it can return the next X categories
        name: skip
        in: query
        required: false
      - type: number
        name: latitude
        in: query
        required: false
      - type: number
        name: longitude
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessInfo:
    get:
      summary: Get the business info and its products grouped by category
      operationId: getBusinessGetbusinessinfo
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        description: ID of the business
        minLength: 24
        maxLength: 24
        name: businessID
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessInfoByUserId:
    get:
      summary: Get the business info and its products grouped by category
      operationId: getBusinessGetbusinessinfobyuserid
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        description: ID of the user
        minLength: 24
        maxLength: 24
        name: userId
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessesByDistance:
    get:
      summary: Get the business categories in order
      operationId: getBusinessGetbusinessesbydistance
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: latitude
        in: query
        required: false
      - type: number
        name: longitude
        in: query
        required: false
      - type: string
        description: ID of the business category
        minLength: 24
        maxLength: 24
        name: category
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessesBySubcategory:
    get:
      summary: Get the business of the subcategory ordered by distance to user location
      operationId: getBusinessGetbusinessesbysubcategory
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: latitude
        in: query
        required: true
      - type: number
        name: longitude
        in: query
        required: true
      - type: string
        description: ID of the business category
        minLength: 24
        maxLength: 24
        name: category
        in: query
        required: true
      - type: string
        description: Name of the subcategory
        name: subcategory
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getBusinessesGeneralInfo:
    get:
      summary: Get General info about businesses
      operationId: getBusinessGetbusinessesgeneralinfo
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/getStats:
    get:
      summary: Get the business dashboard information
      operationId: getBusinessGetstats
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: dateTo
        in: query
        required: true
      - type: string
        name: dateFrom
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/products:
    get:
      summary: Get all the products from a business
      operationId: getBusinessProducts
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      - type: string
        description: ID of the category of the product
        minLength: 24
        maxLength: 24
        name: categoryID
        in: query
        required: false
      - type: string
        description: ID of the business
        minLength: 24
        maxLength: 24
        name: businessID
        in: query
        required: false
      - type: string
        description: Status of the products to show
        name: status
        in: query
        required: true
      - type: string
        description: Object path to populate
        name: populates
        in: query
        required: false
      - type: string
        description: Order of the products DESC or ASC
        name: updatedAt
        in: query
        required: false
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/sendSundayReports:
    get:
      summary: Ping Server
      operationId: getBusinessSendsundayreports
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/turnOffOnBusinessById:
    get:
      summary: Get General info about specific business
      operationId: getBusinessTurnoffonbusinessbyid
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: businessUserId
        in: query
        required: true
      - type: string
        name: businessId
        in: query
        required: true
      - type: string
        name: currentStatus
        in: query
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/forgotPasswordMobile:
    get:
      summary: Sends Reset Password Token To User
      operationId: getUserForgotpasswordmobile
      parameters:
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: countryCode
        in: query
        required: true
      - type: string
        name: mobile
        in: query
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/getReferralBenifitsHistory:
    get:
      summary: Get referral benifits history
      operationId: getUserGetreferralbenifitshistory
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/getReferralCode:
    get:
      summary: Get referral code for user
      operationId: getUserGetreferralcode
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/getResetPasswordToken:
    get:
      summary: Sends Reset Password Token To User
      operationId: getUserGetresetpasswordtoken
      parameters:
      - type: string
        name: content-language
        in: header
        required: true
      - type: string
        x-format:
          email: true
        name: email
        in: query
        required: true
      - type: string
        description: Role of user who forgot password
        enum:
        - customer
        - driver
        - admin
        - business
        name: role
        in: query
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/getUserFromIP:
    get:
      summary: Get User from device token
      operationId: getUserGetuserfromip
      parameters:
      - type: string
        name: content-language
        in: header
        required: true
      - type: string
        name: remoteIP
        in: query
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/getWallet:
    get:
      summary: Get wallet data for user
      operationId: getUserGetwallet
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/pingMe:
    get:
      summary: Ping Server
      operationId: getUserPingme
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/addPhoneNumber:
    put:
      summary: Add Phone Number
      operationId: putUserAddphonenumber
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 38'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/addToWallet:
    put:
      summary: Add money to user wallet
      operationId: putUserAddtowallet
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        name: bookingNumericId
        in: formData
        required: true
      - type: number
        minimum: 0
        name: amount
        in: formData
        required: true
      - type: string
        name: description
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/changePassword:
    put:
      summary: Change Password
      operationId: putUserChangepassword
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        description: password must contains minimum 6 character
        minLength: 6
        name: oldPassword
        in: formData
        required: true
      - type: string
        description: password must contains minimum 6 character
        minLength: 6
        name: newPassword
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/contactUs:
    put:
      summary: Contact Us
      operationId: putUserContactus
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        minLength: 2
        pattern: /^[a-zA-Z ]+$/
        x-convert:
          trim: true
        name: name
        in: formData
        required: true
      - type: string
        x-format:
          email: true
        name: email
        in: formData
        required: true
      - type: string
        name: query
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/preferenceSettings:
    put:
      summary: Add Preference Settings
      operationId: putUserPreferencesettings
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        description: ' BIKE or LITE or NONE '
        enum:
        - BIKE
        - LITE
        - NONE
        name: carName
        in: formData
        required: true
      - type: string
        description: ' CARD or CASH or NONE'
        enum:
        - CARD
        - CASH
        - NONE
        name: paymentMethod
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/resendEmail:
    put:
      summary: Resend email verify link
      operationId: putUserResendemail
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/resendOTP:
    put:
      summary: Resend OTP for Driver
      operationId: putUserResendotp
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 39'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/resetPassword:
    put:
      summary: Reset Password
      operationId: putUserResetpassword
      parameters:
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: passwordResetToken
        in: formData
        required: true
      - type: string
        description: password must contains minimum 6 character
        minLength: 6
        name: newPassword
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/setPassword:
    put:
      summary: set Password
      operationId: putUserSetpassword
      parameters:
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: emailVerificationToken
        in: formData
        required: true
      - type: string
        description: password must contains minimum 6 character
        minLength: 6
        name: password
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/setPrimaryNumber:
    put:
      summary: set primary number
      operationId: putUserSetprimarynumber
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 40'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/updateDeviceToken:
    put:
      summary: update device token
      operationId: putUserUpdatedevicetoken
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 41'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/updatePhoneNumber:
    put:
      summary: Update Phone Number
      operationId: putUserUpdatephonenumber
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 42'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/updateUTCoffset:
    put:
      summary: update UTC offset
      operationId: putUserUpdateutcoffset
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: number
        description: utc offset
        name: utcoffset
        in: header
        required: true
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /user/verifyForgotPasswordOTP:
    put:
      summary: Sends Reset Password Token To User
      operationId: putUserVerifyforgotpasswordotp
      parameters:
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        name: countryCode
        in: formData
        required: true
      - type: string
        name: mobile
        in: formData
        required: true
      - type: number
        name: OTP
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /business/verifyEmail:
    post:
      summary: Verify registration email for business
      operationId: postBusinessVerifyemail
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - in: body
        name: body
        schema:
          $ref: '#/definitions/Model 69'
      tags:
      - user
      responses:
        default:
          schema:
            type: string
          description: Successful
  /serviceProvider/accessTokenLogin:
    post:
      summary: get details with token
      operationId: postServiceproviderAccesstokenlogin
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      - type: string
        x-convert:
          trim: true
        name: appVersion
        in: formDa

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