Interface ProductService


  • public interface ProductService
    • Method Detail

      • createProducts

        @POST(" ")
        retrofit2.Call<java.util.Collection<Product>> createProducts​(@Body
                                                                     java.util.Collection<Product> products)
        Parameters:
        products - - products to be created
        Returns:
        Products
      • updateProducts

        @PUT(" ")
        retrofit2.Call<java.util.Collection<Product>> updateProducts​(@Body
                                                                     java.util.Collection<Product> products)
        Parameters:
        products - - products to be created or updated
        Returns:
        Products
      • updateProduct

        @PUT("{productId}")
        retrofit2.Call<Product> updateProduct​(@Path("productId")
                                              java.lang.Long productId,
                                              @Body
                                              Product product)
        Parameters:
        productId - - id of product to be updated
        product - - product to be updated
        Returns:
        Product
      • patchProduct

        @PATCH("{productId}")
        retrofit2.Call<Product> patchProduct​(@Path("productId")
                                             java.lang.Long productId,
                                             @Body
                                             Product product)
        Parameters:
        productId - - id of product to be patched
        product - - product to be patched
        Returns:
        Product
      • deleteProduct

        @DELETE("{productId}")
        retrofit2.Call<Product> deleteProduct​(@Path("productId")
                                              java.lang.Long productId)
        Parameters:
        productId - - product id
        Returns:
        Product
      • getProduct

        @GET("{productId}")
        retrofit2.Call<Product> getProduct​(@Path("productId")
                                           java.lang.Long productId)
        Parameters:
        productId - - productId id
        Returns:
        Product
      • getProducts

        @GET(" ")
        retrofit2.Call<ResultPage<Product>> getProducts​(@Query("page")
                                                        int page,
                                                        @Query("limit")
                                                        int limit,
                                                        @Query("include")
                                                        java.lang.String include,
                                                        @Query("filter")
                                                        java.lang.String filter,
                                                        @Query("sort")
                                                        java.lang.String sort)
        Parameters:
        page - - pagination parameter, default = 1
        include - - includes specified related entities i.e. moneyLogs or/and orderItems: "include=customizations,ingredients"
        limit - - pagination parameter, default = 100, max = 100
        filter - - query filter
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns:
        Products