NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Dpd2 connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Dpd2 actions, such as "Get Storefront", "List DPD Customers (Filtered)" and "List DPD Purchases". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Dpd2, with input parameters and output schema.
DPD2_GET_STOREFRONTRetrieves detailed information about a specific DPD storefront by its ID. Returns storefront configuration including name, URL, contact details, currency, type, and subdomain. Use this after obtaining a storefront ID from DPD2_LIST_STOREFRONTS or when you need to fetch current metadata for a known storefront.
Input parameters
The numeric storefront ID to retrieve. Obtain this from DPD2_LIST_STOREFRONTS or use a known storefront ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_LIST_CUSTOMERS2Tool to list customers in your DPD account with advanced filtering. Use when you need to find customers by email, name, product purchases, newsletter subscription status, or creation date range.
Input parameters
Page number for paginated results (starts at 1).
Customer email (startswith match, not case sensitive). Use to find customers by email prefix.
Customer created before this date (PHP strtotime format, e.g., 'YYYY-MM-DD', '1 week ago', 'yesterday'). Use to filter customers created before a specific date.
Customer created after this date (PHP strtotime format, e.g., 'YYYY-MM-DD', '2 weeks ago', 'last Monday'). Use to filter customers created after a specific date.
Number of customers to return per page (max 100).
Customer last name (startswith match). Use to find customers by last name prefix.
Customer first name (startswith match). Use to find customers by first name prefix.
Product ID that the customer has purchased. Use to find customers who bought a specific product.
Whether customer receives email from product updates. Use true to find subscribed customers, false for unsubscribed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_LIST_PURCHASESTool to list all purchases made through your DPD account. Use when you need to retrieve purchase records with optional date filters and pagination for reporting or analysis.
Input parameters
Page number for results pagination (default 1)
Number of purchases to return (max 1000)
Only include purchases made on or after this date (YYYY-MM-DD)
Only include purchases made on or before this date (YYYY-MM-DD)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_LIST_STOREFRONTSTool to list all storefronts in your DPD account. Use after authenticating to fetch storefront details before managing products or purchases.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_LIST_SUBSCRIBERSTool to list subscribers for a given storefront. Use when you need a paginated and filtered list of subscribers after storefront setup.
Input parameters
Page number to retrieve (>=1).
Filter by subscriber email address.
Only return subscribers added or updated since this ISO8601 timestamp.
Additional filter expression.
Number of subscribers per page.
Storefront ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_PINGTool to ping the API to check its status. Use when verifying API connectivity before further operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_VERIFY_NOTIFICATION2Tool to verify a POST from the URL integration (IPN/webhook). POST all parameters that were POSTed to your site to confirm authenticity. Use after receiving an IPN notification to validate it came from DPD.
Input parameters
Total tax amount
Unique identifier for the purchase/transaction
The discount (coupon) amount applied to the order
Total amount of payment
The coupon code used on the order, if any
Currency of the total amount
Total shipping cost
Verification signature from the original notification
Shipping method used
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DPD2_VERIFY_SUBSCRIBERTool to verify a subscriber's subscription status. Use when you need to check if a subscriber is active and receiving service. Either username (email) or subscriber ID must be provided.
Input parameters
Subscriber ID. Either username or subscriber_id must be provided.
Username (the subscriber's email address). Either username or subscriber_id must be provided.
The numeric storefront ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 8 Dpd2 actions on Nagent, including "Get Storefront", "List DPD Customers (Filtered)" and "List DPD Purchases". Get Storefront: Retrieves detailed information about a specific DPD storefront by its ID. Each action is listed on this page with its input parameters and its output.
Dpd2 connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Storefront takes 1 required input: id. It returns data, error and successful.