Package pl.grizzlysoftware.dotykacka.client.v1.api.service.sales

Interface OrderService

  • public interface OrderService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<Order> getOrderById​(java.lang.Integer cloudId, java.lang.Integer branchId, java.lang.Long orderId)  
      retrofit2.Call<Order> getOrderById​(java.lang.Integer cloudId, java.lang.Long orderId)  
      retrofit2.Call<java.util.Collection<Order>> getOrders​(java.lang.Integer cloudId, java.lang.Integer branchId, java.lang.String dateRange, java.lang.String dateField, java.lang.Integer limit, java.lang.Integer offset, java.lang.String sort)  
      retrofit2.Call<java.util.Collection<Order>> getOrders​(java.lang.Integer cloudId, java.lang.String dateRange, java.lang.String dateField, java.lang.Integer limit, java.lang.Integer offset, java.lang.String sort)  

    • Method Detail

      • getOrderById

        @GET("{cloudId}/orderid/{orderId}")
retrofit2.Call<Order> getOrderById​(@Path("cloudId")
                                   java.lang.Integer cloudId,
                                   @Path("orderId")
                                   java.lang.Long orderId)
        Parameters:
        cloudId - - cloud id
        orderId - - id of the receipt/order (however you call it)
        Returns:

      • getOrderById

        @GET("{cloudId}/{branchId}/{orderId}")
retrofit2.Call<Order> getOrderById​(@Path("cloudId")
                                   java.lang.Integer cloudId,
                                   @Path("branchId")
                                   java.lang.Integer branchId,
                                   @Path("orderId")
                                   java.lang.Long orderId)
        Parameters:
        cloudId - - cloud id
        branchId - - branch id
        orderId - - id of the receipt/order (however you call it)
        Returns:

      • getOrders

        @GET("{cloudId}")
retrofit2.Call<java.util.Collection<Order>> getOrders​(@Path("cloudId")
                                                      java.lang.Integer cloudId,
                                                      @Query("dateRange")
                                                      java.lang.String dateRange,
                                                      @Query("dateField")
                                                      java.lang.String dateField,
                                                      @Query("limit")
                                                      java.lang.Integer limit,
                                                      @Query("offset")
                                                      java.lang.Integer offset,
                                                      @Query("sort")
                                                      java.lang.String sort)
        Parameters:
        cloudId - - cloud id
        dateRange - - Date in format: [from]-[to] yyyy/MM/dd-yyyy/MM/dd | Timestamp in format: [start]-[end]: Long-Long
        dateField - - Name of the field for given dateRange filter //inserted,completed,versiondate,canceleddate
        limit - - pagination parameter, default = 100, max = 100
        offset - - pagination parameter, default = 0
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns:

      • getOrders

        @GET("{cloudId}/{branchId}")
retrofit2.Call<java.util.Collection<Order>> getOrders​(@Path("cloudId")
                                                      java.lang.Integer cloudId,
                                                      @Path("branchId")
                                                      java.lang.Integer branchId,
                                                      @Query("dateRange")
                                                      java.lang.String dateRange,
                                                      @Query("dateField")
                                                      java.lang.String dateField,
                                                      @Query("limit")
                                                      java.lang.Integer limit,
                                                      @Query("offset")
                                                      java.lang.Integer offset,
                                                      @Query("sort")
                                                      java.lang.String sort)
        Parameters:
        cloudId - - cloud id
        branchId - - branch id
        dateRange - - Date in format: [from]-[to] yyyy/MM/dd-yyyy/MM/dd | Timestamp in format: [start]-[end]: Long-Long
        dateField - - Name of the field for given dateRange filter //inserted,completed,versiondate,canceleddate
        limit - - pagination parameter, default = 100, max = 100
        offset - - pagination parameter, default = 0
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns: