.mint-block {
    display: block
}
.mint-hidden {
    display: none
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}

Get access to Mervii logistics Open API and SDK

Introduction

Library

Public API Key

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.

Mervii Documentation

envelope

Mervii is the infrastructure for e-commerce start-ups and SMEs to scale operations, efficiently accept payment, and fulfil orders conveniently. With Mervii's automated infrastructure businesses can reduce operation costs for fulfilling orders by 40%, and efficiently meet the customers' demand. 

Welcome to Mervii

Overview

Mervii infrastructure resources grant you access to the ranges of products with secure API keys.

Get API key

API keys

It's our pleasure to have here, Take a look at our detailed REST API documementation.

Authentication

### CitySwift (Intral city) Price Calculation

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

intral-city

### Centre (Hub) to Centre (Hub) Price

This endpoint is used to calculate the price for a delivery from a pickup centre to one or more destination centres.

Centre-Centre

### Centre(hub) to Door (home delivery) Price Calculation

This API endpoint allows you to calculate the price for delivering items from a pickup center to one or more destinations.

Centre-Door

**Home Pickup to Cenntre (Hub)**

**The** endpoint is used to calculate the price for delivering items from a pickup origin (home pickup) to one or more destinations, with a specific centre for the destination.

Door - Centre

## Home pickup - Home delivery

This endpoint allows you to calculate the price for door-to-door delivery. The request should be sent as an HTTP POST to {{open_api}}/price/door-door with the following payload in raw request body format:

Door-Door

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.

### Track Parcel

This endpoint allows you to track a parcel by providing the tracking number.

#### Request Body

- `tracking_number` (string): The tracking number of the parcel.
    

#### Response

- `status` (boolean): Indicates if the request was successful.
    
- `message` (string): A message related to the request.
    
- `data` (object): Contains information about the parcel and its journey.
    
    - `pickup_origin` (object): Details about the origin of the parcel pickup.
        
        - `city` (string): City of origin.
            
        - `region` (object): Geographic coordinates of the origin region.
            
        - `contacts` (object): Contact information for the origin pickup.
            
        - `state_code` (string): Code for the origin state.
            
        - `country_code` (string): Code for the origin country.
            
    - `destinations` (array): Array of destination objects containing details about the parcel's journey.
        
        - `lat` (number): Latitude of the destination.
            
        - `lng` (number): Longitude of the destination.
            
        - `city` (string): City of the destination.
            
        - `ward` (string): Ward of the destination.
            
        - `local` (string): Local information of the destination.
            
        - `price` (object): Details about the price and discount for the destination.
            
        - `state` (string): State of the destination.
            
        - `region` (object): Geographic coordinates of the destination region.
            
        - `country` (string): Country of the destination.
            
        - `contacts` (object): Contact information for the destination.
            
        - `state_code` (string): Code for the destination state.
            
        - `postal_code` (string): Postal code of the destination.
            
        - `country_code` (string): Code for the destination country.
            
        - `neighborhood` (string): Neighborhood of the destination.
            
        - `formattedAddress` (string): Formatted address of the destination.
            
    - `tracking_number` (string): The tracking number of the parcel.
        
    - `status` (string): Status of the parcel.
        
    - `total_amount` (string): Total amount related to the parcel.
        
    - `total_discount_amount` (string): Total discount amount related to the parcel.
        
    - `total_amount_payable` (string): Total amount payable for the parcel.
        
    - `discount_type` (string): Type of discount applied.
        
    - `discount_description` (string): Description of the discount.
        
    - `ref` (string): Reference related to the parcel.
        
    - `created_at` (string): Date and time of creation.
        
    - `updated_at` (string): Date and time of last update.

Tracking-parcel

This API endpoint allows you to create a new FlexFlow (door-to-door) parcel request. The HTTP POST request should be sent to {{open_api}}/parcel/logistics/door-door with the following payload in the raw request body:

``` json
{
  "pickup_origin": {
    "state_code": "LA",
    "country_code": "NG",
    "city": "Lagos",
    "address": "Ikolaba Rd, Ibadan 200285, Oyo ...",
    "region": {
      "latitude": 6.4612672,
      "longitude": 3.3961466
    },
    "contacts": {
      "name": "Olakunle Olayemi",
      "email": "abdul@gmail.com",
      "phone_number": "09020500177",
      "phone_number_2": ""
    },
    "pickup_note": "",
    "pickup_date": "",
    "pickup_time": "",
    "vehicle": ""
  },
  "destinations": [
    {
      "state_code": "LA",
      "country_code": "NG",
      "city": "Lagos",
      "address": "Ikolaba Rd, Ibadan 200285, Oyo ...",
      "region": {
        "latitude": 6.4612672,
        "longitude": 3.3961466
      },
      "contacts": {
        "name": "Olakunle Olayemi",
        "email": "abdul@gmail.com",
        "phone_number": "09020500177",
        "phone_number_2": ""
      },
      "delivery_note": "",
      "items": [
        {
          "name": "Book",
          "width": "",
          "length": "",
          "height": ""
        }
      ],
      "item_weight": 1
    }
  ]
}

 ```

The response to this request will include a JSON object with the following structure:

``` json
{
  "status": true,
  "message": "",
  "data": {
    "tracking_number": "",
    "status": "",
    "total_amount": 0,
    "total_discount_amount": 0,
    "total_amount_payable": 0,
    "discount_type": "",
    "discount_description": ""
  }
}

 ```

# FlexFlow Centre to Centre

This endpoint allows you to create a new FlexFlow request for parcel delivery from one centre to another centre.

### Request Body

- `pickup_origin`: Details of the pickup origin including the centre code, state code, country code, city, address, contacts, pickup note, pickup date, pickup time, and vehicle.
    
- `destinations`: An array of destination details including centre code, state code, country code, city, address, contacts, delivery note, items, and item weight.
    

### Response

In case of a successful request, the response will include:

- `tracking_number`: The unique tracking number for the parcel.
    
- `status`: The status of the delivery.
    
- `total_amount`: The total amount for the delivery.
    
- `total_discount_amount`: The total discount amount, if any.
    
- `total_amount_payable`: The total amount payable.
    
- `discount_type`: The type of discount applied.
    
- `discount_description`: Description of the discount.
    

In case of an error, the response will include the status code and a brief error message.

The HTTP POST request to /parcel/logistics/centre-door endpoint is used to create a logistics order for pickup and delivery. The request body should include details such as pickup origin, destinations, and items to be delivered.

### Request Body

- `pickup_origin` (object) - Details of the pickup origin including centre code, state code, country code, city, address, contacts, pickup note, pickup date, pickup time, and vehicle.
    
    - `centre_code` (string, optional) - Code of the pickup centre.
        
    - `state_code` (string) - Code of the state for pickup.
        
    - `country_code` (string) - Code of the country for pickup.
        
    - `city` (string) - City for pickup.
        
    - `address` (string) - Address for pickup.
        
    - `contacts` (object) - Contact details for pickup.
        
        - `name` (string) - Name of the contact person.
            
        - `email` (string) - Email of the contact person.
            
        - `phone_number` (string) - Phone number of the contact person.
            
        - `phone_number_2` (string, optional) - Additional phone number of the contact person.
            
    - `pickup_note` (string, optional) - Note for pickup.
        
    - `pickup_date` (string, optional) - Date for pickup.
        
    - `pickup_time` (string, optional) - Time for pickup.
        
    - `vehicle` (string, optional) - Vehicle for pickup.

        
- `destinations` (array) - Array of destination details.
    
    - `region` (object) - Region coordinates for delivery.
        
        - `latitude` (number) - Latitude of the region.
            
        - `longitude` (number) - Longitude of the region.
            
    - `state_code` (string) - Code of the state for delivery.
        
    - `country_code` (string) - Code of the country for delivery.
        
    - `city` (string) - City for delivery.
        
    - `address` (string) - Address for delivery.
        
    - `contacts` (object) - Contact details for delivery.
        
        - `name` (string) - Name of the contact person.
            
        - `email` (string) - Email of the contact person.
            
        - `phone_number` (string) - Phone number of the contact person.
            
        - `phone_number_2` (string, optional) - Additional phone number of the contact person.
            
    - `delivery_note` (string, optional) - Note for delivery.
        
    - `items` (array) - Array of items to be delivered.
        
        - `name` (string) - Name of the item.
            
        - `width` (string, optional) - Width of the item.
            
        - `length` (string, optional) - Length of the item.
            
        - `height` (string, optional) - Height of the item.
            
    - `item_weight` (number) - Weight of the item.

        

### Response

The response is in the form of a JSON schema with the following properties:

- `status` (boolean) - Indicates the status of the request.
    
- `message` (string) - Message related to the request status.
    
- `data` (object) - Data object containing the details of the logistics order.
    
    - `tracking_number` (string) - Tracking number for the order.
        
    - `status` (string) - Status of the order.
        
    - `total_amount` (number) - Total amount for the order.
        
    - `total_discount_amount` (number) - Total discount amount for the order.
        
    - `total_amount_payable` (number) - Total amount payable for the order.
        
    - `discount_type` (string) - Type of discount applied.
        
    - `discount_description` (string) - Description of the discount.

This API endpoint allows you to create a new logistics order for door-to-centre parcel delivery. The request should be sent as an HTTP POST to {{open_api}}/parcel/logistics/door-centre.

### Request Body

The request body should be sent in raw format and should include the following parameters:

- `pickup_origin`: Details of the pickup location including region, state code, country code, city, address, contacts, pickup note, pickup date, pickup time, and vehicle.
    
- `destinations`: An array containing details of the destination centre, including centre code, state code, country code, city, address, contacts, delivery note, items, and item weight.
    

### Response

Upon successful creation of the logistics order, the API will respond with the following parameters:

- `status`: A boolean indicating the status of the request.
    
- `message`: An optional message related to the request.
    
- `data`: An object containing details of the created order, including tracking number, status, total amount, total discount amount, total amount payable, discount type, and discount description.
    

Example Response:

``` json
{
    "status": true,
    "message": "",
    "data": {
        "tracking_number": "",
        "status": "",
        "total_amount": 0,
        "total_discount_amount": 0,
        "total_amount_payable": 0,
        "discount_type": "",
        "discount_description": ""
    }
}

 ```

Door-centre

### 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": ""
  }
}

 ```

Track-parcel

This endpoint makes an HTTP GET request to retrieve all parcel logistics. The request does not require any specific parameters in the request body. The response will include a status indicating the success of the request, a message if applicable, and a data array containing details of all parcels.

The data array includes information about the pickup origin, pickup date, destinations, total amount, total discount amount, total amount payable, discount type, discount description, tracking number, complete date, payment method, status, payment reference, cube reference, and timestamps for creation and update.

Each parcel within the data array contains details about the pickup origin, including the city, region, sender information, address, country code, and pickup centre. It also includes pickup date, destination details such as city, items, price, region, weight, address, receiver information, state code, item weight, country code, delivery note, and dropoff centre.

The price object within the destination includes amount, distance, duration, discount type, amount payable, discount amount, and discount description.

Please note that the actual values for the keys such as name, email, phone, and address are intentionally masked for privacy.

All-parcel

The endpoint makes an HTTP GET request to retrieve the pending parcels in the logistics system. The response is a JSON object with a "status" field indicating the success status, a "message" field for any additional information, and a "data" array containing details of the pending parcels.

The "data" array includes information about the pickup origin, pickup date, destinations, total amount, discounts, tracking number, payment method, status, and other relevant details for each pending parcel.

Here is the JSON schema for the response:

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pickup_origin": {
            "type": "object",
            "properties": {
              // Properties for pickup origin details
            }
          },
          "pickup_date": {
            "type": "string"
          },
          "destinations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                // Properties for destination details
              }
            }
          },
          "total_amount": {
            "type": "number"
          },
          "total_discount_amount": {
            "type": "number"
          },
          "total_amount_payable": {
            "type": "number"
          },
          "discount_type": {
            "type": "string"
          },
          "discount_description": {
            "type": "string"
          },
          "tracking_number": {
            "type": "string"
          },
          "complete_date": {
            "type": "string"
          },
          "payment_method": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "payment_ref": {
            "type": ["string", "null"]
          },
          "cube_ref": {
            "type": ["string", "null"]
          },
          "ref": {
            "type": ["string", "null"]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        }
      }
    }
  }
}

 ```

Pending

This endpoint makes an HTTP GET request to retrieve the processing status of parcels in the logistics system.

### Request Body

This request does not require a request body.

### Response

- `status` (boolean): Indicates the success or failure of the request.
    
- `message` (string): Provides any additional information or error messages.
    
- `data` (array): Contains the processing status of the parcels.
    

#### Example Response

``` json
{
    "status": true,
    "message": "",
    "data": []
}

 ```

Processing

This endpoint makes an HTTP GET request to retrieve information about processed parcels in the logistics system.

### Request

No request body is required for this endpoint.

### Response

The response will contain a list of processed parcel information, including details such as parcel ID, recipient name, delivery status, and timestamp.

Processed

### Retrieve Transit Parcels

This endpoint allows you to retrieve the transit parcels for logistics.

#### Request

- Method: `GET`
    
- URL: `{{open_api}}/parcel/logistics/transit-parcel`
    

#### Response

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

 ```

Transit

### Get Delivered Parcel Logistics

This endpoint retrieves the details of delivered parcels in the logistics system.

#### Request

No request body is required for this endpoint.

- `open_api` - The base URL for the API.
    

#### Response

The response for this request follows the JSON schema below:

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

 ```

Delivered

This endpoint makes an HTTP GET request to retrieve the details of completed parcels in the logistics system.

### Request

No request body is required for this endpoint.

### Response

- `status` (boolean): Indicates the status of the request.
    
- `message` (string): Provides any relevant message regarding the request.
    
- `data` (array): Contains the details of completed parcels in the logistics system.

Completed

### Get States

This endpoint retrieves a list of states.

**Request Body**  
This request does not require a request body.

**Response**

- `status` (boolean): Indicates the status of the response.
    
- `message` (string): Provides any additional information related to the response.
    
- `data` (array): Contains an array of state objects.
    
    - `state_name` (string): The name of the state.
        
    - `state_code` (string): The code associated with the state.
        
    - `status` (string): The status of the state.
        
    - `label` (string): The label of the state.
        
    - `value` (number): The value associated with the state.

states

### GET /utils/centres

This endpoint retrieves a list of centres.

#### Request

No request body is required for this request.

#### Response

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

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "centre_name": {
            "type": "string"
          },
          "centre_code": {
            "type": "string"
          },
          "centre_location": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string"
              },
              "ward": {
                "type": "string"
              },
              "local": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "region": {
                "type": "object",
                "properties": {
                  "latitude": {
                    "type": "number"
                  },
                  "longitude": {
                    "type": "number"
                  }
                }
              },
              "country": {
                "type": "string"
              },
              "state_code": {
                "type": "string"
              },
              "postal_code": {
                "type": "string"
              },
              "country_code": {
                "type": "string"
              },
              "neighborhood": {
                "type": "string"
              },
              "formattedAddress": {
                "type": "string"
              }
            }
          },
          "status": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  }
}

 ```

centres

This endpoint makes an HTTP GET request to retrieve weight-related utility information from the specified API.

### Request

The request does not require any specific input parameters.

### Response

- **Status 404** indicates that the requested resource was not found.
    
- The response is in JSON format with the following structure:
    
    - `status`: A boolean value indicating the success of the request.
        
    - `message`: A message providing additional information about the request.
        
    - `data`: An array containing weight-related information, including:
        
        - `weight`: The weight value.
            
        - `weight_code`: The code associated with the weight.
            
        - `description`: A description of the weight.

            

#### Example Response

``` json
{
    "status": true,
    "message": "",
    "data": [
        {
            "weight": "",
            "weight_code": "",
            "description": ""
        }
    ]
}

 ```

weight

Cube is built to be flexible and scalable, catering to the needs of growing businesses. Our developer-friendly SDK allow you to seamlessly integrate Mervii’s functionality into your own systems within minutes, enabling a smooth connection between your e-commerce platform and Mervii’s robust logistics, payment, and delivery services. 

Introduction

Mobile