Customer

Get details of the customer

Customers Detail

GET https://api.berymo.com/schedule/v1/customers/detail

Customer is the main entity for all the APIs. It holds API KEY and API SECRET as well.

200 Customer successfully retrieved.

{
    "customer": {
        "id": 8,
        "username": "[email protected]",
        "email": "[email protected]",
        "is_active": true,
        "status": "Pending",
        "is_email_confirmed": true,
        "client_ip": "0.0.0.0",
        "created_at": "2020-08-27T15:11:55+00:00",
        "updated_at": "2020-08-27T15:11:55+00:00",
        "api_key": "clThKUKaHAlpniSexVPWUk2tPE4vndqH-3",
        "first_name": "Worth",
        "last_name": "Miller",
        "name": "John Doe Inc",
        "country_code": "1",
        "phone": "555XXXXX",
        "roles": [
            "ROLE_CUSTOMER"
        ],
        "profile_type": "business",
        "cards": [],
        "city": {
            "id": 2,
            "name": "San Fransisco",
            "slug": "California",
            "base_price": 5.45,
            "delivery_prices": "{\"items\": [{\"mile\": 10, \"amount\": 5.95},{\"mile\": 15, \"amount\": 7.95},{\"mile\": 20, \"amount\": 9.95},{\"mile\": 25, \"amount\": 11.95}]}",
            "latitude": "38.429217",
            "longitude": "27.162858",
            "county_name": "Santa Clara",
            "timezone": "America/LosAngeles",
            "is_active": true,
            "is_discharge_single_ride_active": true,
            "polygon_points": "[[27.026023864746094,38.50008653288019],[27.031517028808594,38.38365119432096],[27.193222045898438,38.38795699631396],[27.191505432128906,38.50519140240356],[27.026023864746094,38.50008653288019]]",
            "return_ride_limit_on_mile": 0.0,
            "is_flat_app_active": false,
            "is_places_app_active": false,
            "is_delivery_app_active": true,
        }
    }
}

Total Balance to Pay

GET https://api.berymo.com/api/schedule/v1/customers/payout

This endpoint shows that how much money they have to pay at the end of the current month. The currency is USD.

200 Shows the total balance to pay.

{
    "total": 100.90
}