Delivery

getDelivery

GET https://api.beefast.eu/v2/delivery/:id

Get a delivery by id

Path Parameters

Name	Type	Description
id*	string	The DeliveryRequest id

Headers

Name	Type	Description
Authorization*	string	The authorization header. Format: Bearer TOKEN

200 The delivery object

{
    "getDelivery": {
            "cashOnDeliveryAmount": 0,
            "createdAt": 1662927738,
            "distance": 6079,
            "weightKg": 0,
            "dropoffPlace": {
                "addressDetails": "",
                "contactPhoneNumber": "[phone]",
                "name": "Dropoff Name",
                "streetAddress": "Bulevardul Unirii 1, Bucharest, Romania",
                "geolocation": {
                    "latitude": 44.42564470000001,
                    "longitude": 26.1036792
                }
            },
            "id": "VM1TAklWcvuLCX2KkLV5__deliv__12xnD5VF7vySV5Lqq3RR",
            "pickupPlace": {
                "addressDetails": "casa",
                "contactPhoneNumber": "[phone]",
                "name": "Pickup Place",
                "streetAddress": "Bulevardul Unirii 5, Bucharest, Romania",
                "geolocation": {
                  "latitude": 44.42574470000001,
                  "longitude": 26.1136792
                }
            },
            "status": "UNASSIGNED",
            "isReturn": false,
            "returnFor": null,
            "returnDeliveryID": null,
            "client": {
                "id": "VM1TAklWcvuLCX2KkLV5__client__AwYx5uUjDPtJGrf44dYc",
                "name": "Client Name"
            },
            "agent": {
                "id": "VM1TAklWcvuLCX2KkLV5__agent__AdsasjDPtJseraYc",
                "name": "Agent Name"
            }
        }

}

getAllDeliveries

GET https://api.beefast.eu/v2/delivery

Get all the deliveries for the authenticated client.

Headers

Name	Type	Description
Authorization	string	The authorization header. Format: Bearer TOKEN

200 An array of delivery objects

{
    "getAllDeliveries": [
        {
            "cashOnDeliveryAmount": 0,
            "createdAt": 1662927738,
            "distance": 6079,
            "weightKg": 0,
            "dropoffPlace": {
                "addressDetails": "",
                "contactPhoneNumber": "[phone]",
                "name": "Dropoff Name",
                "streetAddress": "Bulevardul Unirii 1, Bucharest, Romania",
                "geolocation": {
                    "latitude": 44.42564470000001,
                    "longitude": 26.1036792
                }
            },
            "id": "VM1TAklWcvuLCX2KkLV5__deliv__12xnD5VF7vySV5Lqq3RR",
            "pickupPlace": {
                "addressDetails": "casa",
                "contactPhoneNumber": "[phone]",
                "name": "Pickup Place",
                "streetAddress": "Bulevardul Unirii 5, Bucharest, Romania",
                "geolocation": {
                  "latitude": 44.42574470000001,
                  "longitude": 26.1136792
                }
            },
            "status": "IN_DELIVERY",
            "isReturn": false,
            "returnFor": null,
            "returnDeliveryID": null,
            "client": {
                "id": "VM1TAklWcvuLCX2KkLV5__client__AwYx5uUjDPtJGrf44dYc",
                "name": "Client Name"
            },
            "agent": {
                "id": "VM1TAklWcvuLCX2KkLV5__agent__AdsasjDPtJseraYc",
                "name": "Agent Name"
            }
        }
    ]
}

createDelivery

POST https://api.beefast.eu/v2/delivery

Request a delivery between two Places

Headers

Name	Type	Description
Authorization	string	The authorization header. Format: Bearer TOKEN

Request Body

Name	Type	Description
delivery*	object	A CreateDeliveryInput object

200 The delivery was successfully created.

{
    "createDelivery": {
        "id": "NEW_DELIVERY_ID",
        "number": "DELIVERY_NUMBER"
    }
}

cancelDelivery

POST https://api.beefast.eu/v2/delivery/:id/cancel

Cancel a delivery by id

Path Parameters

Name	Type	Description
id*	string	The delivery id

Headers

Name	Type	Description
Authorization	string	The authorization header. Format: Bearer TOKEN

Request Body

Name	Type	Description
reason*	string	A brief description provided by the client or system explaining the reason for the cancellation
reasonCode*	ReasonCode (string)	A code that identifies the standardized reason for cancellation.

200 The delivery was successfully cancelled.

{
    "apiCancelDelivery":true
}

Cancel Reason Codes

Cancel Reason Codes
NOTDELIV_UNABLE
NOTDELIV_ADDRESS
NOTDELIV_REJECT
NOTDELIV_NOTPAY
NOTDELIV_LATE
NOTDELIV_CANCEL
NOTDELIV_OTHER
DELIV_INTERNAL