Sender API

Sender API

Agent 3

All request for the agent

Description

If you want to register as an agent

Body
{
    "Fullname": "{Fullname}",
    "Email": "{Email}",
    "CountryId": "{CountryId}",
    "CityId": "{CityId}",
    "Address": "{Address}",
    "Mobile": "{Mobile without the country code}",
    "AgentTypeId": "{AgentTypeId}",
    "IsBranch": "{boolean}",
    "LocationLat": "{latitude}",
    "LocationLong": "{longitude}"
}
Description

Get all agent types that can used for define the register agent

Description

If you want to update the agent profile

Body
{
    "AgentId": "{AgentId}",
    "Fullname": "{Fullname}",
    "Email": "{Email}",
    "CountryId": "{CountryId}",
    "CityId": "{CityId}",
    "Address": "{Address}",
    "Mobile": "{Mobile without the country code}",
    "AgentTypeId": "{AgentTypeId}",
    "IsBranch": "{boolean}",
    "LocationLat": "{latitude}",
    "LocationLong": "{longitude}"
}

Captain 2

All requests for captain

Description

If you want to request a captain

Body
{
    "AgentId": "{AgentId}",
    "PickupLocationLat": "{latitude}",
    "PickupLocationLong": "{longitude}",
    "DropLocationLat": "{latitude}",
    "DropLocationLong": "{longitude}",
    "CustomerName": "{CustomerName}",
    "CustomerPhone": "{Customer mobile phone number with the country code}",
    "CustomerAddres": "{CustomerAddres}",
    "PaymentTypeId": "{PaymentTypeId}",
    "Description": "{description}",
    "ProductTypeId": "{ProductTypeId}",
    "OrderItems": [
        {
            "Item": "{item name}",
            "Quantity": 1,
            "Price": "{price}",
            "Description": "{description}"
        },
        {
            "Item": "{item name}",
            "Quantity": 1,
            "Price": "{price}",
            "Description": "{description}"
        }
    ]
}

Countries & Cities 5

To get all data information of counties and cities

Order 6

Get all data information about orders for specific agent

Available Variables 1

Key Value Type
URL https://sender-api.azurewebsites.net