public interface OrdersApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Acceptors> |
apiOrdersAcceptOrderIdGet(String orderId)
Get all the dropbuddies who accepted a request
You can retrieve all the dropbuddies that accepted a request
|
retrofit2.Call<Void> |
apiOrdersAcceptOrderIdPost(String orderId,
Double priceSuggestion)
Accept orders
A signed in dropbuddy can accept a pending request
|
retrofit2.Call<CompleteOrderResponse> |
apiOrdersApproveOrderIdPost(String orderId,
String dropbuddyId)
Allows a dropbuddy approve a dropbuddy's proposal
Only custom requests can be approved.
|
retrofit2.Call<Void> |
apiOrdersCancelOrderIdPost(String orderId)
Cancel orders that have failed or completed
Brief summary
|
retrofit2.Call<Void> |
apiOrdersDropOrderIdPost(String orderId)
DropBuddy can drop a request only 5mins after accepting a request
DropBuddy can drop a request only 5mins after accepting a request
|
retrofit2.Call<InlineResponse2003> |
apiOrdersEstimateCustomPost(Order body)
Information about estimating custom orders
Information about estimating custom orders
|
retrofit2.Call<InlineResponse2002> |
apiOrdersEstimatePost(Order body)
Generate an estimated cost based on request preferences
Generate an estimated cost based on request preferences
|
retrofit2.Call<InlineResponse2004> |
apiOrdersHistoryGet()
Returns all the requests and orders made by user
History
|
retrofit2.Call<InlineResponse2005> |
apiOrdersOrderIdGet(String orderId)
Returns a single order information
Return order information
|
retrofit2.Call<InlineResponse2004> |
apiOrdersPendingGet(String keyword,
Integer limit,
String mode,
String orderby,
Double longitude,
Double latitude)
Returns pending requests within a particular location if the location is provided
Pending Requests
|
retrofit2.Call<CompleteOrder> |
apiOrdersPlaceCustomPost(Location pickupLocation,
String description,
Double valueOfItem,
Double suggestedPrice,
Long pickupTime,
String deliveryType,
String source)
Place shopping type requests
More Information
|
retrofit2.Call<CompleteOrder> |
apiOrdersPlaceDispatchPost(String pickupAddress,
String dropoffAddress,
Location pickupLocation,
Location dropoffLocation,
String description,
String recipientName,
String recipientPhonenumber,
Double valueOfItem,
String itemType,
String deliveryType,
String pickupName,
String pickupPhonenumber,
String pickupEmail,
String recipientEmail,
String source,
Long pickupTime,
Long dropoffTime,
Integer quantity,
String sizeFit)
You can place dispatch type requests via this endpoint
More information
|
retrofit2.Call<CompleteOrder> |
apiOrdersPlaceFoodPost(Location pickupLocation,
Location dropoffLocation,
String recipientName,
String recipientPhonenumber,
String description,
String recipientEmail,
Double valueOfItem,
String sizeFit,
String deliveryType,
String source,
Long pickupTime,
Long dropoffTime)
Place shopping type requests
More Information
|
retrofit2.Call<CompleteOrder> |
apiOrdersPlaceShoppingPost(Location pickupLocation,
Location dropoffLocation,
String recipientName,
String recipientPhonenumber,
String description,
Double valueOfItem,
String recipientEmail,
String sizeFit,
String deliveryType,
String source,
Long pickupTime,
Long dropoffTime)
Place shopping type requests
More Information
|
retrofit2.Call<Void> |
apiOrdersRateOrderIdPost(String orderId,
Integer rating,
String ratingMessage)
Rate a dropbuddy after delivery is completed.
|
retrofit2.Call<Void> |
apiOrdersUpdateOrderIdPost(String orderId,
Order body)
You can set any values within the order class.
|
retrofit2.Call<Void> |
apiOrdersUpdateStatusOrderIdPost(String orderId,
String deliveryStatus) |
@GET(value="api/orders/accept/{order_id}")
retrofit2.Call<Acceptors> apiOrdersAcceptOrderIdGet(@Path(value="order_id")
String orderId)
orderId - Order identifier value (required)@POST(value="api/orders/accept/{order_id}")
retrofit2.Call<Void> apiOrdersAcceptOrderIdPost(@Path(value="order_id")
String orderId,
@Body
Double priceSuggestion)
orderId - Order identifier value (required)priceSuggestion - Supplied using this field is the amount a dropbuddy is willing to accept for a request. (optional)@POST(value="api/orders/approve/{order_id}")
retrofit2.Call<CompleteOrderResponse> apiOrdersApproveOrderIdPost(@Path(value="order_id")
String orderId,
@Body
String dropbuddyId)
orderId - Order identifier value (required)dropbuddyId - DropBuddy Identification value (optional)@POST(value="api/orders/cancel/{order_id}")
retrofit2.Call<Void> apiOrdersCancelOrderIdPost(@Path(value="order_id")
String orderId)
orderId - Order identifier value (required)@POST(value="api/orders/drop/{order_id}")
retrofit2.Call<Void> apiOrdersDropOrderIdPost(@Path(value="order_id")
String orderId)
orderId - Order identifier value (required)@POST(value="api/orders/estimate/custom") retrofit2.Call<InlineResponse2003> apiOrdersEstimateCustomPost(@Body Order body)
body - Should be sent as body of the request (required)@POST(value="api/orders/estimate") retrofit2.Call<InlineResponse2002> apiOrdersEstimatePost(@Body Order body)
body - Should be sent as body of the request (required)@GET(value="api/orders/history") retrofit2.Call<InlineResponse2004> apiOrdersHistoryGet()
@GET(value="api/orders/{order_id}")
retrofit2.Call<InlineResponse2005> apiOrdersOrderIdGet(@Path(value="order_id")
String orderId)
orderId - Order identifier value (required)@GET(value="api/orders/pending") retrofit2.Call<InlineResponse2004> apiOrdersPendingGet(@Query(value="keyword") String keyword, @Query(value="limit") Integer limit, @Query(value="mode") String mode, @Query(value="orderby") String orderby, @Query(value="longitude") Double longitude, @Query(value="latitude") Double latitude)
keyword - Keyword (optional)limit - Limit Results amount (optional)mode - Order DESC or ASC (optional)orderby - Order the responses in a certain way (optional)longitude - Longitude value of client (optional)latitude - Latitude value of client (optional)@POST(value="api/orders/place/custom") retrofit2.Call<CompleteOrder> apiOrdersPlaceCustomPost(@Body Location pickupLocation, @Body String description, @Body Double valueOfItem, @Body Double suggestedPrice, @Body Long pickupTime, @Body String deliveryType, @Body String source)
pickupLocation - Location object for the pickup address. This is more precise and recommended (required)description - Information describing the request (required)valueOfItem - Total Shopping value (required)suggestedPrice - Amount user is willing to pay for request (required)pickupTime - Pickup Time in millis (required)deliveryType - Defaults to `REGULAR` if not set `REGULAR`, `NEXTDAY`, `PRIME` (optional)source - Source of the request (optional)@POST(value="api/orders/place/dispatch") retrofit2.Call<CompleteOrder> apiOrdersPlaceDispatchPost(@Body String pickupAddress, @Body String dropoffAddress, @Body Location pickupLocation, @Body Location dropoffLocation, @Body String description, @Body String recipientName, @Body String recipientPhonenumber, @Body Double valueOfItem, @Body String itemType, @Body String deliveryType, @Body String pickupName, @Body String pickupPhonenumber, @Body String pickupEmail, @Body String recipientEmail, @Body String source, @Body Long pickupTime, @Body Long dropoffTime, @Body Integer quantity, @Body String sizeFit)
pickupAddress - Geocode selected on the map by the user for the pickup address (required)dropoffAddress - Geocode selected on the map by the user for the dropoff address (required)pickupLocation - Location object for the pickup address. This is more precise and recommended (required)dropoffLocation - Location object for the dropoff address. This is more precise and recommended (required)description - Information describing the request (required)recipientName - Name of recipient is required (required)recipientPhonenumber - Phonenumber of recipient is required (required)valueOfItem - Items value (required)itemType - Defaults to `parcel` - Avaliable options `document`, `parcel`, `other` (optional)deliveryType - Defaults to `REGULAR` if not set `REGULAR`, `NEXTDAY`, `PRIME` (optional)pickupName - Uses user information if not provided (optional)pickupPhonenumber - Uses user information if not provided (optional)pickupEmail - defaults user information if not provided (optional)recipientEmail - Recipient email address not necessary (optional)source - Source of the request (optional)pickupTime - Pickup Time in millis (optional)dropoffTime - Pickup Time in millis (optional)quantity - Quantity of items that should be delivered. Item must be the same (optional)sizeFit - Defaults to `BIKE` if not set `TRUCK`, `CAR`, `BIKE`, `BAG` (optional)@POST(value="api/orders/place/food") retrofit2.Call<CompleteOrder> apiOrdersPlaceFoodPost(@Body Location pickupLocation, @Body Location dropoffLocation, @Body String recipientName, @Body String recipientPhonenumber, @Body String description, @Body String recipientEmail, @Body Double valueOfItem, @Body String sizeFit, @Body String deliveryType, @Body String source, @Body Long pickupTime, @Body Long dropoffTime)
pickupLocation - Location object for the pickup address. This is more precise and recommended (required)dropoffLocation - Location object for the dropoff address. This is more precise and recommended (required)recipientName - Name of recipient is required (required)recipientPhonenumber - Phonenumber of recipient is required (required)description - Information describing the request (required)recipientEmail - Recipient email address not necessary (optional)valueOfItem - Total Shopping value (optional)sizeFit - Defaults to `BIKE` if not set `TRUCK`, `CAR`, `BIKE`, `BAG` (optional)deliveryType - Defaults to `REGULAR` if not set `REGULAR`, `NEXTDAY`, `PRIME` (optional)source - Source of the request (optional)pickupTime - Pickup Time in millis (optional)dropoffTime - Pickup Time in millis (optional)@POST(value="api/orders/place/shopping") retrofit2.Call<CompleteOrder> apiOrdersPlaceShoppingPost(@Body Location pickupLocation, @Body Location dropoffLocation, @Body String recipientName, @Body String recipientPhonenumber, @Body String description, @Body Double valueOfItem, @Body String recipientEmail, @Body String sizeFit, @Body String deliveryType, @Body String source, @Body Long pickupTime, @Body Long dropoffTime)
pickupLocation - Location object for the pickup address. This is more precise and recommended (required)dropoffLocation - Location object for the dropoff address. This is more precise and recommended (required)recipientName - Name of recipient is required (required)recipientPhonenumber - Phonenumber of recipient is required (required)description - Information describing the request (required)valueOfItem - Total Shopping value (required)recipientEmail - Recipient email address not necessary (optional)sizeFit - Defaults to `BIKE` if not set `TRUCK`, `CAR`, `BIKE`, `BAG` (optional)deliveryType - Defaults to `REGULAR` if not set `REGULAR`, `NEXTDAY`, `PRIME` (optional)source - Source of the request (optional)pickupTime - Pickup Time in millis (optional)dropoffTime - Pickup Time in millis (optional)@POST(value="api/orders/rate/{order_id}")
retrofit2.Call<Void> apiOrdersRateOrderIdPost(@Path(value="order_id")
String orderId,
@Body
Integer rating,
@Body
String ratingMessage)
orderId - Order identifier value (required)rating - Rating value is between 0-5 (required)ratingMessage - User can add a message (optional)@POST(value="api/orders/update/{order_id}")
retrofit2.Call<Void> apiOrdersUpdateOrderIdPost(@Path(value="order_id")
String orderId,
@Body
Order body)
orderId - Order identifier value (required)body - Should be sent as body of the request (required)@POST(value="api/orders/update/status/{order_id}")
retrofit2.Call<Void> apiOrdersUpdateStatusOrderIdPost(@Path(value="order_id")
String orderId,
@Body
String deliveryStatus)
orderId - Order identifier value (required)deliveryStatus - The status that the delivery should be updated to (required)Copyright © 2017. All rights reserved.