The Get Function Details API allows to retrieve a list of registered functions in Shoplazza server. It supports pagination for efficient querying.
📘
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|
| page | int | No | The page number to retrieve. | 1 |
| limit | int | No | The number of records per page. | 20 |
📘
Public Response Parameters
| Parameter | Type | Required | Description | Example |
|---|
| code | string | Yes | API response code. SUCCESS means successful execution. | SUCCESS |
| message | string | Yes | Response message. SUCCESS indicates a successful response. | SUCCESS |
| data | object | Yes | Contains function details. | {...} |
| data.total | int | Yes | Total number of functions. | 2 |
| data.functions | array | Yes | A list of registered functions. | [...] |
| Parameter | Type | Required | Description | Example |
|---|
| function_id | int | Yes | Function ID. | 1 |
| namespace | string | Yes | Function namespace. | cart-transform |
| name | string | Yes | Function name. | cart-discount |
| input_schema | string | Yes | JSON schema defining function input. | "{\"cart\": {\"lines\": [...]}}" |
| source_code | string | Yes | The function source code. | "function run() {...}" |
| created_at | string | Yes | Function creation timestamp (UTC). | 2023-06-29 21:16:48 |
| updated_at | string | Yes | Last updated timestamp (UTC). | 2023-06-30 10:27:23 |
| version | string | Yes | Function version. | v1.0.1 |
| Field | Type | Description | Example |
|---|
code | string | The error code indicating the type of issue. | InvalidParameter |
message | string | A detailed message describing the error. | wrong cursor |
