Package de.hybris.platform.subscribedproducttmfwebservices.v1.api

Interface ProductApi

All Known Implementing Classes:

SpiProductsController

public interface ProductApi

Interface handling operations for Product.

Since:

2302

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Product>	createProduct(@Valid Product product)
org.springframework.http.ResponseEntity<Void>	deleteProduct(String id)
org.springframework.http.ResponseEntity<List<Product>>	listProduct(@Valid String fields, @Valid Integer offset, @Valid Integer limit, @Valid String billingAccountId, @Valid String status)
org.springframework.http.ResponseEntity<Product>	patchProduct(String id, @Valid Product product)
org.springframework.http.ResponseEntity<Product>	retrieveProduct(String id, @Valid String fields)

Method Details

createProduct

@RequestMapping(value="/product",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=POST)
org.springframework.http.ResponseEntity<Product> createProduct(@Valid @RequestBody
 @Valid Product product)

deleteProduct

@RequestMapping(value="/product/{id}",
                produces="application/json;charset=utf-8",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deleteProduct(@PathVariable("id")
 String id)

listProduct

@RequestMapping(value="/product",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<Product>> listProduct(@Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="billingAccount.id",required=false)
 @Valid String billingAccountId,
 @Valid @RequestParam(value="status",required=false)
 @Valid String status)

patchProduct

@RequestMapping(value="/product/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=PATCH)
org.springframework.http.ResponseEntity<Product> patchProduct(@PathVariable("id")
 String id,
 @Valid @RequestBody
 @Valid Product product)

retrieveProduct

@RequestMapping(value="/product/{id}",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<Product> retrieveProduct(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields)