Retrieve availability for partners and drivers

post https://api.torredecontrol.io/dev/v1/order/overflow/availability

Body Params

branch

string

If the branch code or external ID of the same record is not specified, the branch closest to the destination will be selected.

total

number

required

Total amount to pay or be paid by the customer

isPaid

boolean

required

Indicator to signify whether the order has been settled or requires payment

customer

object

required

paymentMethod

string

required

Identifier for the payment method (code not currently supported).

address

object

required

validateGeofenceCoverage

boolean

Defaults to false

Compel validation of coverage pertaining to the branch, confirming whether the address falls within a designated geofence or a deliverable area."

depthLevelSearch

number

required

0 to 3

This field specifies the type of search to be conducted for internal drivers, with multiple values (0, 1, 2, 3). Further details about these values can be found in Jelp Delivery - Depth Level Search

fares

boolean

When active return the final fares from the providers

deliveryFee

boolean

Defaults to false

This flag when active returns the public fares for the customer

returnDistance

boolean

Defaults to false

This flag when active returns the distance from the branch or pickup point to destiny

Responses

500

Internal server error

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.torredecontrol.io/dev/v1/order/overflow/availability \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"isPaid":true}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Invalid Request or Data

403Unauthorized access - Wrong or invalid keys (headers)