OCI Functions (FUNCTION Parameter)
In addition to the standard punchout flow, the connector supports special OCI functions that the procurement system can request directly at login via the FUNCTION parameter. This allows specific actions to be triggered in the shop without the buyer manually navigating it.
The parameter is appended to the login URL:
https://shop.example.com/AgiqonOciEntry/login
?USERNAME=...
&PASSWORD=...
&HOOK_URL=...
&FUNCTION=DETAIL
&PRODUCTID=SW-10001
Supported Functions
DETAIL
Opens the detail page of a specific product in the shop.
| Parameter | Required | Description |
|---|---|---|
PRODUCTID | Yes | Product number of the requested item |
Flow: The connector looks up the product by its product number and redirects directly to the product detail page. The buyer can add the product to the cart and transfer it as usual.
VALIDATE
Returns pricing and availability for a specific product without the buyer opening the shop.
| Parameter | Required | Description |
|---|---|---|
PRODUCTID | Yes | Product number |
QUANTITY | Yes | Requested quantity |
Flow: The connector adds the product with the specified quantity to the cart and immediately sends the item data as an OCI form to the procurement system's hook URL. The buyer does not see the shop. The session is terminated after the transfer.
SOURCING
Starts a product search in the shop.
| Parameter | Required | Description |
|---|---|---|
SEARCHSTRING | Yes | Search term |
Flow: The connector redirects directly to the shop's search results page. The buyer sees the results and can select products, add them to the cart, and transfer them.
BACKGROUND_SEARCH
Executes a search in the background and transfers all results directly to the procurement system.
| Parameter | Required | Description |
|---|---|---|
SEARCHSTRING | Yes | Search term |
Flow: The connector runs the search server-side and adds all found products to the cart. The item data is then immediately sent as an OCI form to the procurement system's hook URL. The buyer does not see the shop. The session is terminated after the transfer.
DOWNLOADJSON
Returns a paginated product catalog as JSON (OCI 5).
| Parameter | Required | Description |
|---|---|---|
pagesize | No | Number of products per page (default: 50) |
requestedpage | No | Requested page number |
transactionid | No | Transaction ID from the procurement system |
cti | No | Catalog Transfer Interface identifier |
Flow: The connector returns the shop's complete product catalog page by page as JSON. This function is used by OCI 5 systems to automatically import the shop's catalog instead of performing a manual punchout.
QUANTITYCHECK
Returns the available stock for a specific product as JSON.
| Parameter | Required | Description |
|---|---|---|
PRODUCTID | Yes | Product number |
Flow: The connector returns the availability as JSON:
{
"AVAILABLE_QUANTITY": 42,
"LEADTIME": ""
}
The session is terminated after the query.
Note
Not all procurement systems support all FUNCTION modes. Which functions are actively used depends on the configuration and capabilities of the respective procurement system.