Picker booking API

swagger: '2.0'
info:
  title: Picker Production Documentation accounting booking API
  version: V1.0.0
  contact:
    name: RV
    email: rachit.verma@nextjuggernaut.com
host: api.pickerexpress.com
basePath: /
schemes:
- http
tags:
- name: booking
paths:
  /admin/bookings:
    get:
      summary: Get list of bookings
      operationId: getAdminBookings
      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
        default: 12
        name: limit
        in: query
        required: false
      - type: integer
        default: 0
        name: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: array
        x-constraint:
          single: true
        items:
          type: number
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 7
          - 6
          - 8
          - 11
          - 12
          - 13
          - 20
          - 21
          - 22
          - 10
          - 25
          - 23
          - 27
          - 28
          - 32
          - 34
          - 33
          - 29
          - 31
        collectionFormat: multi
        name: currentStatus
        in: query
        required: false
      - type: string
        enum:
        - PICKUP_AND_DELIVER
        - BUY_AND_DELIVER
        - MARKETPLACE
        - SHOP_ORDER
        - CORPORATE
        - WHITE_LABEL
        name: typeText
        in: query
        required: false
      - type: string
        name: sortField
        in: query
        required: false
      - type: string
        name: sortOrder
        in: query
        required: false
      - type: string
        name: searchBooking
        in: query
        required: false
      - type: string
        name: customer
        in: query
        required: false
      - type: string
        name: driver
        in: query
        required: false
      - type: string
        name: business
        in: query
        required: false
      - type: string
        name: superRegionID
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/userBookings:
    get:
      summary: Get list of bookings from an user
      operationId: getAdminUserbookings
      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
        default: 12
        name: limit
        in: query
        required: false
      - type: integer
        default: 0
        name: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: string
        name: customer
        in: query
        required: false
      - type: string
        name: driver
        in: query
        required: false
      - type: string
        name: business
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/warningBookings:
    get:
      summary: Get list of bookings
      operationId: getAdminWarningbookings
      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
        default: 12
        name: limit
        in: query
        required: false
      - type: integer
        default: 0
        name: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: string
        name: sortField
        in: query
        required: false
      - type: string
        name: sortOrder
        in: query
        required: false
      - type: string
        name: adminResponsableID
        in: query
        required: false
      - type: string
        name: superRegionID
        in: query
        required: false
      - type: string
        name: currency
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getBookingDetails:
    get:
      summary: Get all details from a selected booking
      operationId: getApiGetbookingdetails
      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: bookingID
        in: query
        required: false
      - type: string
        name: id
        in: query
        required: false
      - type: string
        name: externalID
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getChatbotBooking:
    get:
      summary: Get all details from a selected booking using chatbot
      operationId: getApiGetchatbotbooking
      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: Field bookingNumericId
        name: bookingID
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getDriver:
    get:
      summary: Get drivers registered by the user
      operationId: getApiGetdriver
      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: email
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getDriverById:
    get:
      summary: Get driver by id
      operationId: getApiGetdriverbyid
      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: id
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getDrivers:
    get:
      summary: Get drivers registered by the user
      operationId: getApiGetdrivers
      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: skip
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/getPastBooking:
    get:
      summary: Get Past Booking For User
      operationId: getApiGetpastbooking
      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: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: array
        description: 0-Pending, 1-Accepted, 2-Arrived, 3-WAY_TO_DELIVER, 4-Arrived At Delivery, 5-Completed6-Cancelled By Admin, 7-Cancelled
        x-constraint:
          single: true
        items:
          type: number
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 7
          - 6
        collectionFormat: multi
        name: currentStatus
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getAllAvailabeBooking:
    get:
      summary: Get All Availabe Booking For serviceProvider and Driver
      operationId: getBookingGetallavailabebooking
      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: skip
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getAllBids:
    get:
      summary: Get All Bid Request
      operationId: getBookingGetallbids
      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 for the bids
        name: bookingID
        in: query
        required: true
      - type: integer
        name: limit
        in: query
        required: false
      - type: integer
        name: skip
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getAllBookingDetails:
    get:
      summary: Get All Deatils of Particular Booking For serviceProvider and Driver
      operationId: getBookingGetallbookingdetails
      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: id
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getBookingDetails:
    get:
      summary: Get All Deatils of Particular Booking For serviceProvider and Driver
      operationId: getBookingGetbookingdetails
      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: id
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getBookingReport:
    get:
      summary: Get booking report data for user
      operationId: getBookingGetbookingreport
      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 selected
        minLength: 24
        maxLength: 24
        name: bookingID
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getBookingRoute:
    get:
      summary: Get path for specific booking
      operationId: getBookingGetbookingroute
      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 to fetch the track history
        minLength: 24
        maxLength: 24
        name: bookingID
        in: query
        required: true
      - type: boolean
        name: objectId
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getOngoingBooking:
    get:
      summary: Get Ongoing Booking For User
      operationId: getBookingGetongoingbooking
      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: skip
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getPastBooking:
    get:
      summary: Get Past Booking For User
      operationId: getBookingGetpastbooking
      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: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: string
        format: date
        name: dateFrom
        in: query
        required: false
      - type: string
        enum:
        - DESC
        - ASC
        name: orderDate
        in: query
        required: false
      - type: string
        format: date
        name: dateTo
        in: query
        required: false
      - type: array
        description: 0-Pending, 1-Accepted, 2-Arrived, 3-WAY_TO_DELIVER, 4-Arrived At Delivery, 5-Completed, 7-Cancelled, 8-Cancelled By Driver, 10-Cancelled Request, 11-Rejected By Customer, 12-Not Found, 20-On Hold, 21-On Deck, 22-Ready for pickup
        x-constraint:
          single: true
        items:
          type: number
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 7
          - 6
          - 8
          - 11
          - 12
          - 13
          - 20
          - 21
          - 22
          - 10
          - 25
          - 23
          - 27
          - 28
          - 29
        collectionFormat: multi
        name: currentStatus
        in: query
        required: false
      - type: string
        enum:
        - PICKUP_AND_DELIVER
        - BUY_AND_DELIVER
        - MARKETPLACE
        - SHOP_ORDER
        name: typeText
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getProductList:
    get:
      summary: Get list of products from the booking
      operationId: getBookingGetproductlist
      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 selected
        minLength: 24
        maxLength: 24
        name: bookingID
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/preCheckout:
    get:
      summary: Get deliveryFee and details for checkout screen
      operationId: getBookingPrecheckout
      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: Distance between pickup & delivery location
        minimum: 0
        name: distance
        in: query
        required: true
      - type: number
        minimum: -180
        maximum: 180
        x-constraint:
          precision: 6
        name: pickupLongitude
        in: query
        required: true
      - type: number
        minimum: -90
        maximum: 90
        x-constraint:
          precision: 6
        name: pickupLatitude
        in: query
        required: true
      - type: array
        description: Array of products the customer will buy
        items:
          type: string
        collectionFormat: multi
        name: products
        in: query
        required: true
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
    post:
      summary: Get delivery details for pre checkout view
      operationId: postBookingPrecheckout
      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 63'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /customer/getPastBooking:
    get:
      summary: Get Past Booking For Customer
      operationId: getCustomerGetpastbooking
      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: skip
        in: query
        required: false
      - type: string
        format: date
        name: startDate
        in: query
        required: false
      - type: string
        format: date
        name: endDate
        in: query
        required: false
      - type: string
        enum:
        - DESC
        - ASC
        name: orderDate
        in: query
        required: false
      - type: array
        x-constraint:
          single: true
        items:
          type: number
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 7
          - 6
          - 8
          - 11
          - 12
          - 13
          - 20
          - 21
          - 22
          - 10
          - 25
          - 23
          - 27
          - 28
          - 29
        collectionFormat: multi
        name: currentStatus
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/workspace/getBookingDetails:
    get:
      summary: Get all details from a selected booking
      operationId: getApiWorkspaceGetbookingdetails
      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: bookingID
        in: query
        required: false
      - type: string
        name: id
        in: query
        required: false
      - type: string
        name: externalID
        in: query
        required: false
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/assignResponsable:
    put:
      summary: Assign user as responsable for a booking
      operationId: putAdminAssignresponsable
      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 5'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /admin/changeBookingDriver:
    put:
      summary: Change the driver of a selected booking
      operationId: putAdminChangebookingdriver
      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 7'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /api/rateChatbotBooking:
    put:
      summary: Rate a booking from chatbot
      operationId: putApiRatechatbotbooking
      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 13'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/addProofOfDelivery:
    put:
      summary: When a booking it's completed the delivery send a picture that should save in the booking
      operationId: putBookingAddproofofdelivery
      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 16'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/assignBookingManually:
    put:
      summary: Send booking notification manually to sp/driver
      operationId: putBookingAssignbookingmanually
      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 service provider
        x-constraint:
          length: 24
        name: userID
        in: formData
        required: true
      - type: string
        enum:
        - driver
        - serviceProvider
        name: role
        in: formData
        required: true
      - type: string
        description: Booking ID
        x-constraint:
          length: 24
        name: bookingID
        in: formData
        required: true
      - type: boolean
        description: If booking was check for have provider assign
        name: assignConfirm
        in: formData
        required: true
      - type: string
        description: Reason of the assign
        name: manualAssignReason
        in: formData
        required: true
      - type: boolean
        name: isAdmin
        in: formData
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/assignBookingRandomly:
    put:
      summary: Remove driver from booking and start new driver search
      operationId: putBookingAssignbookingrandomly
      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-constraint:
          length: 24
        name: bookingID
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/assignManualRequest:
    put:
      summary: Send booking notification request manually to driver
      operationId: putBookingAssignmanualrequest
      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 driver
        x-constraint:
          length: 24
        name: userID
        in: formData
        required: true
      - type: string
        description: Booking ID
        x-constraint:
          length: 24
        name: bookingID
        in: formData
        required: true
      - type: string
        description: Reason of the manual request assign
        name: manualRequestReason
        in: formData
        required: true
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/bookingAcceptReject:
    put:
      summary: Accept-Reject Booking
      operationId: putBookingBookingacceptreject
      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: formData
        required: true
      - type: number
        enum:
        - 1
        - 9
        name: bookingCurrentStatus
        in: formData
        required: true
      - type: string
        enum:
        - ACCEPTED
        - REJECTED_BY_DRIVER
        name: bookingCurrentStatusText
        in: formData
        required: true
      - type: number
        description: Driver's current location
        name: latitude
        in: formData
        required: false
      - type: number
        description: Driver's current location
        name: longitude
        in: formData
        required: false
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/cancelBooking:
    put:
      summary: Cancel Booking
      operationId: putBookingCancelbooking
      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 17'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/cancelBookingFromBusiness:
    put:
      summary: Cancel Booking From Business
      operationId: putBookingCancelbookingfrombusiness
      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 18'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/cancelBookingRequest:
    put:
      summary: Cancel Booking
      operationId: putBookingCancelbookingrequest
      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 19'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/changePaymentMethod:
    put:
      summary: Change payment method of the selected booking
      operationId: putBookingChangepaymentmethod
      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 20'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/editOrderRequest:
    put:
      summary: Edit the selected order request and send notification to customer
      operationId: putBookingEditorderrequest
      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 21'
      tags:
      - booking
      responses:
        default:
          schema:
            type: string
          description: Successful
  /booking/getCancellationChargeInfo:
    put:
      summary: Cancel Booking
      operationId: putBookingGetcancellationchargeinfo
      parameters:
      - type: string
        desc

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