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

# states

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



## OpenAPI

````yaml get /utils/states
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:
  /utils/states:
    get:
      tags:
        - Utils
      summary: states
      description: |-
        ### Get States

        This endpoint retrieves a list of states.
      operationId: states
      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:33:12 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: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                          example: Abia State
                        state_code:
                          nullable: true
                          example: null
                        state_name:
                          type: string
                          example: Abia State
                        status:
                          type: string
                          example: Not Active
                        value:
                          type: number
                          example: 1
                    example:
                      - label: Abia State
                        state_code: null
                        state_name: Abia State
                        status: Not Active
                        value: 1
                      - label: Adamawa State
                        state_code: null
                        state_name: Adamawa State
                        status: Not Active
                        value: 2
                      - label: Akwa Ibom State
                        state_code: null
                        state_name: Akwa Ibom State
                        status: Not Active
                        value: 3
                      - label: Anambra State
                        state_code: null
                        state_name: Anambra State
                        status: Not Active
                        value: 4
                      - label: Bauchi State
                        state_code: null
                        state_name: Bauchi State
                        status: Not Active
                        value: 5
                      - label: Bayelsa State
                        state_code: null
                        state_name: Bayelsa State
                        status: Not Active
                        value: 6
                      - label: Benue State
                        state_code: null
                        state_name: Benue State
                        status: Not Active
                        value: 7
                      - label: Borno State
                        state_code: null
                        state_name: Borno State
                        status: Not Active
                        value: 8
                      - label: Cross River State
                        state_code: null
                        state_name: Cross River State
                        status: Not Active
                        value: 9
                      - label: Delta State
                        state_code: null
                        state_name: Delta State
                        status: Not Active
                        value: 10
                      - label: Ebonyi State
                        state_code: null
                        state_name: Ebonyi State
                        status: Not Active
                        value: 11
                      - label: Edo State
                        state_code: null
                        state_name: Edo State
                        status: Not Active
                        value: 12
                      - label: Ekiti State
                        state_code: null
                        state_name: Ekiti State
                        status: Not Active
                        value: 13
                      - label: Enugu State
                        state_code: null
                        state_name: Enugu State
                        status: Not Active
                        value: 14
                      - label: FCT
                        state_code: null
                        state_name: FCT
                        status: Not Active
                        value: 15
                      - label: Gombe State
                        state_code: null
                        state_name: Gombe State
                        status: Not Active
                        value: 16
                      - label: Imo State
                        state_code: null
                        state_name: Imo State
                        status: Not Active
                        value: 17
                      - label: Jigawa State
                        state_code: null
                        state_name: Jigawa State
                        status: Not Active
                        value: 18
                      - label: Kaduna State
                        state_code: null
                        state_name: Kaduna State
                        status: Not Active
                        value: 19
                      - label: Kano State
                        state_code: null
                        state_name: Kano State
                        status: Not Active
                        value: 20
                      - label: Katsina State
                        state_code: null
                        state_name: Katsina State
                        status: Not Active
                        value: 21
                      - label: Kebbi State
                        state_code: null
                        state_name: Kebbi State
                        status: Not Active
                        value: 22
                      - label: Kogi State
                        state_code: null
                        state_name: Kogi State
                        status: Not Active
                        value: 23
                      - label: Kwara State
                        state_code: null
                        state_name: Kwara State
                        status: Not Active
                        value: 24
                      - label: Lagos State
                        state_code: null
                        state_name: Lagos State
                        status: Not Active
                        value: 25
                      - label: Nasarawa State
                        state_code: null
                        state_name: Nasarawa State
                        status: Not Active
                        value: 26
                      - label: Niger State
                        state_code: null
                        state_name: Niger State
                        status: Not Active
                        value: 27
                      - label: Ogun State
                        state_code: null
                        state_name: Ogun State
                        status: Not Active
                        value: 28
                      - label: Ondo State
                        state_code: null
                        state_name: Ondo State
                        status: Not Active
                        value: 29
                      - label: Osun State
                        state_code: null
                        state_name: Osun State
                        status: Not Active
                        value: 30
                      - label: Oyo State
                        state_code: null
                        state_name: Oyo State
                        status: Not Active
                        value: 31
                      - label: Plateau State
                        state_code: null
                        state_name: Plateau State
                        status: Not Active
                        value: 32
                      - label: Rivers State
                        state_code: null
                        state_name: Rivers State
                        status: Not Active
                        value: 33
                      - label: Sokoto State
                        state_code: null
                        state_name: Sokoto State
                        status: Not Active
                        value: 34
                      - label: Taraba State
                        state_code: null
                        state_name: Taraba State
                        status: Not Active
                        value: 35
                      - label: Yobe State
                        state_code: null
                        state_name: Yobe State
                        status: Not Active
                        value: 36
                      - label: Zamfara State
                        state_code: null
                        state_name: Zamfara State
                        status: Not Active
                        value: 37
                  message:
                    type: string
                    example: Centres successfully fetched!
                  status:
                    type: boolean
                    example: true
              examples:
                success:
                  value:
                    data:
                      - label: Abia State
                        state_code: null
                        state_name: Abia State
                        status: Not Active
                        value: 1
                      - label: Adamawa State
                        state_code: null
                        state_name: Adamawa State
                        status: Not Active
                        value: 2
                      - label: Akwa Ibom State
                        state_code: null
                        state_name: Akwa Ibom State
                        status: Not Active
                        value: 3
                      - label: Anambra State
                        state_code: null
                        state_name: Anambra State
                        status: Not Active
                        value: 4
                      - label: Bauchi State
                        state_code: null
                        state_name: Bauchi State
                        status: Not Active
                        value: 5
                      - label: Bayelsa State
                        state_code: null
                        state_name: Bayelsa State
                        status: Not Active
                        value: 6
                      - label: Benue State
                        state_code: null
                        state_name: Benue State
                        status: Not Active
                        value: 7
                      - label: Borno State
                        state_code: null
                        state_name: Borno State
                        status: Not Active
                        value: 8
                      - label: Cross River State
                        state_code: null
                        state_name: Cross River State
                        status: Not Active
                        value: 9
                      - label: Delta State
                        state_code: null
                        state_name: Delta State
                        status: Not Active
                        value: 10
                      - label: Ebonyi State
                        state_code: null
                        state_name: Ebonyi State
                        status: Not Active
                        value: 11
                      - label: Edo State
                        state_code: null
                        state_name: Edo State
                        status: Not Active
                        value: 12
                      - label: Ekiti State
                        state_code: null
                        state_name: Ekiti State
                        status: Not Active
                        value: 13
                      - label: Enugu State
                        state_code: null
                        state_name: Enugu State
                        status: Not Active
                        value: 14
                      - label: FCT
                        state_code: null
                        state_name: FCT
                        status: Not Active
                        value: 15
                      - label: Gombe State
                        state_code: null
                        state_name: Gombe State
                        status: Not Active
                        value: 16
                      - label: Imo State
                        state_code: null
                        state_name: Imo State
                        status: Not Active
                        value: 17
                      - label: Jigawa State
                        state_code: null
                        state_name: Jigawa State
                        status: Not Active
                        value: 18
                      - label: Kaduna State
                        state_code: null
                        state_name: Kaduna State
                        status: Not Active
                        value: 19
                      - label: Kano State
                        state_code: null
                        state_name: Kano State
                        status: Not Active
                        value: 20
                      - label: Katsina State
                        state_code: null
                        state_name: Katsina State
                        status: Not Active
                        value: 21
                      - label: Kebbi State
                        state_code: null
                        state_name: Kebbi State
                        status: Not Active
                        value: 22
                      - label: Kogi State
                        state_code: null
                        state_name: Kogi State
                        status: Not Active
                        value: 23
                      - label: Kwara State
                        state_code: null
                        state_name: Kwara State
                        status: Not Active
                        value: 24
                      - label: Lagos State
                        state_code: null
                        state_name: Lagos State
                        status: Not Active
                        value: 25
                      - label: Nasarawa State
                        state_code: null
                        state_name: Nasarawa State
                        status: Not Active
                        value: 26
                      - label: Niger State
                        state_code: null
                        state_name: Niger State
                        status: Not Active
                        value: 27
                      - label: Ogun State
                        state_code: null
                        state_name: Ogun State
                        status: Not Active
                        value: 28
                      - label: Ondo State
                        state_code: null
                        state_name: Ondo State
                        status: Not Active
                        value: 29
                      - label: Osun State
                        state_code: null
                        state_name: Osun State
                        status: Not Active
                        value: 30
                      - label: Oyo State
                        state_code: null
                        state_name: Oyo State
                        status: Not Active
                        value: 31
                      - label: Plateau State
                        state_code: null
                        state_name: Plateau State
                        status: Not Active
                        value: 32
                      - label: Rivers State
                        state_code: null
                        state_name: Rivers State
                        status: Not Active
                        value: 33
                      - label: Sokoto State
                        state_code: null
                        state_name: Sokoto State
                        status: Not Active
                        value: 34
                      - label: Taraba State
                        state_code: null
                        state_name: Taraba State
                        status: Not Active
                        value: 35
                      - label: Yobe State
                        state_code: null
                        state_name: Yobe State
                        status: Not Active
                        value: 36
                      - label: Zamfara State
                        state_code: null
                        state_name: Zamfara State
                        status: Not Active
                        value: 37
                    message: Centres successfully fetched!
                    status: true
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````