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

# Centre-Door

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

#### Request Body

- `pickup_origin` (object)
    
    - `state_code` (string, optional): The state code of the pickup origin.
        
    - `country_code` (string, optional): The country code of the pickup origin.
        
    - `centre_code` (string): The code of the pickup center.
        
    - `address` (string, optional): The address of the pickup origin.

        
- `destinations` (array)
    
    - `country_code` (string): The country code of the destination.
        
    - `state_code` (string): The state code of the destination.
        
    - `city` (string, optional): The city of the destination.
        
    - `region` (object)
        
        - `latitude` (number): The latitude of the destination.
            
        - `longitude` (number): The longitude of the destination.
            
    - `item_weight` (number): The weight of the item to be delivered.

        

#### Response Body (JSON Schema)

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "pickup_origin": {
          "type": "object",
          "properties": {
            "state_code": { "type": ["string", "null"] },
            "country_code": { "type": ["string", "null"] },
            "centre_code": { "type": "string" },
            "address": { "type": ["string", "null"] },
            "pickup_centre": {
              "type": "object",
              "properties": {
                "centre_code": { "type": "string" },
                "centre_name": { "type": "string" }
              }
            }
          }
        },
        "destinations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "country_code": { "type": "string" },
              "state_code": { "type": "string" },
              "city": { "type": ["string", "null"] },
              "region": {
                "type": "object",
                "properties": {
                  "latitude": { "type": "number" },
                  "longitude": { "type": "number" }
                }
              },
              "item_weight": { "type": "number" },
              "dropoff_centre": {
                "type": "object",
                "properties": {
                  "centre_code": { "type": "string" },
                  "centre_name": { "type": "string" }
                }
              },
              "price": {
                "type": "object",
                "properties": {
                  "amount": { "type": "number" },
                  "discount_amount": { "type": "number" },
                  "amount_payable": { "type": "number" },
                  "discount_type": { "type": "string" },
                  "discount_description": { "type": "string" },
                  "distance": { "type": "string" },
                  "duration": { "type": "string" },
                  "weight": { "type": "string" }
                }
              }
            }
          }
        },
        "total_amount": { "type": "number" },
        "total_discount_amount": { "type": "number" },
        "total_amount_payable": { "type": "number" },
        "discount_type": { "type": "string" },
        "discount_description": { "type": "string" }
      }
    }
  }
}

 ```



## OpenAPI

````yaml post /price/centre-door
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/centre-door:
    post:
      tags:
        - prices
      summary: Centre-Door
      description: >-
        ### 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.
      operationId: centreDoor
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                destinations:
                  type: array
                  items:
                    type: object
                    properties:
                      city:
                        type: string
                        example: ''
                      country_code:
                        type: string
                        example: NG
                      item_weight:
                        type: number
                        example: 1
                      region:
                        type: object
                        properties:
                          latitude:
                            type: number
                            example: 7.427026700000001
                          longitude:
                            type: number
                            example: 3.8900142
                      state_code:
                        type: string
                        example: LA
                  example:
                    - city: ''
                      country_code: NG
                      item_weight: 1
                      region:
                        latitude: 7.427026700000001
                        longitude: 3.8900142
                      state_code: LA
                    - city: ''
                      country_code: NG
                      item_weight: 1
                      region:
                        latitude: 7.427026700000001
                        longitude: 3.8900142
                      state_code: LA
                pickup_origin:
                  type: object
                  properties:
                    addresss:
                      type: string
                      example: ''
                    centre_code:
                      type: string
                      example: ''
                    country_code:
                      type: string
                      example: ''
                    state_code:
                      type: string
                      example: ''
            examples:
              Centre-Door:
                value:
                  destinations:
                    - city: ''
                      country_code: NG
                      item_weight: 1
                      region:
                        latitude: 7.427026700000001
                        longitude: 3.8900142
                      state_code: LA
                    - city: ''
                      country_code: NG
                      item_weight: 1
                      region:
                        latitude: 7.427026700000001
                        longitude: 3.8900142
                      state_code: LA
                  pickup_origin:
                    addresss: ''
                    centre_code: ''
                    country_code: ''
                    state_code: ''
      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 19:43:36 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:
                              nullable: true
                              example: null
                            country_code:
                              type: string
                              example: NG
                            dropoff_centre:
                              type: object
                              properties:
                                centre_code:
                                  type: string
                                  example: lagos-ojodu-berger
                                centre_name:
                                  type: string
                                  example: Ojodu Berger Lagos
                            item_weight:
                              type: number
                              example: 1
                            price:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 11692.520875080363
                                amount_payable:
                                  type: number
                                  example: 11692.520875080363
                                discount_amount:
                                  type: number
                                  example: 0
                                discount_description:
                                  type: string
                                  example: 0% discount
                                discount_type:
                                  type: string
                                  example: Percetage
                                distance:
                                  type: string
                                  example: >-
                                    68.26634062567 Kilometres to the drop off
                                    center 
                                duration:
                                  type: string
                                  example: 1-4 days
                            region:
                              type: object
                              properties:
                                latitude:
                                  type: number
                                  example: 7.427026700000001
                                longitude:
                                  type: number
                                  example: 3.8900142
                            state_code:
                              type: string
                              example: LA
                            weight:
                              type: string
                              example: '1'
                        example:
                          - city: null
                            country_code: NG
                            dropoff_centre:
                              centre_code: lagos-ojodu-berger
                              centre_name: Ojodu Berger Lagos
                            item_weight: 1
                            price:
                              amount: 11692.520875080363
                              amount_payable: 11692.520875080363
                              discount_amount: 0
                              discount_description: 0% discount
                              discount_type: Percetage
                              distance: >-
                                68.26634062567 Kilometres to the drop off
                                center 
                              duration: 1-4 days
                            region:
                              latitude: 7.427026700000001
                              longitude: 3.8900142
                            state_code: LA
                            weight: '1'
                          - city: null
                            country_code: NG
                            dropoff_centre:
                              centre_code: lagos-ojodu-berger
                              centre_name: Ojodu Berger Lagos
                            item_weight: 1
                            price:
                              amount: 11692.520875080363
                              amount_payable: 11692.520875080363
                              discount_amount: 0
                              discount_description: 0% discount
                              discount_type: Percetage
                              distance: >-
                                68.26634062567 Kilometres to the drop off
                                center 
                              duration: 1-4 days
                            region:
                              latitude: 7.427026700000001
                              longitude: 3.8900142
                            state_code: LA
                            weight: '1'
                      discount_description:
                        type: string
                        example: 0% discount
                      discount_type:
                        type: string
                        example: Percetage
                      pickup_origin:
                        type: object
                        properties:
                          addresss:
                            nullable: true
                            example: null
                          centre_code:
                            type: string
                            example: ibadan-sango
                          country_code:
                            nullable: true
                            example: null
                          pickup_centre:
                            type: object
                            properties:
                              centre_code:
                                type: string
                                example: ibadan-sango
                              centre_name:
                                type: string
                                example: Sango Ibadan
                          state_code:
                            nullable: true
                            example: null
                      total_amount:
                        type: number
                        example: 23385.041750160726
                      total_amount_payable:
                        type: number
                        example: 23385.041750160726
                      total_discount_amount:
                        type: number
                        example: 0
                  message:
                    type: string
                    example: get price
                  status:
                    type: boolean
                    example: true
              examples:
                success:
                  value:
                    data:
                      destinations:
                        - city: null
                          country_code: NG
                          dropoff_centre:
                            centre_code: lagos-ojodu-berger
                            centre_name: Ojodu Berger Lagos
                          item_weight: 1
                          price:
                            amount: 11692.520875080363
                            amount_payable: 11692.520875080363
                            discount_amount: 0
                            discount_description: 0% discount
                            discount_type: Percetage
                            distance: '68.26634062567 Kilometres to the drop off center '
                            duration: 1-4 days
                          region:
                            latitude: 7.427026700000001
                            longitude: 3.8900142
                          state_code: LA
                          weight: '1'
                        - city: null
                          country_code: NG
                          dropoff_centre:
                            centre_code: lagos-ojodu-berger
                            centre_name: Ojodu Berger Lagos
                          item_weight: 1
                          price:
                            amount: 11692.520875080363
                            amount_payable: 11692.520875080363
                            discount_amount: 0
                            discount_description: 0% discount
                            discount_type: Percetage
                            distance: '68.26634062567 Kilometres to the drop off center '
                            duration: 1-4 days
                          region:
                            latitude: 7.427026700000001
                            longitude: 3.8900142
                          state_code: LA
                          weight: '1'
                      discount_description: 0% discount
                      discount_type: Percetage
                      pickup_origin:
                        addresss: null
                        centre_code: ibadan-sango
                        country_code: null
                        pickup_centre:
                          centre_code: ibadan-sango
                          centre_name: Sango Ibadan
                        state_code: null
                      total_amount: 23385.041750160726
                      total_amount_payable: 23385.041750160726
                      total_discount_amount: 0
                    message: get price
                    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 19:44:54 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.centre code field is required.
                  status:
                    type: boolean
                    example: false
              examples:
                Bad request:
                  value:
                    message: The pickup origin.centre code field is required.
                    status: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````