Skip to main content

15. Product Service

Accessed via client.product(). Provides CRUD and count operations for products.

15.1 Method List​

MethodReturn TypeHTTPEndpoint
create(ProductRequestV5)ProductResponseV5 or nullPOST/api/v5/product
update(product_id, ProductRequestV5)ProductResponseV5 or nullPUT/api/v5/product/{id}
delete(product_id)booleanDELETE/api/v5/product/{id}
get(product_id)ProductResponseV5 or nullGET/api/v5/product/{id}
list()List<ProductResponseV5>GET/api/v5/product
exists(product_id)booleanGET/api/v5/product/{id}/exists
count()longGET/api/v5/product/count

15.2 ProductRequestV5 / ProductResponseV5​

FieldTypeDescription
product_idStringProduct ID (PK)
product_nameStringProduct name
site_idStringOwning site
descriptionStringDescription
external_systemStringExternal system name (up to 50 characters, e.g. SAP) — identifies together with external_id as a pair. An ID without its system is no identity
external_idStringThe product ID in that system (up to 100 characters). Look up by the pair with GET /api/v5/product/by-external/{system}/{external_id}
product_codeStringProduct code (SKU)
categoryStringCategory
unit_of_measureStringUnit of measure (EA, KG, etc.)

15.3 Usage Examples​

Creating a Product​

import plantpulse.api.v5.dto.request.ProductRequestV5;
import plantpulse.api.v5.dto.response.ProductResponseV5;

ProductRequestV5 req = new ProductRequestV5();
req.setProduct_id("PROD_A001");
req.setProduct_name("반도체 칩 A");
req.setSite_id("SITE_DJ");
req.setProduct_code("SKU-A001");
req.setCategory("반도체");
req.setUnit_of_measure("EA");
req.setExternal_system("ERP");
req.setExternal_id("ERP_P001");
req.setDescription("8nm 공정 반도체 칩");

ProductResponseV5 created = client.product().create(req);

Retrieval​

ProductResponseV5 p = client.product().get("PROD_A001");
boolean exists = client.product().exists("PROD_A001");
long total = client.product().count();

Grouping by Category​

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

Map<String, List<ProductResponseV5>> byCategory = client.product().list().stream()
.collect(Collectors.groupingBy(ProductResponseV5::getCategory));

byCategory.forEach((cat, items) ->
System.out.printf("%s: %d개%n", cat, items.size()));

Update / Delete​

ProductRequestV5 update = new ProductRequestV5();
update.setProduct_id("PROD_A001");
update.setProduct_name("반도체 칩 A (v2)");
update.setSite_id("SITE_DJ");
update.setProduct_code("SKU-A001");
update.setUnit_of_measure("EA");
client.product().update("PROD_A001", update);

client.product().delete("PROD_A001");

Next Steps​