> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mervii.com/llms.txt
> Use this file to discover all available pages before exploring further.

# intral-city

> ### CitySwift (Intral city) Price Calculation

This endpoint allows you to calculate the price for an intracity trip based on the pickup origin and destination.



## OpenAPI

````yaml beta/en/api/beta.yaml post /price/intral-city
openapi: 3.0.3
info:
  title: Introduction to the Mervii Open API
  description: >-
    # Introduction to the Mervii Open API


    The Mervii Open API offers secure, scalable, and seamless integration with
    our cutting-edge logistics, delivery, and payment systems. Designed with
    both developers and enterprises in mind, this API enables you to embed
    Mervii’s advanced capabilities directly into your applications. Whether you
    aim to implement real-time tracking, streamline complex logistics
    operations, or integrate secure payment processing, our comprehensive suite
    of endpoints provides the flexibility and performance necessary to support
    your digital transformation initiatives.


    This documentation serves as your detailed guide for integration, featuring
    in-depth technical explanations, practical code examples, and industry best
    practices to ensure a smooth and efficient implementation. Key features
    include:


    - **Robust Logistics Management:** Handle intricate logistics processes—from
    parcel tracking to fleet management—with ease.
        
    - **Real-time Delivery Services:** Incorporate dynamic delivery options that
    offer instant tracking and status updates.
        
    - **Secure Payment Processing:** Enable swift and secure transactions across
    a variety of payment methods.
        

    _Please note:_ The Mervii Open API is currently in public beta. For
    expedited access or further technical support, kindly contact us at
    [partners@mervii.com](https://null) or
    [developers@mervii.com](https://null).


    Explore our documentation to unlock the full potential of Mervii’s
    innovative solutions and elevate your application’s capabilities.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.mervii.com/beta
security: []
tags:
  - name: prices
    description: >-
      ## Prices


      These endpoints gives the partners access to check the price quoation for
      the delivery before make a delivery request.


      > **Recommendation**  

      _We strongly encourage our partners to get the price to determine the
      total amount of money Mervii will charge for each delivery request._
  - name: parcels
    description: >-
      # Parcel


      These service contain two segment


      - CitySwift (Intral city)
          
      - FlexFlow (Inter city or inter state)
          
      # CitySwift (Intral city)

      > CitySwift is an instant delivery within a city; We aim to fulfill this
      request with an hour.

      ##### Suitable For

      - Food delivery

      - Grocesery store 

      - Resturant 

      - Supper-market 

      - and order need to fulfill instantly within a city.


      # FlexFlow (Inter city or inter state)

      > FlexFlow (Inter city or inter state) is a schedule delivery within a
      city, inter-state or inter city with a flexible flexibility, FlexFlow
      comes with a variant flexibility; Offering Pickup and Drop-off center or
      Hub, Home delivery and Home pickup (ends-ends services).

      ##### Suitable For

      - Inter-state delivery

      - Hub pickup and drop-off 

      - Home delivery and Home pickup
  - name: CitySwift (Intral city)
    description: >-
      # Intral-city

      This endpoint allow partners to request for delivery fulfilment within
      cities. This type of request are expected to be fulfiled within short
      period of time i.e. *Same day delivery*.


      This type of request suitable for resturances and gloceries partners.


      > ## Good to Know

      > This request only available with cities, i.e. partners can only make
      request for the address with cities for pickup and delivery.


      - e.g sender and receiver address are within a city.
  - name: FlexFlow
    description: >-
      # Logistics services

      These endpoint in the segment contains different instruction to fulfil a
      logistics request.


      - **Door to Door** : This types of request gives us instruction to handle
      you logistics end - end i.e. *Home delivery*. Our delivery personnel come
      to pickup at a specified place  and delivered to the receivers specified
      place using Latitude and longitude.



      - **Centre to Centre** : This types of request gives us instruction to our
      personnel to pickup your item at our specified centre and deliver it to
      our specified centre.  

      > ## Note

      > Sender are expected to take the items to our centre and receiver need to
      come to our centre to pick-up the items.




      - ** Centre to Door** : This types of request gives us instruction to our
      personnel to pickup your items at our specified centre and the deliver it
      to the receivers specified address i.e *Home delivery*

      > ## Note

      > Sender are expected to take the items to our centre.




      - ** Door to Centre** : This types of request gives us instruction to our
      personnel to pickup your items at sender specified address i.e. *Home
      pickup* and the deliver it to the receivers specified centre.

      > ## Note

      > Receiver need to come to our specified pickup centre to pick-up the
      items.
       
  - name: Utils
    description: >-
      # Utils endpoints

      These endpoint return mervii utils data and variable specified by Mervii
      to ensure request integrities.

      - States and codes

      - Pickup and drop-off centres

      - Weight variables and codes
paths:
  /price/intral-city:
    post:
      tags:
        - prices
      summary: intral-city
      description: >-
        ### CitySwift (Intral city) Price Calculation


        This endpoint allows you to calculate the price for an intracity trip
        based on the pickup origin and destination.
      operationId: intralCity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                destinations:
                  type: array
                  items: {}
                  example: []
                item_weight:
                  type: number
                  example: 1
                pickup_origin:
                  type: object
                  properties:
                    city:
                      type: string
                      example: Lagos
                    country_code:
                      type: string
                      example: NG
                    region:
                      type: object
                      properties:
                        latitude:
                          type: number
                          example: 6.4612672
                        longitude:
                          type: number
                          example: 3.3961466
                    state_code:
                      type: string
                      example: LA
            examples:
              intral-city:
                value:
                  destinations: []
                  item_weight: 1
                  pickup_origin:
                    city: Lagos
                    country_code: NG
                    region:
                      latitude: 6.4612672
                      longitude: 3.3961466
                    state_code: LA
      responses:
        '200':
          description: success
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache, private
            Connection:
              schema:
                type: string
                example: close
            Date:
              schema:
                type: string
                example: Mon, 07 Oct 2024 21:28:19 GMT
            Host:
              schema:
                type: string
                example: api.localhost:8000
            Vary:
              schema:
                type: string
                example: Origin
            X-Powered-By:
              schema:
                type: string
                example: PHP/8.3.11
            X-RateLimit-Limit:
              schema:
                type: string
                example: '60'
            X-RateLimit-Remaining:
              schema:
                type: string
                example: '59'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      destinations:
                        type: array
                        items:
                          type: object
                          properties:
                            city:
                              type: string
                              example: Lagos
                            country_code:
                              type: string
                              example: NG
                            price:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 28366.4
                                amount_payable:
                                  type: number
                                  example: 22693.12
                                discount_amount:
                                  type: number
                                  example: 5673.28
                                discount_description:
                                  type: string
                                  example: 20% discount
                                discount_type:
                                  type: string
                                  example: percentage
                                distance:
                                  type: string
                                  example: 142 km
                                duration:
                                  type: string
                                  example: 2 hours 4 mins
                            region:
                              type: object
                              properties:
                                latitude:
                                  type: number
                                  example: 7.427026700000001
                                longitude:
                                  type: number
                                  example: 3.8900142
                            state_code:
                              type: string
                              example: LA
                        example:
                          - city: Lagos
                            country_code: NG
                            price:
                              amount: 28366.4
                              amount_payable: 22693.12
                              discount_amount: 5673.28
                              discount_description: 20% discount
                              discount_type: percentage
                              distance: 142 km
                              duration: 2 hours 4 mins
                            region:
                              latitude: 7.427026700000001
                              longitude: 3.8900142
                            state_code: LA
                          - city: Lagos
                            country_code: NG
                            price:
                              amount: 28366.4
                              amount_payable: 22693.12
                              discount_amount: 5673.28
                              discount_description: 20% discount
                              discount_type: percentage
                              distance: 142 km
                              duration: 2 hours 4 mins
                            region:
                              latitude: 7.427026700000001
                              longitude: 3.8900142
                            state_code: LA
                      discount_description:
                        type: string
                        example: See the destination parcel details
                      discount_type:
                        type: string
                        example: percentage
                      pickup_origin:
                        type: object
                        properties:
                          city:
                            type: string
                            example: Lagos
                          country_code:
                            type: string
                            example: NG
                          region:
                            type: object
                            properties:
                              latitude:
                                type: number
                                example: 6.4612672
                              longitude:
                                type: number
                                example: 3.3961466
                          state_code:
                            type: string
                            example: LA
                      total_amount:
                        type: number
                        example: 56732.8
                      total_amount_payable:
                        type: number
                        example: 45386.24
                      total_discount_amount:
                        type: number
                        example: 11346.56
                  message:
                    type: string
                    example: Pickup and destination addresses successfully verified
                  status:
                    type: boolean
                    example: true
              examples:
                success:
                  value:
                    data:
                      destinations:
                        - city: Lagos
                          country_code: NG
                          price:
                            amount: 28366.4
                            amount_payable: 22693.12
                            discount_amount: 5673.28
                            discount_description: 20% discount
                            discount_type: percentage
                            distance: 142 km
                            duration: 2 hours 4 mins
                          region:
                            latitude: 7.427026700000001
                            longitude: 3.8900142
                          state_code: LA
                        - city: Lagos
                          country_code: NG
                          price:
                            amount: 28366.4
                            amount_payable: 22693.12
                            discount_amount: 5673.28
                            discount_description: 20% discount
                            discount_type: percentage
                            distance: 142 km
                            duration: 2 hours 4 mins
                          region:
                            latitude: 7.427026700000001
                            longitude: 3.8900142
                          state_code: LA
                      discount_description: See the destination parcel details
                      discount_type: percentage
                      pickup_origin:
                        city: Lagos
                        country_code: NG
                        region:
                          latitude: 6.4612672
                          longitude: 3.3961466
                        state_code: LA
                      total_amount: 56732.8
                      total_amount_payable: 45386.24
                      total_discount_amount: 11346.56
                    message: Pickup and destination addresses successfully verified
                    status: true
        '400':
          description: pickup origin require / destiation  required
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache, private
            Connection:
              schema:
                type: string
                example: close
            Date:
              schema:
                type: string
                example: Wed, 28 Aug 2024 13:41:15 GMT
            Host:
              schema:
                type: string
                example: api.localhost:8000
            Vary:
              schema:
                type: string
                example: Origin
            X-Powered-By:
              schema:
                type: string
                example: PHP/8.3.9
            X-RateLimit-Limit:
              schema:
                type: string
                example: '60'
            X-RateLimit-Remaining:
              schema:
                type: string
                example: '59'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The pickup origin.state code field is required.
                  status:
                    type: boolean
                    example: false
              examples:
                destiation  required:
                  value:
                    message: The destinations field is required.
                    status: false
                pickup origin require:
                  value:
                    message: The pickup origin.state code field is required.
                    status: false
        '401':
          description: unauthorise access
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache, private
            Connection:
              schema:
                type: string
                example: close
            Date:
              schema:
                type: string
                example: Wed, 28 Aug 2024 13:39:19 GMT
            Host:
              schema:
                type: string
                example: api.localhost:8000
            Vary:
              schema:
                type: string
                example: Origin
            X-Powered-By:
              schema:
                type: string
                example: PHP/8.3.9
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Unauthenticated.
                  message:
                    type: string
                    example: unauthorised
                  status:
                    type: boolean
                    example: false
              examples:
                unauthorise access:
                  value:
                    data:
                      message: Unauthenticated.
                    message: unauthorised
                    status: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````