Picker Admin API

swagger: '2.0'
info:
  title: Picker Production Documentation accounting Admin API
  version: V1.0.0
  contact:
    name: RV
    email: rachit.verma@nextjuggernaut.com
host: api.pickerexpress.com
basePath: /
schemes:
- http
tags:
- name: Admin
paths:
  /admin/sendEmailTo:
    post:
      summary: Send email to user
      operationId: postAdminSendemailto
      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 52'
      responses:
        default:
          schema:
            type: string
          description: Successful
      tags:
      - Admin
  /admin/sendInvoiceEmail:
    post:
      summary: Send booking's invoice to email
      operationId: postAdminSendinvoiceemail
      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 53'
      responses:
        default:
          schema:
            type: string
          description: Successful
      tags:
      - Admin
  /accounting/getAPICharges:
    get:
      summary: Return the amount to charge all API users
      operationId: getAccountingGetapicharges
      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: startDate
        in: query
        required: true
      - type: string
        name: endDate
        in: query
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllBusinessesBalanceTransactionDetails:
    get:
      summary: Get all the marketplace transactions in a date range
      operationId: getAccountingGetallbusinessesbalancetransactiondetails
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      - type: boolean
        name: download
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllBusinessesTransactions:
    get:
      summary: Get businesses transactions grouped by business
      operationId: getAccountingGetallbusinessestransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: integer
        description: Limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: Skip data from response
        name: skip
        in: query
        required: false
      - type: string
        description: Name of the business
        name: searchUser
        in: query
        required: false
      - type: boolean
        name: download
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllBusinessesTransactionsSummary:
    get:
      summary: Get summary of all business transactions
      operationId: getAccountingGetallbusinessestransactionssummary
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: string
        description: Name of the business
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllDriversBonusTransactions:
    get:
      summary: Get the order amount of all pickers CC transactions in the date range requested.
      operationId: getAccountingGetalldriversbonustransactions
      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
        description: Limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: Skip data from response
        name: skip
        in: query
        required: false
      - type: string
        description: Name of picker
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllDriversDeliveryTransactions:
    get:
      operationId: getAccountingGetalldriversdeliverytransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      - type: boolean
        name: download
        in: query
        required: false
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      - type: string
        description: Name of picker
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getAllDriversDeliveryTransactionsSummary:
    get:
      summary: Get summary of all driver's delivery transactions
      operationId: getAccountingGetalldriversdeliverytransactionssummary
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: string
        description: Name of the business
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getCompanyTransactions:
    get:
      summary: Get all company transactions in a date range
      operationId: getAccountingGetcompanytransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      - type: boolean
        name: download
        in: query
        required: false
      - type: number
        name: limit
        in: query
        required: false
      - type: number
        name: skip
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getDriverDeliveryTransactionsDetails:
    get:
      summary: Get all delivery transactions of the driver selected
      operationId: getAccountingGetdriverdeliverytransactionsdetails
      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 driver to filter transactions
        name: pickerID
        in: query
        required: true
      - type: string
        description: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /accounting/getPickerBonusTransactionsDetails:
    get:
      summary: Get the order amount of all pickers CC transactions in the date range requested.
      operationId: getAccountingGetpickerbonustransactionsdetails
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: string
        description: ID of the driver to filter transactions
        name: pickerID
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/addBusinessAccessToUser:
    get:
      summary: Get Business By ID
      operationId: getAdminAddbusinessaccesstouser
      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
        name: businessID
        in: query
        required: true
      - type: string
        description: ID of the user
        name: userID
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/assignReasons:
    get:
      summary: Returns the list of all Cancel Reasons
      operationId: getAdminAssignreasons
      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:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/cancelBookingReasons:
    get:
      summary: Returns the list of all Cancel Reasons
      operationId: getAdminCancelbookingreasons
      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:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/deleteBusinessAccessToUser:
    get:
      summary: Get Business By ID
      operationId: getAdminDeletebusinessaccesstouser
      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
        name: businessID
        in: query
        required: true
      - type: string
        description: ID of the user
        name: userID
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/driversWorkBalance:
    get:
      summary: Get drivers work balance information
      operationId: getAdminDriversworkbalance
      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
        minimum: 0
        name: skip
        in: query
        required: false
      - type: number
        minimum: 0
        name: limit
        in: query
        required: false
      - type: string
        minLength: 3
        name: searchUser
        in: query
        required: false
      - type: string
        name: superRegionID
        in: query
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllAvailabeBooking:
    get:
      summary: Get All Availabe Booking
      operationId: getAdminGetallavailabebooking
      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
        description: limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: skip data from response
        name: skip
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllBusinesses:
    get:
      summary: Get users registered as business
      operationId: getAdminGetallbusinesses
      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: status
        in: query
        required: true
      - type: string
        description: Business' name, email or company name
        name: searchUser
        in: query
        required: false
      - type: string
        description: Field to order the results
        name: orderBy
        in: query
        required: false
      - type: string
        description: 'Order criteria: ASC | DESC'
        name: sort
        in: query
        required: false
      - type: integer
        description: limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: limit data from response
        name: skip
        in: query
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllBusinessesTransactions:
    get:
      operationId: getAdminGetallbusinessestransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: integer
        description: Limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: Skip data from response
        name: skip
        in: query
        required: false
      - type: string
        description: Name of the business
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllCancelReasons:
    get:
      summary: Returns the list of all Cancel Reasons available
      operationId: getAdminGetallcancelreasons
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllDriverTags:
    get:
      summary: Returns the list of all Driver Tags available
      operationId: getAdminGetalldrivertags
      parameters:
      - type: string
        description: Bearer Token
        name: authorization
        in: header
        required: true
      - type: string
        description: en/ar
        name: content-language
        in: header
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllPickersBalanceTransactions:
    get:
      summary: Get total of all balance transactions of the pickers
      operationId: getAdminGetallpickersbalancetransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      - type: integer
        description: Limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: Skip data from response
        name: skip
        in: query
        required: false
      - type: string
        description: user email or name
        name: searchUser
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllPickersOrderTransactions:
    get:
      summary: Get the order amount of all pickers CC transactions in the date range requested.
      operationId: getAdminGetallpickersordertransactions
      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: Start date of the search on ISO format
        name: startDate
        in: query
        required: false
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: false
      - type: integer
        description: Limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: Skip data from response
        name: skip
        in: query
        required: false
      - type: string
        description: Name of picker
        name: searchUser
        in: query
        required: false
      - type: boolean
        name: download
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getAllUsers:
    get:
      summary: Get List Of All Customers by Role[serviceProvider, customer, driver, business]
      operationId: getAdminGetallusers
      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: role of user order is  customer/driver/serviceProvider/admin/business
        enum:
        - all
        - customer
        - driver
        - serviceProvider
        - admin
        - business
        name: role
        in: query
        required: true
      - type: string
        enum:
        - all
        - true
        - false
        name: isBlocked
        in: query
        required: true
      - type: string
        enum:
        - all
        - true
        - false
        name: isDeleted
        in: query
        required: true
      - type: string
        enum:
        - all
        - true
        - false
        name: isAdminVerified
        in: query
        required: true
      - type: boolean
        description: list only users created by self if true else all
        name: createdBySelf
        in: query
        required: false
      - type: string
        description: user email or name
        name: searchUser
        in: query
        required: false
      - type: integer
        description: limit data in response
        name: limit
        in: query
        required: false
      - type: integer
        description: limit data from response
        name: skip
        in: query
        required: false
      - type: string
        description: Filter users that belong to this Super Region
        name: superRegionID
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBanners:
    get:
      summary: Returns the banners that match the query
      operationId: getAdminGetbanners
      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: Status of the banners to query
        default: ACTIVE
        enum:
        - ACTIVE
        - INACTIVE
        - ALL
        name: status
        in: query
        required: false
      - type: string
        description: Type of the banners to query
        enum:
        - BUSINESS
        - CATEGORY
        name: type
        in: query
        required: false
      - type: number
        description: Amount of results to return
        name: limit
        in: query
        required: false
      - type: number
        description: Amount of results to skip from the search
        name: skip
        in: query
        required: false
      - type: number
        name: latitude
        in: query
        required: false
      - type: number
        name: longitude
        in: query
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBookingDetails:
    get:
      summary: Get All Deatils of a Particular Booking
      operationId: getAdminGetbookingdetails
      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: booking id
        minLength: 24
        maxLength: 24
        name: id
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBookingInfo:
    get:
      summary: Get info of Booking & Review
      operationId: getAdminGetbookinginfo
      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: 24
        maxLength: 24
        name: bookingID
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBookingTransactions:
    get:
      summary: Get all the transactions related to the booking
      operationId: getAdminGetbookingtransactions
      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 booking
        name: bookingID
        in: query
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBookingsStats:
    get:
      summary: Get Dashboard Count
      operationId: getAdminGetbookingsstats
      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: startDate
        in: query
        required: true
      - type: string
        name: endDate
        in: query
        required: true
      - type: number
        name: utcOffset
        in: query
        required: true
      - type: string
        description: Filter users that belong to this Super Region
        name: superRegionID
        in: query
        required: false
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBusinessBalanceTransactionDetails:
    get:
      summary: Get all the marketplace transactions of a selected business in a date range
      operationId: getAdminGetbusinessbalancetransactiondetails
      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: User ID of the business
        name: businessID
        in: query
        required: true
      - type: string
        description: Start date of the search on ISO format
        name: startDate
        in: query
        required: true
      - type: string
        description: End date of the search on ISO format
        name: endDate
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBusinessByName:
    get:
      summary: Get Business By Name
      operationId: getAdminGetbusinessbyname
      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: Name of the business
        name: businessName
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBusinessInfo:
    get:
      summary: Get all business info by its ID
      operationId: getAdminGetbusinessinfo
      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: userID
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getBusinessesByIds:
    get:
      summary: Get Business By ID
      operationId: getAdminGetbusinessesbyids
      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
        name: businessIDS
        in: query
        required: true
      tags:
      - Admin
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/getCSVDataForAdmin:
    get:
      summary: Get CSV report data
      operationId: getAdminGetcsvdataforadmin
      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: startDate
        in: query
        required: false
      - type: string
        name: endDate
        in: query
        required: fal

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