### Clone repository, add upstream remote, and install dependencies Source: https://github.com/appseconnect/appse-ai-docs/blob/main/CONTRIBUTING.md These commands are part of the initial repository setup. Start by cloning your fork and moving into the directory. Then add the upstream remote and install any dependencies with npm. ```bash git clone https://github.com/YOUR_USERNAME/appse-ai-docs.git cd appse-ai-docs ``` ```bash git remote add upstream https://github.com/appseconnect/appse-ai-docs.git ``` ```bash npm install ``` -------------------------------- ### Real-World Example 2: Get First and Last Items Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/03-working-with-arrays.md Use indexing and aggregation to get the first and last product names and the highest and lowest prices. ```javascript { "firstProduct": "{{ $payload.items[0].name }}", "lastProduct": "{{ $payload.items[-1].name }}", "highestPrice": "{{ max($payload.items[*].price) }}", "lowestPrice": "{{ min($payload.items[*].price) }}" } ``` -------------------------------- ### Get Record By Key - Example JSON Output (Customer) Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sage-x3.md Example output from the Get Record By Key action for a Customer lookup, showing a JSON array with fields BPCNUM, BPCNAM, BCGCOD, and BPCSTA. The response shape mirrors the selected object's record structure. ```json [ { "BPCNUM": "BPC-000001", "BPCNAM": "Acme Corp", "BCGCOD": "ECOM", "BPCSTA": "2" } ] ``` -------------------------------- ### Get Product by Default Variant SKU - Example JSON Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example JSON response returned by the 'Get Product by Default Variant SKU' action when a product matches the provided SKU. The response includes product details such as id, title, description, and variant information. ```json [ { "id": "gid://shopify/Product/8536686002348", "title": "OnePlus 13RRR", "description": "OnePlus 13R Mobile - Colour(Sea blue) Looks smart and Performance was good", "productType": "", "handle": "oneplus-13r", "totalInventory": 0, "createdAt": "2026-04-24T05:42:06Z", "updatedAt": "2026-04-24T06:57:51Z", "status": "ACTIVE", "tags": [], "variants": { "nodes": [ { "sku": "ONEPLUS-R", "id": "gid://shopify/ProductVariant/46181637980332", "title": "Default Title", "price": "0.00", "displayName": "OnePlus 13RRR - Default Title", "inventoryItem": { "id": "gid://shopify/InventoryItem/48275854885036", "sku": "ONEPLUS-R", "inventoryLevels": { "nodes": [ { "location": { "id": "gid://shopify/Location/71342817452", "name": "Action Area", "address": { "address1": "Newtown", "address2": "", "city": "New Town", "province": "Tamil Nadu", "country": "India", "zip": "700026" } } } ] } } } ] } } ] ``` -------------------------------- ### Get Company by Company ID - Example Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example JSON response returned when a company is found. If no company is found for the provided ID, the response will be empty or null. ```json [ { "id": "gid://shopify/Company/13819740332", "name": "Libas Store", "externalId": null, "note": "Libas store", "createdAt": "2026-04-23T12:39:39Z", "updatedAt": "2026-04-23T13:12:20Z", "mainContact": null, "contacts": { "nodes": [ { "id": "gid://shopify/CompanyContact/1304559788", "title": "Admin", "isMainContact": false, "createdAt": "2026-04-23T13:04:57Z", "updatedAt": "2026-04-23T13:04:57Z", "customer": { "id": "gid://shopify/Customer/9304515543212", "firstName": "Denna", "lastName": "Josh", "displayName": "Denna Josh", "email": "libas.storemax@yopmail.com", "phone": "+917865432456" }, "roleAssignments": { "nodes": [] } } ] }, "locations": { "nodes": [ { "id": "gid://shopify/CompanyLocation/13888684204", "name": "Libas Store", "externalId": null, "note": null, "createdAt": "2026-04-23T12:39:39Z", "updatedAt": "2026-04-23T12:39:39Z", "shippingAddress": null, "billingAddress": null, "buyerExperienceConfiguration": { "checkoutToDraft": false, "editableShippingAddress": false }, "taxSettings": { "taxExempt": false, "taxExemptions": [] }, "catalogs": { "nodes": [] } }, { "id": "gid://shopify/CompanyLocation/13888946348", "name": "Libas Store", "externalId": null, "note": null, "createdAt": "2026-04-23T12:50:18Z", "updatedAt": "2026-04-23T12:50:18Z", "shippingAddress": { "id": "gid://shopify/CompanyAddress/2484863148", "firstName": "Dennie", "lastName": "John", "companyName": "Libas Store", "address1": "Evergreen Terrace", "address2": "Apt. 5B", "city": "Springfield", "zoneCode": "IL", "zip": "62704", "countryCode": "US", "country": "United States", "phone": "+919087676767" }, "billingAddress": null, "buyerExperienceConfiguration": { "checkoutToDraft": false, "editableShippingAddress": false }, "taxSettings": { "taxExempt": true, "taxExemptions": [] }, "catalogs": { "nodes": [] } } ] } } ] ``` -------------------------------- ### Get Product Price - Example JSON Output Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sage-x3.md Example output from the Get Product Price action, showing a JSON array with fields YPLI, YPLICRI1, PRI, CUR, and YPLIDAT. The price list code defaults to T10 and criterion 1 is typically the product reference. ```json [ { "YPLI": "T10", "YPLICRI1": "SKU001", "PRI": 1150.00, "CUR": "USD", "YPLIDAT": "20260820" } ] ``` -------------------------------- ### Get Customer by Email Action Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example JSON output from the Get Customer by Email action, showing customer details including id, firstName, lastName, email, addresses, and defaultAddress. ```json [ { "id": "gid://shopify/Customer/9304242225324", "firstName": "John", "lastName": "Doe", "defaultEmailAddress": { "emailAddress": "john.doe@example.com", "marketingState": "NOT_SUBSCRIBED" }, "metafields": { "nodes": [] }, "defaultPhoneNumber": { "phoneNumber": "+919876543210", "marketingState": "NOT_SUBSCRIBED", "marketingCollectedFrom": null }, "smsMarketingConsent": { "marketingState": "NOT_SUBSCRIBED", "marketingOptInLevel": "SINGLE_OPT_IN", "consentUpdatedAt": null }, "createdAt": "2026-04-23T10:02:28Z", "updatedAt": "2026-04-23T10:02:28Z", "numberOfOrders": "0", "state": "DISABLED", "amountSpent": { "amount": "0.0", "currencyCode": "USD" }, "verifiedEmail": true, "taxExempt": false, "tags": [], "addresses": [ { "id": "gid://shopify/MailingAddress/10384399302828?model_name=CustomerAddress", "firstName": "John", "lastName": "Doe", "company": null, "address1": "123 Main Street", "city": "Hyderabad", "province": "Telangana", "country": "India", "zip": "500001", "phone": "+919876543210", "name": "John Doe", "provinceCode": "TS", "countryCodeV2": "IN" } ], "defaultAddress": { "id": "gid://shopify/MailingAddress/10384399302828?model_name=CustomerAddress", "address1": "123 Main Street", "city": "Hyderabad", "province": "Telangana", "country": "India", "zip": "500001", "phone": "+919876543210", "provinceCode": "TS", "countryCodeV2": "IN" } } ] ``` -------------------------------- ### Start local development server Source: https://github.com/appseconnect/appse-ai-docs/blob/main/README.md Starts the local development server and opens a browser window. Most changes are reflected live without restarting the server. ```bash pnpm start ``` -------------------------------- ### Get List of Locations - Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example response from the Get List of Locations action. The Limit field controls how many locations are returned; in this example up to 10 locations are retrieved. ```json [ { "id": "gid://shopify/Location/71342817452", "name": "Action Area", "address": { "province": "Tamil Nadu", "zip": "700026", "address1": "Newtown", "address2": "", "city": "New Town", "country": "India", "formatted": ["Newtown", "700026 New Town TN", "India"] } }, { "id": "gid://shopify/Location/73551904940", "name": "Amsterdam Warehouse", "address": { "province": "New York", "zip": "10006", "address1": "101 Liberty Street", "address2": null, "city": "New York", "country": "United States", "formatted": ["101 Liberty Street", "New York NY 10006", "United States"] } }, { "id": "gid://shopify/Location/75635589292", "name": "ATP-WAREHOUSE1", "address": { "province": "Telangana", "zip": "500016", "address1": "Ameerpet1", "address2": "Vijayalakshmi Nagara1", "city": "Hyderabad", "country": "India", "formatted": ["Ameerpet1", "Vijayalakshmi Nagara1", "500016 Hyderabad TS", "India"] } } ] ``` -------------------------------- ### Example JSON result from Create Product with Options and Media Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Shows the JSON response returned after successfully creating a product with media. The response includes the product ID, title, status, options, variants, and media details. ```json [ { "userErrors": [], "product": { "id": "gid://shopify/Product/8569637372076", "title": "IQ-V1", "handle": "iq-v1", "status": "ACTIVE", "vendor": "AECQA", "tags": [], "unpublishedPublications": { "edges": [ { "node": { "id": "gid://shopify/Publication/123613773996" } }, { "node": { "id": "gid://shopify/Publication/123613872300" } }, { "node": { "id": "gid://shopify/Publication/123613937836" } }, { "node": { "id": "gid://shopify/Publication/124182200492" } }, { "node": { "id": "gid://shopify/Publication/147472089260" } } ] }, "metafields": { "nodes": [] }, "createdAt": "2026-05-26T11:12:49Z", "updatedAt": "2026-05-26T11:12:49Z", "options": [ { "id": "gid://shopify/ProductOption/10986411032748", "name": "Title", "position": 1, "optionValues": [ { "id": "gid://shopify/ProductOptionValue/4199242399916", "name": "Default Title", "hasVariants": true } ] } ], "variants": { "edges": [ { "node": { "id": "gid://shopify/ProductVariant/46311828979884", "sku": null, "title": "Default Title", "price": "0.00", "inventoryItem": { "id": "gid://shopify/InventoryItem/48406657335468", "tracked": false } } } ] }, "media": { "edges": [ { "node": { "id": "gid://shopify/MediaImage/33353414181036", "alt": "Mobileimg", "mediaContentType": "IMAGE", "status": "UPLOADED" } } ] } } } ] ``` -------------------------------- ### Get Posted Sales Shipment by No. - Example Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/business-central-odata.md Example JSON response from the 'Get Posted Sales Shipment by No.' action, showing the retrieved posted sales shipment details for shipment number '102001'. ```json [ { "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/{Tenant_Id}/Production/ODataV4/$metadata#Company('CRONUS%20IN')/PostedSalesShipment/$entity", "@odata.etag": "W/\"JzIwOzE3MTU0NjkzNzk1OTU2ODA1NjQ1MTswMDsn\"", "No": "102001", "Sell_to_Customer_No": "20000", "Sell_to_Customer_Name": "Selangorian Ltd.", "Sell_to_Customer_Name_2": "", "Sell_to_Address": "Southwark Bridge Rd, 91-95", "Sell_to_Address_2": "", "Sell_to_City": "Gurugram", "Sell_to_County": "", "Sell_to_Post_Code": "122002", "Sell_to_Country_Region_Code": "IN", "Sell_to_Contact_No": "CT000003", "SellToPhoneNo": "", "SellToMobilePhoneNo": "", "SellToEmail": "mr.mark.mcarthur@contoso.com", "Sell_to_Contact": "Helen Ray", "No_Printed": 0, "Posting_Date": "2023-01-17", "Document_Date": "2023-01-17", "Requested_Delivery_Date": "0001-01-01", "Promised_Delivery_Date": "0001-01-01", "Quote_No": "", "Order_No": "", "External_Document_No": "", "ShpfyOrderNo": "", "Salesperson_Code": "JO", "Responsibility_Center": "", "GetWorkDescription": "", "Ship_to_Code": "", "Ship_to_Name": "Selangorian Ltd.", "Ship_to_Name_2": "", "Ship_to_Address": "Southwark Bridge Rd, 91-95", "Ship_to_Address_2": "", "Ship_to_City": "Gurugram", "Ship_to_County": "", "Ship_to_Post_Code": "122002", "Ship_to_Country_Region_Code": "IN", "Ship_to_Phone_No": "", "Ship_to_Contact": "Helen Ray", "Location_Code": "BLUE", "Outbound_Whse_Handling_Time": "", "Shipping_Time": "", "Shipment_Method_Code": "", "Shipping_Agent_Code": "", "Shipping_Agent_Service_Code": "", "Package_Tracking_No": "", "Shipment_Date": "2024-02-25", "Vehicle_No": "", "Vehicle_Type": " ", "LR_RR_No": "", "LR_RR_Date": "0001-01-01", "Bill_to_Customer_No": "20000", "Bill_to_Name": "Selangorian Ltd.", "Bill_to_Name_2": "", "Bill_to_Address": "Southwark Bridge Rd, 91-95", "Bill_to_Address_2": "", "Bill_to_City": "Gurugram", "Bill_to_County": "", "Bill_to_Post_Code": "122002", "Bill_to_Country_Region_Code": "IN", "Bill_to_Contact_No": "CT000003", "BillToContactPhoneNo": "", "BillToContactMobilePhoneNo": "", "BillToContactEmail": "mr.mark.mcarthur@contoso.com", "Bill_to_Contact": "Helen Ray", "Shortcut_Dimension_1_Code": "", "Shortcut_Dimension_2_Code": "LARGE", "GST_Bill_to_State_Code": "HR", "GST_Ship_to_State_Code": "", "Location_State_Code": "DL", "Invoice_Type": "Taxable", "Nature_of_Supply": "B2C", "GST_Customer_Type": "Unregistered", "GST_Without_Payment_of_Duty": false, "Bill_Of_Export_No": "", "Bill_Of_Export_Date": "0001-01-01", "E_Commerce_Customer": "", "E_Comm_Merchant_Id": "", "POS_Out_Of_India": false, "Date_of_Removal": "2023-01-17", "Time_of_Removal": "00:00:00", "Mode_of_Transport": "" } ] ``` -------------------------------- ### Build Docker image Source: https://github.com/appseconnect/appse-ai-docs/blob/main/README.md Builds a Docker image for the documentation site. ```bash docker build -t appse-ai-docs . ``` -------------------------------- ### Get Item by ItemCode Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example output of the Get an Item by ItemCode action, showing the retrieved item details. ```json [ { "ItemCode": "AN005", "ItemName": "Demo Item", "InventoryItem": "tYES", "SalesItem": "tYES", "PurchaseItem": "tYES" } ] ``` -------------------------------- ### Get Contacts by Contact Type - Example JSON Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/business-central.md Example output from the Get Contacts by Contact Type action, showing a contact record with fields such as id, number, type, displayName, and email. The result is an array of contact objects. ```json [ { "@odata.etag": "W/\"JzIwOzEyODQ4MDc4MzEwNTI2ODQ0MzQwMTswMDsn\"", "id": "8abbb6a9-16c6-f011-8542-7c1e520ee21f", "number": "+918800766672", "type": "Company", "displayName": "SobhitaAggarwal", "jobTitle": "", "companyNumber": "+918800766672", "companyName": "SobhitaAggarwal", "contactBusinessRelation": "None", "addressLine1": "Street 1", "addressLine2": "", "city": "Kolkata", "state": "WB", "country": "IN", "postalCode": "700106", "phoneNumber": "+918800766672", "mobilePhoneNumber": "", "email": "aggrawalsobhita345@yopmail.com", "website": "", "searchName": "SOBHITAAGGARWAL", "privacyBlocked": false, "taxRegistrationNumber": "", "lastInteractionDate": "0001-01-01", "lastModifiedDateTime": "2025-11-20T13:41:50.28Z" } ] ``` -------------------------------- ### Magento2 Create a Product - Example Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/magento2.md Example JSON response returned after running the Create a Product action with the sample configuration (SKU LENOVO-V1, name Venovo-HP Elite book, attribute set 4, price 80000, status Enabled, type Simple). Shows the created product's id, timestamps, stock item details, and custom attributes. ```json [ { "id": 167, "sku": "LENOVO-V1", "name": "Venovo-HP Elite book", "attribute_set_id": 4, "price": 80000, "status": 1, "visibility": 4, "type_id": "simple", "created_at": "2026-06-05 06:03:53", "updated_at": "2026-06-05 06:03:53", "extension_attributes": { "website_ids": [ 1 ], "stock_item": { "item_id": 167, "product_id": 167, "stock_id": 1, "qty": null, "is_in_stock": false, "is_qty_decimal": false, "show_default_notification_message": false, "use_config_min_qty": true, "min_qty": 0, "use_config_min_sale_qty": 1, "min_sale_qty": 1, "use_config_max_sale_qty": true, "max_sale_qty": 10000, "use_config_backorders": true, "backorders": 0, "use_config_notify_stock_qty": true, "notify_stock_qty": 1, "use_config_qty_increments": true, "qty_increments": 0, "use_config_enable_qty_inc": true, "enable_qty_increments": false, "use_config_manage_stock": true, "manage_stock": true, "low_stock_date": null, "is_decimal_divided": false, "stock_status_changed_auto": 0 } }, "options": [], "media_gallery_entries": [], "custom_attributes": [ { "attribute_code": "options_container", "value": "container2" }, { "attribute_code": "url_key", "value": "venovo-hp-elite-book" }, { "attribute_code": "msrp_display_actual_price_type", "value": "0" }, { "attribute_code": "required_options", "value": "0" }, { "attribute_code": "has_options", "value": "0" }, { "attribute_code": "tax_class_id", "value": "2" }, { "attribute_code": "category_ids", "value": [] } ] } ] ``` -------------------------------- ### Get Company Number by Company Name - Example JSON Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/business-central.md Example output from the Get Company Number by Company Name action, showing a company contact record with fields such as number, displayName, and companyNumber. The result is an array of contact objects. ```json [ { "@odata.etag": "W/\"JzE5OzI3Mzk1NjU2NTk4MTU3MTUwNjYxOzAwOyc=\"", "id": "78878068-7577-f011-8eef-6045bdadacc5", "number": "CT012194", "type": "Company", "displayName": "AZTECH COMPANY", "jobTitle": "", "companyNumber": "CT012194", "companyName": "AZTECH COMPANY", "contactBusinessRelation": "Customer", "addressLine1": "", "addressLine2": "", "city": "NewTown", "state": "", "country": "", "postalCode": "700106", "phoneNumber": "+917008088082", "mobilePhoneNumber": "", "email": "", "website": "", "searchName": "AZTECH COMPANY", "privacyBlocked": false, "taxRegistrationNumber": "", "lastInteractionDate": "0001-01-01", "lastModifiedDateTime": "2025-08-12T12:11:03.21Z" } ] ``` -------------------------------- ### Create Price List - Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example response from the Create Price List action. All fields are required; in this example prices are increased by 10% using PERCENTAGE_INCREASE. ```json [ { "priceList": { "id": "gid://shopify/PriceList/24368971948", "name": "VIPs' Customer Price", "currency": "USD", "parent": { "adjustment": { "type": "PERCENTAGE_INCREASE", "value": 10 } } }, "userErrors": [] } ] ``` -------------------------------- ### Get Invoice by NumAtCard - Example Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example output of the Get Invoice by Customer Reference Number action when a matching invoice is found. The response includes the document entry, document number, customer reference number, customer code, and document total. ```json [ { "DocEntry": 11462, "DocNum": 715, "NumAtCard": "REF-INV01", "CardCode": "BC6129916", "DocTotal": 3955 } ] ``` -------------------------------- ### Example Connector Name Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/on-premise-agent/on-prem-agent.md Use a unique name to identify the On-Prem Connector. The example shows the format 'onprem-connector'. ```text onprem-connector ``` -------------------------------- ### Get Priority Version Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/priority.md Example output from the Get Priority Version action, showing the OData context and the version string. ```json { "@odata.context": "https://demo.priority-software.com/odata/Priority/tabula.ini/demo/$metadata#Edm.String", "value": "23.1.0.15" } ``` -------------------------------- ### Serve production build locally Source: https://github.com/appseconnect/appse-ai-docs/blob/main/README.md Serves the production build locally. ```bash pnpm serve ``` -------------------------------- ### Example Data: JSON object with order and items array Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/03-working-with-arrays.md Base data used across all examples on the page. Shows an order object containing an items array of product objects with name, price, and qty properties. ```json { "orderId": "ORD-001", "items": [ { "name": "Laptop", "price": 1200, "qty": 1 }, { "name": "Mouse", "price": 25, "qty": 2 }, { "name": "Keyboard", "price": 75, "qty": 1 } ] } ``` -------------------------------- ### Create Customer Equipment Card Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example response from the Create Customer Equipment Card action after running the node. Shows the created equipment card with fields like EquipmentCardNum, CustomerCode, InternalSerialNum, and InstallLocation. ```json [ { "odata.metadata": "https://insync.pro/b1s/v1/$metadata#CustomerEquipmentCards/@Element", "EquipmentCardNum": 2, "CustomerCode": "ZC0001", "CustomerName": "GivaJewellers", "ContactEmployeeCode": 4, "DirectCustomerCode": null, "DirectCustomerName": null, "ManufacturerSerialNum": "SL-002", "InternalSerialNum": "SL-002", "RequiredResolutionTime": null, "RequiredResolutionUnit": "rsu_Days", "ItemCode": "SERIAL001", "ItemDescription": "Serial Test", "InvoiceCode": null, "InvoiceNumber": null, "DeliveryDate": null, "ContactPhone": null, "Street": "Adffhgjh", "Block": null, "ZipCode": "33144", "City": "Miami", "County": null, "CountryCode": "US", "StateCode": "FL", "InstallLocation": "01", "ContractCode": null, "ContractStartDate": null, "ContractEndDate": null, "DeliveryCode": null, "DeliveryNumber": null, "StatusOfSerialNumber": "sns_Active", "ReplaceSN": null, "DefaultTechnician": null, "ReplacedBySN": null, "Defaultterritory": null, "BuildingFloorRoom": "", "AttachmentEntry": null, "StreetNo": null, "ServiceBPType": "et_Sales", "CustomerEquipmentCardBusinessPartners": [ { "BPCode": "ZC0001" } ] } ] ``` -------------------------------- ### Get Delivery by Order DocEntry Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example output of the Get Delivery by Order DocEntry action, showing delivery note and document line details. ```json [ { "DeliveryNotes": { "DocEntry": 134, "DocNum": 59, "NumAtCard": null }, "DeliveryNotes/DocumentLines": { "ItemCode": "TV654", "ItemDescription": "LG OLED55C2PUA 55-inch OLED TV", "Quantity": 100, "ShipDate": "2025-11-29", "BaseType": 17, "BaseEntry": 1876 } } ] ``` -------------------------------- ### Example prompt for AI Processor Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/nodes/built_in_nodes/ai_processor_node.md A sample prompt that uses dynamic expressions to insert product data and instructs the AI to perform tasks like rewriting descriptions and generating SEO keywords. ```text Analyze the following product and generate insights: Product Details: - Name: {{$payload.name}} - SKU: {{$payload.sku}} - Price: {{$payload.price}} Tasks: 1. Rewrite description 2. Generate SEO keywords 3. Suggest category 4. Provide improvements ``` -------------------------------- ### Get Item Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/priority.md Example JSON response from the Get Item action for item SKU-100, including the LOGCOUNTERS_SUBFORM subform with warehouse stock counters. ```json { "@odata.context": "https://demo.priority-software.com/odata/Priority/tabula.ini/demo/$metadata#LOGPART/$entity", "@odata.etag": "W/\"MjAyNi0wOC0xMVQxNDowMjoxOVo=\"", "PARTNAME": "SKU-100", "PARTDES": "Industrial Pump Model XZ", "UNITNAME": "PCS", "BARCODE": "8901234567890", "FAMILYNAME": "PUMPS", "STATDES": "Active", "VATFLAG": "Y", "LOGCOUNTERS_SUBFORM": [ { "WARHSNAME": "MAIN", "BALANCE": 120, "RESERVED": 15 } ] } ``` -------------------------------- ### Real-World Example 1: Extract Product List (input and output) Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/03-working-with-arrays.md Build a JSON response that includes product names, count, and total price from the items array. The output shows the resulting JSON. ```javascript { "orderRef": "{{ $payload.orderId }}", "productNames": "{{ $payload.items[*].name }}", "productCount": "{{ length($payload.items) }}", "orderTotal": "{{ sum($payload.items[*].price) }}" } ``` ```json { "orderRef": "ORD-001", "productNames": ["Laptop", "Mouse", "Keyboard"], "productCount": 3, "orderTotal": 1300 } ``` -------------------------------- ### Set up ngrok tunnel for temporary public access Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/local-llm.md Authenticate the ngrok CLI with your authtoken, then start a temporary public HTTPS tunnel to the port your LLM server listens on (e.g., 1234 for LM Studio). The second command prints a Forwarding URL to paste into the Local AI credential's Server URL. ```bash ngrok config add-authtoken ``` ```bash ngrok http 1234 ``` -------------------------------- ### Get Order Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/priority.md Example JSON response from the Get Order action for order SO26000431, including the ORDERITEMS_SUBFORM subform with order line details. ```json { "@odata.context": "https://demo.priority-software.com/odata/Priority/tabula.ini/demo/$metadata#ORDERS/$entity", "@odata.etag": "W/\"MjAyNi0wOC0xMVQxMzoyODo1MVo=\"", "ORDNAME": "SO26000431", "CUSTNAME": "CUST001", "CDES": "ABC Manufacturing Inc", "REFERENCE": "PO-2026-4417", "CURDATE": "2026-08-11T13:10:27+00:00", "ORDSTATUSDES": "New Order", "CODE": "USD", "TOTPRICE": 4250, "ORDERITEMS_SUBFORM": [ { "LINE": 1, "PARTNAME": "SKU-100", "PDES": "Industrial Pump Model XZ", "TQUANT": 5, "PRICE": 850, "QPRICE": 4250 } ] } ``` -------------------------------- ### Step 2 - Top-level structure with products field Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/openai.md Defines the root object with a single 'products' property. The root must be an object, and 'additionalProperties' is set to false. ```json "schema": { "type": "object", "properties": { "products": { ... } }, "required": ["products"], "additionalProperties": false } ``` -------------------------------- ### Quick expression examples with outputs Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/intro.md Expressions that demonstrate common data access and transformation patterns on the sample JSON. Each expression is paired with its expected output in the documentation table. ```js {{ $payload.orderId }} ``` ```js {{ $payload.items[*].name }} ``` ```js {{ length($payload.items) }} ``` ```js {{ sum($payload.items[*].price) }} ``` ```js {{ $('nodeName').all[].email }} ``` ```js {{ $('nodeName').matchedPayload[].crmLeads[?status == 'Qualified'].name[] }} ``` -------------------------------- ### Get Currency Exchange Rate Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example output of the Get Currency Exchange Rate action, showing the exchange rate value for the requested currency and date. ```json [ { "value": "5.60" } ] ``` -------------------------------- ### Get Price List Result JSON Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/priority.md Example JSON response from the Get Price List action, showing the price list header and its subform with item prices. ```json { "@odata.context": "https://demo.priority-software.com/odata/Priority/tabula.ini/demo/$metadata#PRICELIST/$entity", "@odata.etag": "W/\"MjAyNi0wOC0xMVQxNDo1MDoxMlo=\"", "PLNAME": "PL2026Q3", "PLDES": "Standard Wholesale Q3 2026", "CODE": "USD", "VALIDDATE": "2026-07-01T00:00:00+00:00", "EXPIRYDATE": "2026-09-30T00:00:00+00:00", "PARTPRICE2_SUBFORM": [ { "PARTNAME": "SKU-100", "PDES": "Industrial Pump Model XZ", "PRICE": 850, "PERCENT": 0 } ] } ``` -------------------------------- ### Extract Order Information Example Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/02-accessing-data.md Real-world example extracting order information from the payload. The first block shows the expression template, and the second shows the resulting output. ```js { "orderReference": "{{ $payload.orderId }}", "customer": "{{ $payload.customerName }}", "deliveryCity": "{{ $payload.shipping.city }}" } ``` ```json { "orderReference": "ORD-001", "customer": "Alice Johnson", "deliveryCity": "Seattle" } ``` -------------------------------- ### Get Customer Billing Addresses - JSON Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/magento2.md Example JSON response from the Get Customer Billing Addresses action, showing billing address details for a customer. ```json [ { "id": 362, "customer_id": 3740, "region": { "region_code": "TG", "region": "Telangana", "region_id": 600 }, "region_id": 600, "country_id": "IN", "street": [ "Voxvalley street, lgitech building" ], "telephone": "9087654522", "postcode": "500038", "city": "Hyderabad", "firstname": "Amrin", "lastname": "Kantura", "default_shipping": true, "default_billing": true } ] ``` -------------------------------- ### Build static site with pnpm Source: https://github.com/appseconnect/appse-ai-docs/blob/main/README.md Generates static content into the build directory, which can be served by any static content hosting service. ```bash pnpm build ``` -------------------------------- ### Sample payload for date functions (Scenario 1) Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/06-using-functions.md Sample payload with created_at and updated_at fields shown for date/time function examples. This is the relevant excerpt for Scenario 1. ```json "created_at": "2026-01-14 12:05:20", "updated_at": "2026-02-01 12:31:27", ``` -------------------------------- ### Get Customer by Email Address - JSON Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/magento2.md Example JSON response from the Get Customer by Email Address action, showing customer details and search criteria. ```json [ { "items": [ { "id": 3740, "group_id": 1, "created_at": "2026-06-04 13:14:26", "updated_at": "2026-06-05 05:15:07", "created_in": "Default Store View", "email": "demon1.mavin@yopmail.com", "firstname": "Kevin", "lastname": "Kantura", "store_id": 1, "website_id": 1, "addresses": [], "disable_auto_group_change": 0, "extension_attributes": { "is_subscribed": false } } ], "search_criteria": { "filter_groups": [ { "filters": [ { "field": "email", "value": "demon1.mavin@yopmail.com", "condition_type": "eq" } ] } ] }, "total_count": 1 } ] ``` -------------------------------- ### Business Central New Items Created - Trigger Configuration Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/business-central.md The source does not contain code; only an image placeholder for credentials and configuration fields. ```json [REDACTED] ``` -------------------------------- ### Get Company Addresses - Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/bigcommerce-b2b.md Example JSON response returned by the Get Company Addresses action, showing an array of address objects with fields like addressId, firstName, and companyId. ```json [ { "addressId": 35205391, "firstName": "Martin", "lastName": "Josh", "phoneNumber": "07890981310", "zipCode": "500081", "addressLine1": "Cafe Niloufer Hitech City Penmaktha", "addressLine2": "TLR LUXURY RESIDENCY", "city": "Serilingampalle (M), Hyderabad", "stateName": "Telangana", "countryName": "India", "stateCode": "TS", "countryCode": "IN", "companyId": "12623321", "isBilling": true, "isShipping": true, "isDefaultBilling": false, "isDefaultShipping": false, "label": "", "externalId": null } ] ``` -------------------------------- ### Step 4 - Describe a single product object Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/openai.md Defines the properties of a single product: id (integer), name (string), sku (string), price (number), currency (string), status (string with enum), and created_at (string with date-time format). All fields are required and additionalProperties is false. ```json "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "sku": { "type": "string" }, "price": { "type": "number" }, "currency": { "type": "string" }, "status": { "type": "string", "enum": ["active", "inactive", "out_of_stock"] }, "created_at": { "type": "string", "format": "date-time" } }, "required": ["id", "name", "sku", "price", "currency", "status", "created_at"], "additionalProperties": false } ``` -------------------------------- ### Get Serial Number Details by Serial Number - Example JSON Response Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/sap-b1.md Example response from the Get Serial Number Details by Serial Number action when the serial number exists. The response is an array with one object containing item details such as DocEntry, ItemCode, SerialNumber, and dates. If the serial number does not exist, the response will be empty or null. ```json [ { "DocEntry": 1, "ItemCode": "SERIAL001", "ItemDescription": "Serial Test", "MfrSerialNo": "SL001", "SerialNumber": "SL-001", "LotNumber": "123", "SystemNumber": 1, "AdmissionDate": "2026-04-20", "ManufacturingDate": null, "ExpirationDate": null, "MfrWarrantyStart": null, "MFrWarrantyEnd": null, "Location": "01", "Details": null } ] ``` -------------------------------- ### Complex Business Logic Example Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/platform/key_concepts/expressions_mapping/04-filtering-data.md Applies multiple conditions to filter bulk orders and discount-eligible products. ```js { "bulkOrders": "{{ $payload.items[?qty > `1` && price > `50`][*].name }}", "discountEligible": "{{ $payload.items[?price > `100` || qty > `1`][*].{product: name, price: price} }}" } ``` -------------------------------- ### Get Price List by Catalog ID Result Source: https://github.com/appseconnect/appse-ai-docs/blob/main/docs/app_integrations/shopify.md Example result of the Get Price List by Catalog ID action, showing the retrieved price list details for a specific Shopify catalog. ```json [ { "id": "gid://shopify/CompanyLocationCatalog/64039649452", "title": "B2B Catalog", "status": "ACTIVE", "priceList": { "id": "gid://shopify/PriceList/24205361324", "name": "B2B Catalog - d544236a-8c9e-4f45-8d9e-6f96ba03e751", "currency": "USD", "fixedPricesCount": 2, "parent": { "adjustment": { "type": "PERCENTAGE_DECREASE", "value": 5 } } }, "publication": { "id": "gid://shopify/Publication/147472089260", "name": "" }, "companyLocations": { "nodes": [ { "id": "gid://shopify/CompanyLocation/892502188", "name": "Anitha kumari", "externalId": null } ] } } ] ```