Package pl.grizzlysoftware.dotykacka.client.v2.service

Interface OrderService

public interface OrderService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Order>	getOrder(java.lang.Long orderId)
retrofit2.Call<ResultPage<Order>>	getOrders(int page, int limit, java.lang.String include, java.lang.String namedFilter, java.lang.String filter, java.lang.String sort)

Method Detail

getOrder

@GET("{orderId}")
retrofit2.Call<Order> getOrder(@Path("orderId")
                               java.lang.Long orderId)

Parameters:

orderId - - order id

Returns:

Order

getOrders

@GET(" ")
retrofit2.Call<ResultPage<Order>> getOrders(@Query("page")
                                            int page,
                                            @Query("limit")
                                            int limit,
                                            @Query("include")
                                            java.lang.String include,
                                            @Query("namedFilter")
                                            java.lang.String namedFilter,
                                            @Query("filter")
                                            java.lang.String filter,
                                            @Query("sort")
                                            java.lang.String sort)

Parameters:

page - - pagination parameter, default = 1

limit - - pagination parameter, default = 100, max = 100

include - - includes specified related entities i.e. moneyLogs or/and orderItems: "include=orderItems,moneyLogs"

namedFilter - - query filter

filter - - query filter

sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc

Returns:

Orders