Deliveries

All related APIs for deliveries

A delivery is the process of package. If you need to show details of the deliveries, use the current APIs.

List Deliveries

GET https://api.berymo.com/api/schedule/v1/deliveries

Lists all deliveries that are belongs to the customer.

Query Parameters

Name	Type	Description
limit	integer	Number of items to show
page	integer	Current page number

200

{
    "deliveries": {
        "current_page_number": 1,
        "num_items_per_page": 10,
        "items": [
            {
                "route": "Tanero Business -> Mado",
                "id": 5,
                "app": "business",
                "type": "delivery",
                "uu_id": "1f0bce14-0d8a-410d-b3fa-2c65f84aa166",
                "origin": "Tanero Business",
                "destination": "Mado",
                "origin_location": "-35.455587,48.989665",
                "destination_location": "-35.455585,48.989664",
                "seats": 1,
                "duration": 1000,
                "distance": 1.2,
                "tip": 0.0,
                "payment_type": "card",
                "payment_detail": {
                    "card": {
                        "brand": "Visa",
                        "last4": "0232",
                        "uu_id": "ff0d715a-73be-4bbb-bd29-1462d6567747"
                    },
                    "payment_intent": "pi_1HFfjaKyxYMZ8PLcO4cZeCHo",
                    "payment_method": "pm_1HFfhWKyxYMZ8PLcRRpIzY0C",
                    "return_payment_intent": "pi_1HFfjcKyxYMZ8PLc4mZkXN24"
                },
                "status": "pending",
                "mile_on_pre_ride": 0.0,
                "mile_on_ride": 0.0,
                "is_free_ride": false,
                "is_invited": false,
                "is_return_ride_done": "0",
                "is_free": false,
                "package_message": "Hohohoh",
                "package_amount": 59.5,
                "package_qr_code": "AB_1",
                "total_package": 10,
                "is_delivery_return_ride": false,
                "is_package_rejected": false,
                "package_delivery_at": "2020-09-01T07:57:05+00:00",
                "created_at": "2020-09-01T07:51:10+00:00",
                "updated_at": "2020-09-01T07:51:10+00:00",
                "customer": {
                    "id": 8,
                    "username": "[email protected]",
                    "email": "[email protected]",
                    "is_active": true,
                    "status": "Pending",
                    "is_email_confirmed": true,
                    ...
                },
                "friends": [],
                "city": {
                    "id": 2,
                    "name": "Izmir",
                    "slug": "izmir",
                    ...
                },
            }
        ],
        "total_count": 1,
        "paginator_options": {
            "pageParameterName": "page",
            "sortFieldParameterName": "sort",
            "sortDirectionParameterName": "direction",
            "filterFieldParameterName": "filterField",
            "filterValueParameterName": "filterValue",
            "distinct": true
        },
        "custom_parameters": [],
        "route": "api_schedule_deliveries_list",
        "params": {
            "page": "1",
            "limit": "10"
        },
        "page_range": 5,
        "template": "@KnpPaginator/Pagination/sliding.html.twig",
        "sortable_template": "@KnpPaginator/Pagination/sortable_link.html.twig",
        "filtration_template": "@KnpPaginator/Pagination/filtration.html.twig"
    }
}

Detail of a Delivery

GET https://api.berymo.com/api/schedule/v1/deliveries/:uuid

Shows a single delivery details.

Path Parameters

Name	Type	Description
uuid	string	UUID of an delivery

200 Successfully shows detail of an delivery

{
    "delivery": {
        [DeliveryObject]
    }
}

404

Check Pricing

POST https://api.berymo.com/api/schedule/v1/deliveries/check-pricing

This endpoint allows that whether a delivery is in the allowed radius or not.

Request Body

Name	Type	Description
destinationLocation	string	{latitude},{longitude}

200 If it is OK, you get the mile and price that fits based on the current delivery location.

{
    "mile": 10,
    "price": 25.00
}

400 If you get an error, means that you are not allowed to create a delivery. Cancel the process.

Before create a delivery API, you must run this endpoint. The response has the package prices, otherwise you get an error that indicates that the delivery cannot be done.

Create a Delivery

POST https://api.berymo.com/api/schedule/v1/deliveries

This endpoint creates a delivery.

Request Body

Name	Type	Description
paymentDetail	object	Payment authorization response object
app	string	Must be "business"
type	string	Must be "delivery"
origin	string	Origin location of a delivery
destination	string	Destination location of a delivery
originLocation	string	Origin coordinates of the delivery
destinationLocation	string	Destination coordinates of the delivery
seats	integer	Must be "1"
duration	number	Must be "0"
distance	number	Must be "0"
tip	number	Must be "0"
city	integer	ID of an City
totalPackage	string	Must be "1"
paymentType	string	Must be "card"
packageMessage	string	A short message of an
packageAmount	number	Total amount o a delivery
packageQrCode	string	Random 8 Digit Text
packageDeliveryAt	string	Eg: 2020-03-10 12:41

200 Successfully created a delivery

{
    "status": true,
    "ride": {
        "id": 1,
        "uuid": "xxx-yyy-xxxx-sss"
    } 
}