Developers Documentation For Logistics Company

Staging URL: https://staging-api.sharply.africa

Production URL: https://api.sharply.africa

Expectations:

Monetary figures are sent in multiple of 100 i.e. kobo value, send 500 to represent N5.

Sharply's API uses API Keys to authenticate requests. Get your API Key from settings page on the web app.

Add the API Key to the headers:

Authorization:

AUTHORIZATIONAPI Key

Key

Authorization

Value

<value>

Orders

AUTHORIZATIONAPI Key

This folder is using API Key from collectionDevelopers Documentation For Logistics Company

POSTCreate Order

https://staging-api.sharply.africa/orders

To create a shipping request, you send the order object:

sender: The details of the sender. It is an object with the ffg attributes: name, phoneNumber, email, address, coords. The coords (optional) holds the latitude and longitude info.

recipient: Accepts same properties as the sender object.

items: Array of items being sent

description (optional)

chargeRecipient: determines who is paying: sender or recipient? Set to true for recipient, false means sender is paying.

deliveryArea: The ID of the pricelist. pricelists is an array in the company's object. This records the general source -> destination and also determines the price.

rider: The id of the rider

AUTHORIZATIONAPI Key

This request is using API Key from collectionDevelopers Documentation For Logistics Company

Bodyraw (json)

json

{
    "app": "logistics",
    "pricelistType": "flatFee",
    "payOnDelivery": true,
    "company": "6170ad538f27e3002d228686",
    "rider": "616fdb2745cc68002d59dbac",
    "items": [
        {
            "quantity": 1,
            "item": "shoe"
        },
        {
            "quantity": 1,
            "item": "bag"
        }
    ],
    "vehicleType": "bike",
    "deliveryArea": "6336a82130f45b002dfc3562",
    "chargeRecipient": false,
    "requestedBy": "sender",
    "deliveryFee": 20000,
    "type": "pickup-delivery",
    "sender": {
        "name": "Salami Layor",
        "email": "tmsjnr@yahoo.com",
        "phoneNumber": "+2348113921091",
        "address": "28 Akinhanmi St, Surulere 101241, Lagos, Nigeria",
        "coords": {
            "lat": "6.5165826",
            "lng": "3.3631902"
        }
    },
    "recipient": {
        "name": "Remilekun Salami",
        "email": "remilekun.salami@gmail.com",
        "phoneNumber": "+2348113921090",
        "address": "2 Igbile St, Mende 105102, Lagos, Nigeria",
        "coords": {
            "lat": "6.5706563",
            "lng": "3.3742828"
        }
    }
}

GETGet Order

https://staging-api.sharply.africa/orders/6346770abbec8b0dd4dd1fa9

AUTHORIZATIONAPI Key

This request is using API Key from collectionDevelopers Documentation For Logistics Company