> ## 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

> This endpoint allows you to create a new CitySwiift (intral city) parcel delivery order. The request should be sent as an HTTP POST to {{open_api}}/parcel/intral/intral-city.

### Request Body

The request should include a JSON payload with the following structure:

- `pickup_origin`: Details of the pickup location including region, city, state code, country code, and contact information.
    
- `destinations`: An array containing details of the delivery destinations including region, formatted address, city, neighborhood, ward, local, state, state code, country, country code, postal code, and contact information.
    

### Response

The response will be in JSON format and will include the following fields:

- `status`: Indicates the status of the request (true/false).
    
- `message`: Additional information or error message.
    
- `data`: Contains the details of the created parcel order including tracking number, status, total amount, total discount amount, total amount payable, discount type, and discount description.



## OpenAPI

````yaml post /parcel/intral/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:
  /parcel/intral/intral-city:
    post:
      tags:
        - parcels
        - CitySwift (Intral city)
      summary: intral-city
      description: >-
        This endpoint allows you to create a new CitySwiift (intral city) parcel
        delivery order.
      operationId: intralCity1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                destinations:
                  type: array
                  items:
                    type: object
                    properties:
                      city:
                        type: string
                        example: Ojodu Berger
                      contacts:
                        type: object
                        properties:
                          email:
                            type: string
                            example: abdul@gmail.com
                          name:
                            type: string
                            example: Olakunle Olayemi
                          phone_number:
                            type: string
                            example: '09020500177'
                          phone_number_2:
                            type: string
                            example: '09020500177'
                      country:
                        type: string
                        example: Nigeria
                      country_code:
                        type: string
                        example: NG
                      formattedAddress:
                        type: string
                        example: Olowora, Ojodu Berger 105102, Lagos, Nigeria
                      lat:
                        type: number
                        example: 6.6395189
                      lng:
                        type: number
                        example: 3.3710171
                      local:
                        type: string
                        example: Kosofe
                      neighborhood:
                        type: string
                        example: Olowora
                      postal_code:
                        type: string
                        example: '105102'
                      region:
                        type: object
                        properties:
                          latitude:
                            type: number
                            example: 6.6395189
                          longitude:
                            type: number
                            example: 3.3710171
                      state:
                        type: string
                        example: Lagos
                      state_code:
                        type: string
                        example: LA
                      ward:
                        type: string
                        example: Isheri-Olowo-Ira/Shangisha/Magodo Phase I & II
                  example:
                    - city: Ojodu Berger
                      contacts:
                        email: abdul@gmail.com
                        name: Olakunle Olayemi
                        phone_number: '09020500177'
                        phone_number_2: '09020500177'
                      country: Nigeria
                      country_code: NG
                      formattedAddress: Olowora, Ojodu Berger 105102, Lagos, Nigeria
                      lat: 6.6395189
                      lng: 3.3710171
                      local: Kosofe
                      neighborhood: Olowora
                      postal_code: '105102'
                      region:
                        latitude: 6.6395189
                        longitude: 3.3710171
                      state: Lagos
                      state_code: LA
                      ward: Isheri-Olowo-Ira/Shangisha/Magodo Phase I & II
                pickup_origin:
                  type: object
                  properties:
                    city:
                      type: string
                      example: Ikeja
                    contacts:
                      type: object
                      properties:
                        email:
                          type: string
                          example: abdul@gmail.com
                        name:
                          type: string
                          example: Olakunle Olayemi
                        phone_number:
                          type: string
                          example: '09020500177'
                        phone_number_2:
                          type: string
                          example: '09020500177'
                    country_code:
                      type: string
                      example: NG
                    region:
                      type: object
                      properties:
                        latitude:
                          type: number
                          example: 6.594019599999999
                        longitude:
                          type: number
                          example: 3.336365099999999
                    state_code:
                      type: string
                      example: LA
            examples:
              intral-city:
                value:
                  destinations:
                    - city: Ojodu Berger
                      contacts:
                        email: abdul@gmail.com
                        name: Olakunle Olayemi
                        phone_number: '09020500177'
                        phone_number_2: '09020500177'
                      country: Nigeria
                      country_code: NG
                      formattedAddress: Olowora, Ojodu Berger 105102, Lagos, Nigeria
                      lat: 6.6395189
                      lng: 3.3710171
                      local: Kosofe
                      neighborhood: Olowora
                      postal_code: '105102'
                      region:
                        latitude: 6.6395189
                        longitude: 3.3710171
                      state: Lagos
                      state_code: LA
                      ward: Isheri-Olowo-Ira/Shangisha/Magodo Phase I & II
                  pickup_origin:
                    city: Ikeja
                    contacts:
                      email: abdul@gmail.com
                      name: Olakunle Olayemi
                      phone_number: '09020500177'
                      phone_number_2: '09020500177'
                    country_code: NG
                    region:
                      latitude: 6.594019599999999
                      longitude: 3.336365099999999
                    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: Tue, 08 Oct 2024 20:31:51 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:
                      discount_description:
                        type: string
                        example: See the destination parcel details
                      discount_type:
                        type: string
                        example: percentage
                      status:
                        type: string
                        example: Pending
                      total_amount:
                        type: number
                        example: 1427
                      total_amount_payable:
                        type: number
                        example: 1427
                      total_discount_amount:
                        type: number
                        example: 0
                      tracking_number:
                        type: string
                        example: '202410082201832'
                  message:
                    type: string
                    example: Parcel is successful
                  status:
                    type: boolean
                    example: true
              examples:
                success:
                  value:
                    data:
                      discount_description: See the destination parcel details
                      discount_type: percentage
                      status: Pending
                      total_amount: 1427
                      total_amount_payable: 1427
                      total_discount_amount: 0
                      tracking_number: '202410082201832'
                    message: Parcel is successful
                    status: true
        '400':
          description: bad request
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache, private
            Connection:
              schema:
                type: string
                example: close
            Date:
              schema:
                type: string
                example: Tue, 08 Oct 2024 20:28:08 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:
                  message:
                    type: string
                    example: The pickup origin.contacts.name field is required.
                  status:
                    type: boolean
                    example: false
              examples:
                bad request:
                  value:
                    message: The pickup origin.contacts.name field is required.
                    status: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````