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

# Track-parcel

> ### Track Parcel

This API endpoint is used to track a parcel using its tracking number.

#### Request Body

- `tracking_number` (string, required): The tracking number of the parcel to be tracked.
    

#### Response

The response will be a JSON object with the following properties:

- `status` (boolean): Indicates the status of the tracking request.
    
- `message` (string): A message related to the tracking request, if any.
    
- `data` (object): Contains information about the parcel's pickup origin, destinations, total amount, payment details, status, and timestamps.
    

The `pickup_origin` object within the `data` object contains details about the parcel's pickup location, including city, region, address, contacts, state code, country code, and pickup center.

The `destinations` array within the `data` object contains information about the parcel's destinations, including city, items, price, weight, address, contacts, state code, center code, country code, and dropoff center.

Other properties within the `data` object include `total_amount`, `total_discount_amount`, `total_amount_payable`, `discount_type`, `discount_description`, `tracking_number`, `complete_date`, `payment_method`, `status`, `payment_ref`, `cube_ref`, `ref`, `created_at`, and `updated_at`.

``` json
{
  "status": true,
  "message": "",
  "data": {
    "pickup_origin": {
      "city": "",
      "region": {
        "latitude": 0,
        "longitude": 0
      },
      "address": "",
      "vehicle": null,
      "contacts": {
        "name": "",
        "email": "",
        "phone_number": "",
        "phone_number_2": null
      },
      "state_code": "",
      "pickup_date": null,
      "pickup_note": null,
      "pickup_time": null,
      "country_code": "",
      "pickup_centre": {
        "centre_code": "",
        "centre_name": ""
      }
    },
    "pickup_date": null,
    "destinations": [
      {
        "city": "",
        "items": [
          {
            "name": "",
            "width": null,
            "height": null,
            "length": null
          }
        ],
        "price": {
          "amount": 0,
          "distance": "",
          "duration": "",
          "discount_type": "",
          "amount_payable": 0,
          "discount_amount": 0,
          "discount_description": ""
        },
        "weight": "",
        "address": "",
        "contacts": {
          "name": "",
          "email": "",
          "phone_number": "",
          "phone_number_2": null
        },
        "state_code": "",
        "centre_code": "",
        "item_weight": 0,
        "country_code": "",
        "delivery_note": null,
        "dropoff_centre": {
          "centre_code": "",
          "centre_name": ""
        }
      }
    ],
    "total_amount": 0,
    "total_discount_amount": 0,
    "total_amount_payable": 0,
    "discount_type": "",
    "discount_description": "",
    "tracking_number": "",
    "complete_date": null,
    "payment_method": "",
    "status": "",
    "payment_ref": null,
    "cube_ref": null,
    "ref": null,
    "created_at": "",
    "updated_at": ""
  }
}

 ```



## OpenAPI

````yaml post /parcel/logistics/track-parcel
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/logistics/track-parcel:
    post:
      tags:
        - parcels
        - FlexFlow
      summary: Track-parcel
      description: |-
        ### Track Parcel

        This API endpoint is used to track a parcel using its tracking number.
      operationId: trackParcel
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_number:
                  type: string
                  example: '202410086789949'
            examples:
              Track-parcel:
                value:
                  tracking_number: '202410086789949'
      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 21:11:14 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: '57'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      complete_date:
                        nullable: true
                        example: null
                      created_at:
                        type: string
                        example: '2024-10-08T21:09:31.000Z'
                      cube_ref:
                        nullable: true
                        example: null
                      destinations:
                        type: array
                        items:
                          type: object
                          properties:
                            address:
                              type: string
                              example: Ikolaba Rd, Ibadan 200285, Oyo, Nigeria
                            centre_code:
                              type: string
                              example: ibadan-sango
                            city:
                              type: string
                              example: Lagos
                            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:
                                  nullable: true
                                  example: null
                            country_code:
                              type: string
                              example: NG
                            delivery_note:
                              nullable: true
                              example: null
                            dropoff_centre:
                              type: object
                              properties:
                                centre_code:
                                  type: string
                                  example: ibadan-sango
                                centre_name:
                                  type: string
                                  example: Sango Ibadan
                            item_weight:
                              type: number
                              example: 1
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  height:
                                    nullable: true
                                    example: null
                                  length:
                                    nullable: true
                                    example: null
                                  name:
                                    type: string
                                    example: Book
                                  width:
                                    nullable: true
                                    example: null
                              example:
                                - height: null
                                  length: null
                                  name: Book
                                  width: null
                            price:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 3000.98
                                amount_payable:
                                  type: number
                                  example: 3000.98
                                discount_amount:
                                  type: number
                                  example: 0
                                discount_description:
                                  type: string
                                  example: 0% discount
                                discount_type:
                                  type: string
                                  example: Percetage
                                distance:
                                  type: string
                                  example: ' Kilometres to the drop off center '
                                duration:
                                  type: string
                                  example: 1-4 days
                            state_code:
                              type: string
                              example: LA
                            weight:
                              type: string
                              example: '1'
                        example:
                          - address: Ikolaba Rd, Ibadan 200285, Oyo, Nigeria
                            centre_code: ibadan-sango
                            city: Lagos
                            contacts:
                              email: abdul@gmail.com
                              name: Olakunle Olayemi
                              phone_number: '09020500177'
                              phone_number_2: null
                            country_code: NG
                            delivery_note: null
                            dropoff_centre:
                              centre_code: ibadan-sango
                              centre_name: Sango Ibadan
                            item_weight: 1
                            items:
                              - height: null
                                length: null
                                name: Book
                                width: null
                            price:
                              amount: 3000.98
                              amount_payable: 3000.98
                              discount_amount: 0
                              discount_description: 0% discount
                              discount_type: Percetage
                              distance: ' Kilometres to the drop off center '
                              duration: 1-4 days
                            state_code: LA
                            weight: '1'
                      discount_description:
                        type: string
                        example: 0% discount
                      discount_type:
                        type: string
                        example: Percetage
                      payment_method:
                        type: string
                        example: Mervii
                      payment_ref:
                        nullable: true
                        example: null
                      pickup_date:
                        nullable: true
                        example: null
                      pickup_origin:
                        type: object
                        properties:
                          address:
                            type: string
                            example: Ikolaba Rd, Ibadan 200285, Oyo, Nigeria
                          city:
                            type: string
                            example: Lagos
                          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:
                                nullable: true
                                example: null
                          country_code:
                            type: string
                            example: NG
                          pickup_centre:
                            type: object
                            properties:
                              centre_code:
                                type: string
                                example: lagos-ojodu-berger
                              centre_name:
                                type: string
                                example: Ojodu Berger Lagos
                          pickup_date:
                            nullable: true
                            example: null
                          pickup_note:
                            nullable: true
                            example: null
                          pickup_time:
                            nullable: true
                            example: null
                          region:
                            type: object
                            properties:
                              latitude:
                                type: number
                                example: 7.427026700000001
                              longitude:
                                type: number
                                example: 3.8900142
                          state_code:
                            type: string
                            example: LA
                          vehicle:
                            nullable: true
                            example: null
                      ref:
                        nullable: true
                        example: null
                      status:
                        type: string
                        example: Pending
                      total_amount:
                        type: number
                        example: 11192.94
                      total_amount_payable:
                        type: number
                        example: 11192.94
                      total_discount_amount:
                        type: number
                        example: 0
                      tracking_number:
                        type: string
                        example: '202410086789949'
                      updated_at:
                        type: string
                        example: '2024-10-08T21:09:31.000Z'
                  message:
                    type: string
                    example: ''
                  status:
                    type: boolean
                    example: true
              examples:
                success:
                  value:
                    data:
                      complete_date: null
                      created_at: '2024-10-08T21:09:31.000Z'
                      cube_ref: null
                      destinations:
                        - address: Ikolaba Rd, Ibadan 200285, Oyo, Nigeria
                          centre_code: ibadan-sango
                          city: Lagos
                          contacts:
                            email: abdul@gmail.com
                            name: Olakunle Olayemi
                            phone_number: '09020500177'
                            phone_number_2: null
                          country_code: NG
                          delivery_note: null
                          dropoff_centre:
                            centre_code: ibadan-sango
                            centre_name: Sango Ibadan
                          item_weight: 1
                          items:
                            - height: null
                              length: null
                              name: Book
                              width: null
                          price:
                            amount: 3000.98
                            amount_payable: 3000.98
                            discount_amount: 0
                            discount_description: 0% discount
                            discount_type: Percetage
                            distance: ' Kilometres to the drop off center '
                            duration: 1-4 days
                          state_code: LA
                          weight: '1'
                      discount_description: 0% discount
                      discount_type: Percetage
                      payment_method: Mervii
                      payment_ref: null
                      pickup_date: null
                      pickup_origin:
                        address: Ikolaba Rd, Ibadan 200285, Oyo, Nigeria
                        city: Lagos
                        contacts:
                          email: abdul@gmail.com
                          name: Olakunle Olayemi
                          phone_number: '09020500177'
                          phone_number_2: null
                        country_code: NG
                        pickup_centre:
                          centre_code: lagos-ojodu-berger
                          centre_name: Ojodu Berger Lagos
                        pickup_date: null
                        pickup_note: null
                        pickup_time: null
                        region:
                          latitude: 7.427026700000001
                          longitude: 3.8900142
                        state_code: LA
                        vehicle: null
                      ref: null
                      status: Pending
                      total_amount: 11192.94
                      total_amount_payable: 11192.94
                      total_discount_amount: 0
                      tracking_number: '202410086789949'
                      updated_at: '2024-10-08T21:09:31.000Z'
                    message: ''
                    status: true
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````