PIM API
CommerceLab PIM (product information management) integration API. Suppliers and ERP systems transfer product, price, stock, and attribute data to CommerceLab via this API.
Environment and address
The API runs at a separate address for each company (stgapi):
| Environment | Address |
|---|---|
| Test | https://stgapi.{tenant}.awstest.hebiar.com |
| Prod | https://stgapi.{tenant}.prod.hebiar.com |
{tenant} is your assigned company code. For some companies, the prod address
is a company-specific domain (e.g. stgapi.<company-domain>); use the address provided to you.
Complete integration in the test environment first; only the address and credentials
change when switching to prod.
Authentication
All endpoints require authentication. Two methods are supported; if the Authorization header
starts with Bearer , it is a token, otherwise Basic is accepted.
- Basic Auth —
Authorization: Basic base64(user:password). Credentials are verified with the CommerceLab identity service on each request (cached server-side). Users with access to multiple companies send the company code in theTenantheader. - Bearer token — JWT obtained from CommerceLab identity service (
/Auth/login):Authorization: Bearer <token>.
If authentication fails, a 401 without body is returned.
Batch (asynchronous) operations
Endpoints under sapigw/suppliers/{supplierId}/... queue the request and immediately return a
BatchRequestId. The operation result is tracked via the Query batch operation result endpoint.
Requests that cannot be queued (due to hourly/daily limits, etc.) also return 200;
in this case, BatchRequestId is empty and Message contains details.
Error responses
Unhandled server errors return 500 with the following body:
{ "NativeErrorCode": -1, "error": "error description" }
PIM/Entity/... and PIM/LookUp/... endpoints report errors within 200 responses with IsSuccess: false — always check the IsSuccess field in the response.
JSON field names use PascalCase (IsSuccess, Data); request body field names are case-insensitive.
Environments
- Test:
https://stgapi.{tenant}.awstest.hebiar.com - Prod:
https://stgapi.{tenant}.prod.hebiar.com
Authentication
Products
- POST /sapigw/suppliers/{supplierId}/v2/products — Bulk transfer products
- PUT /sapigw/suppliers/{supplierId}/v2/products — Bulk update products
- POST /PIM/SaveProductsManually — Save product (PIM model)
Price & Stock
Operation Tracking
- GET /sapigw/suppliers/{supplierId}/products/batch-requests/{batchRequestId} — Query batch operation result
- GET /PIM/transaction/{transactionId}/summary — Query transaction summary
- GET /PIM/transaction/{transactionId}/product/summary — Query transaction product results
Supplier Products
- POST /PIM/Vendor/Products — List supplier products
- POST /PIM/Vendor/Products/v2 — List vendor products (v2)
- POST /PIM/SaveExternalSku — Save ERP code to approved product
Attributes
- GET /PIM/GetAttributes — List attributes
- POST /PIM/SaveAttributeWithDetail — Create or update attribute