Merchant_api.php

Merchant API

Swifno API - Public

Welcome to Swifno's Shipping API Service. Here are some pre-made requests for you to explore the API using Postman.

Merchant API Keys

You'll need your API keys, Download the Swifno mobile application .

There is only one Merchany key for your platform which can be used for both the test production and live production.

Think of your merchant key like a password:

Store it securely
Don't share it with anyone outside of your organization
Don't put it in any code on your website or in a Url that someone could find

Different calls in the API your merchant key. For example, creating and managing Delivery, Requesting for Delivery Prices requires your platform's merchant key. Check each call for the requirements.

Setup

NOTE: You'll need to create an environment in Postman, select that environment, and enter your platform's api keys in the 0 - Setup/Environment Setup pre-request script (documentation on pre-request scripts) to set the environment variables.

API Environments

Environment	API Base Url
Sandbox	swifno.com/sandbox
Production	swifno.com

Notes:

Your platform will have the same Merchant API keys for each environment.
Data created or modified in each environment will not affect the other.
Data can be transfered from one environment to the other.

Delivery Test Environment

The delivery environment gives you the opportunity to see the go around of swifno delivery activities and also gives you the priviledge to copy the activity codes involved in the integration.

To access this link, Kindly Click here

API Pricing

Click here for information on our API pricing.

Questions/Comments/Suggestions

If you have any questions or comments, please let us know at info@swifno.com.

Authentication API

API :

https://swifno.com/v1/api.php?action=authentication&merchant_key=7fL5C7XoFpTEJ9gR&secret_key=0PuRWvsYNalaW9Xu

Params

ACTION :

authentication
This is the defined function of the api to be performed to achieve the result on getting authentication token

merchant_key :

7fL5C7XoFpREJ9gR
This is Merchant Key for your account

secret_key :

0PuRWvsYNalaW9XU
This is Secret Key for your account

Example Request

https://swifno.com/v1/api.php?action=authentication&merchant_key=7fL5C7XoFpTEJ9gR&secret_key=0PuRWvsYNalaW9Xu

Example RESPONSE

 {
        "RESPONSECODE": 1,
        "RESPONSEMESSAGE": "Success",
        "AUTHTOKEN":"a6cd37b58fdeaf61b98e45e3092ff59b"
    }

Couriers API

API :

https://swifno.com/v1/api.php?action=couriers&pickup=borno, nigeria&dropoff=abia,umuahia,nigeria&auth_token=208a000c813994fa745786b9a017a867

Params

ACTION :

couriers
This is the defined function of the api to be performed to get the list of courier for pickup and dropoff locations.

pickup :

borno, nigeria
This is the pickup location

dropoff :

abia,umuahia,nigeria
This is the dfopoff location

auth_token :

208a000c813994fa745786b9a017a867
This is the auth token

Example Request

https://swifno.com/v1/api.php?action=couriers&pickup=borno, nigeria&dropoff=abia,umuahia,nigeria&auth_token=208a000c813994fa745786b9a017a867

Example RESPONSE

 {
        "RESPONSECODE": 1,
        "RESPONSEMESSAGE": "Success",
        "VENDOR_LIST": Array of vendors
    }

Estimate API

API :

https://swifno.com/v1/api.php?action=estimate&pickup=borno, nigeria&dropoff=abia, umuahia, nigeria&category=Apparel&size=large&insurance=0&auth_token=208a000c813994fa745786b9a017a867

Params

ACTION :

estimate
This is the defined function of the api to be performed to get the estimation for package.

pickup :

borno, nigeria
This is the pickup location

dropoff :

abia,umuahia,nigeria
This is the dfopoff location

category :

Apparel
This is the category

size :

Large
This is the size

insurance :

0
This is the insurance

auth_token :

208a000c813994fa745786b9a017a867
This is the auth_token

Example Request

https://swifno.com/v1/api.php?action=estimate&pickup=borno, nigeria&dropoff=abia, umuahia, nigeria&category=Apparel&size=large&insurance=0&auth_token=208a000c813994fa745786b9a017a867

EXAMPLE SUCCESSFUL RESPONSE

 {
        "RESPONSECODE": 1,
        "RESPONSEMESSAGE": "Success",
        "ESTIMATION": 7,250
    }

EXAMPLE ERROR RESPONSE

{
    "RESPONSECODE":0,
    "ERROR_CODE":"03",
    "ERROR_MSG":"Invalid Pickup Location"
}
Error Codes
01 = Invalid Merchant Key
02 = Invalid Dropoff Location
03 = Invalid Pickup Location
04 = Invalid Package Category
05 = Invalid Package Size
06 = No Available Couriers

Package Category API

API :

https://swifno.com/api.php?action=categories&auth_token=208a000c813994fa745786b9a017a867

Params

ACTION :

categories
This is the defined function of the api to be performed to achieve the result on getting all the available category for product pickup deliveries

auth_token :

208a000c813994fa745786b9a017a867
This is authentication token

Example Request

https://swifno.com/api.php?action=categories&auth_token=208a000c813994fa745786b9a017a867

EXAMPLE SUCCESSFUL RESPONSE

{   
	"RESPONSECODE":1,
   	"RESPONSEMESSAGE":"Success",
   	"CATEGORYLIST":[
		{
         	"cat_id":"52",
         	"cat_name":"Apparel",
         	"group_name":"CLOTHING"      
		},
		{
         	"cat_id":"50",
         	"cat_name":"Appliance Parts",
         	"group_name":"OFFICIAL ITEMS"
		},
		{
         	"cat_id":"50",
         	"cat_name":"Appliance Parts",
         	"group_name":"ELECTRONICS"
		}
	]
}

EXAMPLE ERROR RESPONSE

{
"RESPONSECODE":0,
"ERROR_CODE":"11",
"ERROR_MSG":"Invalid Request Token"
}
Error Codes
11 = Invalid Request Token
12 = Expired Request Token
13 = Used Request Token
14 = Invalid Bid Id
15 = Courier No Longer Available
16 = Invalid Recipient Name
17 = Invalid Recipient Number
18 = Some error occurred, please try again

Package Size API

API :

https://swifno.com/api.php?action=sizes&auth_token=208a000c813994fa745786b9a017a867

Params

ACTION :

sizes
This is the defined function of the api to be performed to achieve the result on getting all the available package sizes for product pickup deliveries

auth_token :

208a000c813994fa745786b9a017a867
This is authentication token

Example Request

https://swifno.com/api.php?action=sizes&auth_token=208a000c813994fa745786b9a017a867

Example RESPONSE

 {
        "RESPONSECODE": 1,
        "RESPONSEMESSAGE": "Success",
        "SIZELIST": [
          {
            "size_id": "8",
            "size_name": "Very Small"
          },
          {
            "size_id": "7",
            "size_name": "Small"
          },
          {
            "size_id": "6",
            "size_name": "Medium"
          }
        ]
    }

Request Bid API

API :

http://swifno.com/api.php?action=bids&auth_token=208a000c813994fa745786b9a017a867&pickup=Borno ,Nigeria&dropoff=Zamfara ,Nigeria&category=Apparel&size=large&insurance=0&itemvalue=0

Params

ACTION :

bids
This is the defined function of the api to be performed to achieve the result for sending preloaded image for product pickup deliveries

auth_token :*

208a000c813994fa745786b9a017a867
This is your authentication token

Pickup Location :*

borno, nigeria
This value is provided as actual address of the Merchant

Drop Location :*

zamfara, nigeria
This value is provided as actual address of the delivery client

Package Category :*

apparel
This value is required from the Show Delivery Package Category

Package Size :*

large
This value is required from the Show Delivery Package Size

Insurance :

0
This value is provided as an actual itemvalue amount if the product on delivery is under insurance

Itemvalue :

0
This value is provided if the between 1 and 0. If the product of delivery has an insurance, the value would be 1 else 0

Example Request

http://swifno.com/api.php?action=bids&auth_token=208a000c813994fa745786b9a017a867&pickup=Borno ,Nigeria&dropoff=Zamfara ,Nigeria&category=Apparel&size=large&insurance=0&itemvalue=0

Example RESPONSE

{
	"RESPONSECODE":1,
	"TOKEN":"D5rIH78DUD1M40eIj1TiowPvR0IW02bH",
	"COURIERLIST":
	[
		{
			"bid_id":1,
			"company_name":"Nubianz Inc",
			"bid_amount":13050,
			"cash_on_delivery":"1",
			"delivery_speed":"3 Business Days"
		}
	]
}

Add Package API

API :

http://swifno.com/api.php?action=delivery_request&request_token=MVyM876z9BlRim3Mv9bPwkb7rtK9K3EW& recipient_name=test name&recipient_mobile=08067832456&pickup_from_time=08:00 am&pickup_to_time=08:00 pm&dropoff_from_time=08:00 am&dropoff_to_time=08:00 pm&additional_info=testing api&package_name=Testforcomplete&bid_id=1

Params

ACTION :

delivery_request
his is the defined function of the api to be performed to send merchant delivery request to swifno

Request Token :*

MVyM876z9BlRim3Mv9bPwkb7rtK9K3EW
This is your private access token, which will authenticate your request, it is valid for 1 hour. This will be return from Request Bid

Recipient Name :*

test name
This value is provided as the information of name of client on delivery request

Recipient Mobile :*

08067832456
This value is provided as the information of available phone contact of client on delivery request

Pickup From Time :

08:00 am
This value is provided as the specific pickup from time, from merchant

Pickup To Time :

08:00 pm
This value is provided as the specific pickup to time, from merchant

Dropoff From Time :

08:00 am
This value is provided as the specific dropoff from time, from merchant

Dropoff To Time :

08:00 pm
This value is provided as the specific dropoff to time, from merchant

Additional Detail :

testing api
This value is provided as an extra information of client on delivery request

Package Name :

Testforcomplete
This value is provided as the specific names of product for delivery

Bid Id :*

1
This value will be coming from the Request Bid

Example Request

http://swifno.com/api.php?action=delivery_request&request_token=MVyM876z9BlRim3Mv9bPwkb7rtK9K3EW&
recipient_name=test name&recipient_mobile=08067832456&pickup_from_time=08:00 am&pickup_to_time=08:00 pm&dropoff_from_time=08:00 am&dropoff_to_time=08:00 pm&additional_info=testing api&package_name=Testforcomplete&bid_id=1

Example RESPONSE

 {
        "RESPONSECODE": 1,
        "RESPONSEMESSAGE": "Request Added Successfully"
    }

Merchant API

Swifno API - Public

Merchant API Keys

Setup

API Environments

Delivery Test Environment

API Pricing

Questions/Comments/Suggestions

Authentication API

Params

Example Request

Example RESPONSE

Couriers API

Params

Example Request

Example RESPONSE

Estimate API

Params

Example Request

EXAMPLE SUCCESSFUL RESPONSE

EXAMPLE ERROR RESPONSE

Error Codes

Package Category API

Params

Example Request

EXAMPLE SUCCESSFUL RESPONSE

EXAMPLE ERROR RESPONSE

Error Codes

Package Size API

Params

Example Request

Example RESPONSE

Request Bid API

Params

Example Request

Example RESPONSE

Add Package API

Params

Example Request

Example RESPONSE

Social media