For AI agents: visit https://docs.digitalgenius.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Home
Documentation
Documentation
Home
Documentation
Brightpearl
Help and Support
Where can I get help?
Using the Support Portal
AI
E-commerce Intents
Change Order Category
Return Questions Category
Order Status Category
Quality Issue Category
Update Account Category
Miscellaneous Category
In Store Category
Loyalty Program
Chat Category
Subscription Category
Business Inquiry Category
Online Category
Actions
Conversation Sentiment Detection
Conversation Summarization
Generative Prompt
Generic AI Agent
Testing
Conversation Simulations
CARRIER MODULES
WIZMO
🔑 WIZMO Track & Trace
🔑 InPost UK Track & Trace
🔑 InPost PL Track & Trace
DX Express Track & Trace
DX Delivery
Sending ES Track & Trace
UniUni Track & Trace
IFS Group Track & Trace
🔑 J&J Fulfillment Track & Trace
InPost
IFS Group
Sending ES
Track Your Parcel
🔑 PostAG Track & Trace
🔑 Yamato Track & Trace
🔑 ShipBob Get Shipment by Shipment ID
ShipBob
🔑 ShipBob Get Order by Reference ID
🔑 ShipBob Cancel Order
Genius Chat Widget
Widget Features
Technical Documentation
Mobile Platform Support
Creating and Updating Widgets
Integrating Genius Chat Widget
Configuration
CSAT (Customer Satisfaction Score)
Language
Callbacks
General Settings
Pre Chat Form
Styles
Theme
Widget Position & Dimensions
Session Storage Mechanism
Embedded Widgets
Proactive Buttons
URL To Locale Map
Methods
Browser support
Chat session timeout
URL Parameters
Authenticating Users
Generative AI Setup
Passing data to the widget
Returns Portal
Initialising a Return
Flow Configuration
Product Selection Step
Return Options Step
Important Information Step
Shipping Information Step
Return Details Step
Cancel Return Step
Return / Order Status
Drop Off Locations
Error Handling
Custom Flow Inputs
Message Types
Calendar
Form
Request User Details Component
List
Carousel
Order Tracker
Return Overdue
Video
Genius Chat Headless Chat SDK
Flow Inputs
Handover to a Helpdesk
Widget Analytics
Recipes
CSP Configuration
Campaigns
Campaign Examples
Programmatic Control of Genius Chat
Release Notes
Modules & Actions
Active Ants
Active Ants Search for Order by Order Number
Adyen
Adyen
DG Adyen Get Event
Adyen Send Payment for a Refund
AI / NLP
Predict Tech E-commerce Intent V1
Predict E-commerce Intent V2
Extract Regex Groups
Entity Extraction
Regex
Detect Sentiment
Preprocessing Clean Message
Language Detection
Predict E-commerce Intent
Keyword Detection For Multiple Targets V2
AI Intent using DG QA AI
AI Value using DG CI AI
Keyword Detection for multiple targets
Extract Address
Extract Address v2
Merge Text / Merge lists
Merge Clean Subject & Description
Convert Country
Predict Subscription E-commerce Intent V1
Detect Product Names In Text
Fuzzy Match List
Translate Text
DG Return Intent Hints E-commerce V2
Knowledge Base Synchronisation across CRMs
APIs
Create Basic Token
Flow Execution Integration Guide
HTTP Request
Generic DigitalGenius API call
Parse JSON
Batch Conversational Flow Executions
Create Basic Token
JSON Object Lookup
Extract JSON Field(s) Gracefully
JSON Remove Key
Object Get Keys and Values
Aptos
Aptos Get Order by Order Number
Aptos Set Order Status
Aptos Set Item Status
Aptos Set Item Status V2
Aptos Credit Order Simple
Aptos Get Orders by Email
Aurora
AWS
BigCommerce
BigCommerce Search for Order by Order Number
BigCommerce Search for Order by Email
Brightpearl
Brightpearl Get Stock by Product ID
Brightpearl Get Order by Order ID
Brightpearl Product Search
Byrd
Byrd Search for Shipments by Email
Byrd Search for Shipment by Order#
Calculations
Numbers Operation
Centra
Centra Search For Order by Order Number
Centra Search For Order by Email
Centra Get Stock by Product EAN
Centra Search for Shipments by Order Number
Centra Get Stock by Variant SKU and Size SKU
Centra Get Stock Levels
Veeqo
Veeqo Search For Order
Veeqo Cancel Order by ID
Bleckmann
Bleckmann Get Order by Order Number
PostCo
PostCo Get Return by Order Number
Checks
Compare Terms
Check if Value is Present or Empty (null)
Greater Than ?
Check if Empty/Null and Replace
Identity Function
Identity Function for Strings
Identify Function Yes / No
Identify Function Time Unit
Citrus Lime
Citrus Lime Get Order by ID
CommerceCloud (Demandware)
CommerceCloud Find Orders by Email
CommerceCloud Find Order by Order Number
API Access
CommerceTools
CommerceTools Search for Order by Order Number
CommerceTools Search for Order by Email
CXone
CXOne Send Internal Note
CXOne Get Case Messages
CXOne Search For Cases By Email
CXOne Send Outbound Message
CXOne Update Case Queue
CXOne Get Case Data
CXOne Update Case Status
CXOne Add Tags
Date / Time
Check Time Past Since Some Date in Business Days
Get Next Business Day Date
Parse and Format Date
Calculate Estimated Shipping Date
Get Current DateTime
Get Time Attributes From Parsed Date
Working Hours Checker
Add Time to Date
Check Time Past Since Some Date
Convert Timestamp to Date
Convert Timestamp to Date v2
Compare dates
Dates Operation
Calculate Delivery SLA Status
Calculate Lost In Transit Status
Elapsed Time With Exclusions
DigitalGenius
DG Get Ticket Analytics
DG Create Chat Transcript
DG Chat Send Reply
DG Find and Replace Action/Flow in a Flow
Get Carrier Storage Data
Upsert Carrier Storage Data
DG Carrier Storage Track & Trace
Dixa
Send Internal Note
Claim Conversation
Send Message
Close Conversation
Transfer Conversation
Delete Tag from Conversation
Dixa Reopen Conversation
Dixa Check for Attachments & Inline Images in Conversation
Dixa Update Conversation Custom Attributes
Tag Conversation
Dixa Get EndUser Conversations
Dixa Update CSAT
Dixa Create Conversation Email
Dixa Get Agent Presence by Queue
Dixa Create Conversation Follow Up
eBay
eBay Get Case by Case ID
eBay Get Inquiry by Inquiry ID
eBay Get Order Data by Order ID
eBay Search Cases by Criteria
eBay Search Inquiries by Criteria
eBay Send Message via Inquiry
eBay Issue Refund via Inquiry
Frate
Frate Add Email to AllowList
Frate Generate DeepLink
Freshchat
Freshdesk
Freshdesk Get Custom Ticket Field
Freshdesk Get Tickets by Requester ID with Filters
Freshdesk Get Ticket Fields
Freshdesk Get Ticket Comments
Freshdesk Unassign Agent from Ticket
Freshdesk Update Ticket Field
Freshdesk Create Intent Field
Freshdesk Create Ticket
Freshdesk Apply Note
Freshdesk Update Tags
[Deprecated] Freshdesk Update Ticket Status
Freshdesk Get Requester Details
Freshdesk Send Reply
Freshdesk Forward Ticket
Freshdesk Create Ticket Email
Zendesk Add Ticket Comment
Freshdesk Send Reply with Attachment
Freshdesk Change Ticket Responder
Genesys
Genesys Get Conversation
Genesys Set Participant Data
Genesys Send Email Message
Genesys Assign Conversation
Genesys Update Queue
Genesys Apply Wrap Up
Genesys Disconnect Conversation
Genesys Get Conversation Full
Gladly
Gladly Get Conversation Data
Gladly Get Customer Conversations List
Gladly Get Customer Data
Gladly Apply Conversation Note
Gladly Reply to Message
Gladly Send Outgoing Email
Gladly Update Assignee
Gladly Update Conversation Status
Gladly Update Conversation Topics
Global-e
Global-e Search For Order by Order ID
Global-e Track & Trace
Google Services
Get Google Drive File ID
Google Sheets Search
Google Append Data To Spreadsheet
Google Update Data In Spreadsheet
Google Sheets Search With Filtering
Google Spreadsheet To List
Google Sheets key value with row number
Google Sheets to Key:Value
Google Geocoding Services
Google Clear Data From Spreadsheet
Google Delete a Row from Spreadsheet
Upload File to Google Drive
Gorgias
Gorgias Send WhatsApp Reply
Gorgias Update Ticket Assignee
Gorgias Send Email Reply
Gorgias Update Ticket Status
Gorgias Update Tags
Gorgias Create Ticket
Gorgias SMS Create Ticket
Gorgias Create CSAT Survey
Gorgias Get Ticket Fields
Gorgias Get Ticket Status
Gorgias Get Ticket Channel
Gorgias Get Account Info
Gorgias Send Internal Note
Gorgias Get Ticket Messages
Gorgias List Customers
Gorgias Update Customer Note
Gorgias List Tickets
Gorgias Send SMS Reply
Gorgias Apply Macro
Gorgias Snooze Ticket
Gorgias Get Voice Calls
Gorgias Check if Agent Responded
Huboo
Huboo Cancel Order
Huboo Create Order
InRetrn
InRetrn Search for Returns by Order Number
Klaviyo
Klaviyo Unsubscribe Customer
Klaviyo Fetch Profile By Email
Klaviyo Fetch "Latest Sent Email" Event
Klaviyo Fetch Campaign Content
Knowledge Retrieval with ChatGPT
Kustomer
Kustomer Get Conversation and Related Information
Kustomer Create Ticket
Kustomer check for attachments (COPY)
Kustomer Add/Delete Conversation Tags
Kustomer Get Tags by ID List
Kustomer Add Conversation Note
Kustomer Update Conversation Priority
Kustomer Update Conversation Status
Kustomer Update Conversation Assignee
Kustomer Update Conversation Custom Field
Kustomer Update Conversation Standard Field
Kustomer Update Customer Attribute
Kustomer Send Email Message
Kustomer Get Customer Data
Kustomer Get Customer Data by Email
Kustomer Get Snippets by Key
Kustomer Forward Conversation
Kustomer Send Message V2
Kustomer Send Message with Attachment
Kustomer Get Organisation ID
Kustomer Get Agent Availability by Queue ID
List Operations
Filter List
Operations with Two Fields From List Items
Sum/Multiply Items in List
Concatenate Multiple Items in List
Concatenate Items in List
List Includes
List Length
Slice List
Sort List
Loop - Shopify
Loop Get Subscription from Shopify Customer
Loop Get Subscription Details
Loop Cancel Subscription
Loop Send Login Link
Loop Returns
Loop Returns Create Allowlist Entry
Loop Returns Get Return
LoyaltyLion
LoyaltyLion Get Customer By Email
Magento 1
Magento Find Orders
Magento Get Order by Order ID (SOAP v1)
Magento Get Orders by Email (SOAP v1)
Magento 2
Magento2 Search for Orders by Email
Magento2 Search for Orders by Order #
Magento2 Search for Invoice by Order ID
Monta
Monta Search for Order by Order Number
Narvar
Narvar Get Order by Order Number
NetSuite
NetSuite Get Sales Order by Order Number
NetSuite Update Order Field
NetSuite SuiteQL Query
OIL
OIL Search For Order by Order Number
OIL Search For Order by Email
OIL Search For Shipment by Order Number
Omnium
Oracle
Oracle Get Incident
Oracle Get Working Hours
Oracle Create Incident
Oracle Search and Create Contact
Oracle Get Incident Attachments
Oracle Update Custom Field
Oracle Retrieve Incident Text Description
Oracle Update Incident Disposition
Oracle ROQL
Oracle Create Message
Oracle Update Standard Field
Oracle Update Incident Status
Parcel Lab
Parcel Lab Search for Order by Order#
Parcel Lab Search for Order by Email
Parcel Lab Get Checkpoints by Order Number
ProstarParcel
📦 ProStarParcel Shipping Label Upload
Recharge
Recharge Get Address
Recharge Get One-Time Orders
Recharge Delete One-Time Order
Recharge Update Address
Recharge Get Orders
Recharge Change Subscription Next Charge Date
Recharge Get Customer By Email
Recharge Update Subscription Quantity
Recharge Update Subscription Frequency
Recharge Apply Discount on Charge
Recharge Skip a Charge
Recharge Get Charges
Recharge Apply Discount on Address
Recurly
Recurly Update Address
Recurly Get Orders
Recurly Get Customer By Email
Recurly Get Subscriptions By Email
Recurly Cancel Subscription
Recurly Change Subscription Next Charge Date
ReturnGO
ReturnGO Search for Return
Reveni
Reveni Get Return by Order Number
Reveni Get Return Label
RevenueCat
RevenueCat Search for User Subscriptions
AWS S3 Bucket Upload File
Scayle
Scayle Get Order by ID
Scayle List Orders with Filters
Scayle List Customers with Filters
Shipstation
Shipstation Order Status
Shipstation Hold Order
Shipstation Update Order Status
ShipStation Return Label
Shopify
Shopify - Add A New Connection
Checks Tags on Shopify Order Lines
Shopify Find Orders
Shopify Check Order Refund
Shopify Search for Orders Basic Info by Email
Shopify Check Order Tags
Shopify Cancel Order
Shopify Add Tags To Order
Shopify Add Tags To Customer
Shopify Add or Replace Customer Note
Shopify Search for Order by Email
Shopify Full Refund With Any Token
Shopify Create Draft Order
Shopify Issue Gift Card
Shopify Send Draft Order Invoice
Shopify Refund Order with Note
Shopify Get Order Metafields
Shopify Get Customer By Id
Shopify Get Product By Id
Shopify Create Replacement Order
Shopify Create Replacement Order v3
Shopify Refund Order Line Items and Shipping Fee v2
Shopify Get Inventory Level by Location
Shopify Generate Discount Code
Shopify Order Utils
Shopify Get Order Inventory Level
Shopify Get Line Item Inventory Level
Shopify Replace Item
Shopify Update Order Shipping Address
Shopify Update Default Address to New Address
Shopify Get Inventory Levels by Variant ID
Shopify Check if Order Cancellable
Shopify Check Order Products Tags
Shopify Cancel and Refund Order v2
Shopify Get Inventory Item by Id
Shopify Get Products
Shopify Create Price Rule
Shopify Get Price Rule
Shopify Update Price Rule
Shopify Create Discount Code Fixed Amount GraphQL
Shopify Get Product Variant Details by SKU
Shopify Close Order
Shopify Get Product Images
Shopify Create Fulfillment
Shopify Add Order Note
Shopify Send User Activation Email
Shopify Get Product Image By Id
Shopify Create Customer With Address GraphQL
Shopify Get Customer By Email
Shopify Check Order Lines Tags V2
Shopify Check Order Tags (Order Input)
Shopify Complete Draft Order
Shopify Create Discount Code
Shopify Find Order by Order Name (oAuth)
Shopify Find Order by Order Number
Shopify Unsubscribe Customer from Email Marketing
Shopify Generate Gift Card
Shopify Get Order Cancellation
Shopify Has Customer Bought Item
Shopify Check Order Specific Tag
Shopify Retrieve Product Details
Shopify GraphQL
Shopify Get Returns
Yofi - NoFraud
Yofi Get Customer Data
Corso
Corso List Shipping Claims
Corso List Orders
Corso Create Shipping Claim
Stay.ai
Stay.ai Get Subscriptions By Email
Stay.ai Cancel Subscription
Stay.ai Change Address
Stay.ai Generate Portal Link
Stay.ai Skip Subscription
Stay.ai Pause Subscription
Stay.ai Unpause Subscription
Stay.ai Reactivate Cancelled Subscription
Stay.ai Swap Product In Subscription
String / Text Manipulation
Slice Text
Levenshtein String Matching Percentile
Sanitize String
JSON Stringify
String Operation
Base64 Encode Text
URL Encode Text
Image URL to Base64
Image URL to Base64 with compression
Seperate JSON into List
Replace String Based On Boolean
Fernet Decryption
Stripe
Stripe Search for User by Email
Stripe Search for User by Subscriptions
Stripe Refund Subscriptions
Stripe Cancel Subscriptions
Sugar CRM
Sugar Get Case Data
Sugar Update Case Field
Sugar Add Case Note
Sugar Get Contact Data
Sunshine Conversations
SunCo Chat Handover
SunCo Send Structured Chat Message (Buttons)
SunCo Send Chat Message
Swap Commerce
Swap Get Returns by Email
Swap Get Returns by Order Number
Swap Get Returns by RMA
Webshipper
Webshipper Search for Order
Whiplash
Whiplash V2 Generate Access Token
Whiplash V2 Perform Action on Order
Whiplash V2 Search for Orders
Whiplash V2 Change Shipping Address
WooCommerce
WooCommerce Find Orders by Email
WooCommerce Find Order by Order Number
Zendesk
Zendesk has an Attachment
Zendesk get Ticket Subject
Zendesk get Ticket Requester & Submitter Emails
Zendesk API Search And Merge Tickets
Zendesk - Search And Merge Tickets
Extract Zendesk Custom Field
Zendesk—Create Side Conversation
Zendesk Merge Tickets
Zendesk Delayed Tickets Batch Action
Update Zendesk Tags
Zendesk Has Embedded Image
Zendesk Get User Fields
Zendesk Get Custom User Field
Zendesk Search Contact by Phone
Zendesk Get Group ID
Zendesk Get Form ID
Zendesk Get Custom Field
Zendesk Get Brand
Zendesk Update Ticket Due Date
Zendesk change Ticket Requester by Email
Zendesk Create Intent Ticket Field
Zendesk Create Intent Ticket Field
Update Zendesk DG Intent Ticket Field
Zendesk Update Field
Handover Zendesk Conversation Chat
Add Zendesk Conversation Chat Tags
Zendesk Get Ticket Fields
Zendesk Get Agent Availability
Zendesk Retrieve User and Assign
Zendesk Search
Zendesk Check Ticket Tags
Send Zendesk Chat Conversations Structured Message
Send Zendesk Chat Conversations Message
Zendesk Send Attachment
Zendesk Batch Attachments
Zendesk Apply Macro
Zendesk Update Standard Field
Zendesk Get Ticket Last Responder Email
Zendesk Check for Embedded Images in Comments
Zendesk Get WhatsApp Messages
Zendesk Update Form
Zendesk Update Field
Zendesk Get Agents in Group
Bulk Update Zendesk Fields
Zendesk Add Tags
Zendesk Change Ticket Requester
Zendesk Assign Ticket
Zendesk Make Comment Private
Zendesk Get Ticket Comments
Zendesk Get Ticket Conversation Log
Zoho
Zoho Get Ticket Content
Zoho Update Custom Ticket Field
Zoho Create Ticket Comment
Zoho Send Email Reply
Zoho Retrieve Ticket Fields
Zoho Generate Access Token
Odlo
Forward Email (SendGrid)
📦 GFS
GFS Get Tracking
Extensiv
Extensiv Create Authentication Token
Extensiv Get Order By Field
Flexport
Flexport Get Order by External ID
Google API
Landmark Global
Landmark Global Track Order
Tutorials
Shopify: Create Fulfillment Webhook
Other
Browser Automation
Claims Processing through DG
Evri
In House Orders APIs Integration
Salesforce Agent Assist
Release 1.143
HelpDesks
Dixa
Add DigitalGenius Webhook
Create Dixa API Token
DG Analytics Webhook
Freshchat
Freshchat Webhook Setup
Freshdesk
DG New Tickets Automation
Conversational Automation: Customer Messages
Conversational Automation: Agent and DG Bot Messages
DG Analytics - Record Full Resolution Rate
Gorgias
Gorgias API Credentials
[Gorgias] Ticket Unassign Process
Connect to MASTER FLOW - HTTP Integration
Record DG Analytics from Gorgias
Kustomer
Add DigitalGenius Kustomer Webhook (Master)
Add DigitalGenius Kustomer Webhook (Analytics)
Add DigitalGenius Kustomer API Key
Oracle Service Cloud
Send Incident into Master Flow
Salesforce Service Cloud
Installing Flow Package & Connect to DG MASTER FLOW
Salesforce Operations
Salesforce Add Chatter Comment
Salesforce Variables in Emails
Salesforce Social (GEN25)
Package Installation
Social Batch Flow
Package Configuration
Zendesk Chat / Messaging /Sunshine Conversations
Zendesk Tickets
Connect to MASTER FLOW - Zendesk Trigger
Automation User
Connect to Analytics Flow - Zendesk Trigger
Create Webhook
Zoho Desk Tickets
Create Connection
Create Function
Create Workflow Rule
Get Refresh Token
DG Analytics - Last Assignee Automation
MCP
DigitalGenius MCP Server
Ask Genie
Powered by
Brightpearl
https://api-docs.brightpearl.com/
Copy Page
