Goody
goodyGoody is a platform that enables users to send gifts and physical products without handling logistics, offering APIs for commerce and automation.
Acciones disponibles (9)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Calculate Price for Order BatchGOODY_CALCULATE_PRICE_FOR_ORDER_BATCHAcciónTool to estimate per-recipient and total price for an order batch. Use when you want to preview costs before creating the batch.
GOODY_CALCULATE_PRICE_FOR_ORDER_BATCHAcciónTool to estimate per-recipient and total price for an order batch. Use when you want to preview costs before creating the batch.
Parámetros de entrada
cartobjectObligatorioCart details (items and quantities)
recipientsobject[]ObligatorioList of recipients to estimate pricing for
send_methodstringObligatorioenumSending method; 'direct_send' requires mailing_address for each recipient
email_and_linklink_multiple_custom_listdirect_send
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Active CardsGOODY_LIST_ALL_ACTIVE_CARDSAcciónTool to list all active digital greeting cards. Use when you need to fetch available card options before sending.
GOODY_LIST_ALL_ACTIVE_CARDSAcciónTool to list all active digital greeting cards. Use when you need to fetch available card options before sending.
Parámetros de entrada
pageintegerPage number for pagination (starting from 1)
per_pageintegerNumber of items per page for pagination (1-100)
Parámetros de salida
dataobject[]ObligatorioList of active digital greeting cards
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioPagination metadata
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Active ProductsGOODY_LIST_ALL_ACTIVE_PRODUCTSAcciónTool to list all active products. Use when you need to fetch available active products with pagination and filters.
GOODY_LIST_ALL_ACTIVE_PRODUCTSAcciónTool to list all active products. Use when you need to fetch available active products with pagination and filters.
Parámetros de entrada
pageintegerPage index for pagination, starting from 1
per_pageintegerNumber of items per page, range 1-100
country_codestringFilter products by shipping country, ISO country code
use_custom_catalogbooleanLimit to custom catalog only (approved partners)
custom_catalog_show_inactivebooleanShow inactive products in custom catalog (Commerce API custom catalogs only)
Parámetros de salida
dataobject[]ObligatorioList of active products on this page
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioPagination metadata
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Order BatchesGOODY_LIST_ALL_ORDER_BATCHESAcciónTool to list all order batches. Use when you need to paginate through your account's order batches.
GOODY_LIST_ALL_ORDER_BATCHESAcciónTool to list all order batches. Use when you need to paginate through your account's order batches.
Parámetros de entrada
pageintegerPage number for pagination, starting at 1
per_pageintegerNumber of items per page, between 1 and 100
Parámetros de salida
dataobject[]ObligatorioList of order batches
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioPagination metadata
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All OrdersGOODY_LIST_ALL_ORDERSAcciónTool to retrieve a list of all orders. Use when you need to fetch paginated order data associated with the account after authenticating.
GOODY_LIST_ALL_ORDERSAcciónTool to retrieve a list of all orders. Use when you need to fetch paginated order data associated with the account after authenticating.
Parámetros de entrada
pageintegerPage number for pagination (must be >= 1).
per_pageintegerNumber of orders to return per page (1-100).
Parámetros de salida
dataobject[]ObligatorioArray of orders returned on this page.
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioPagination metadata.
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Payment MethodsGOODY_LIST_ALL_PAYMENT_METHODSAcciónTool to list all payment methods. Use when you need to retrieve all payment methods associated with the account.
GOODY_LIST_ALL_PAYMENT_METHODSAcciónTool to list all payment methods. Use when you need to retrieve all payment methods associated with the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of payment methods returned
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioMetadata for pagination lists
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All WorkspacesGOODY_LIST_ALL_WORKSPACESAcciónTool to list all workspaces. Use when you need to retrieve all workspaces associated with the account.
GOODY_LIST_ALL_WORKSPACESAcciónTool to list all workspaces. Use when you need to retrieve all workspaces associated with the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of workspace objects
errorstringError if any occurred during the execution of the action
list_metaobjectObligatorioMetadata about the list of workspaces
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Current UserGOODY_RETRIEVE_CURRENT_USERAcciónTool to retrieve current authenticated user information. Use after authentication to fetch the current user’s account details.
GOODY_RETRIEVE_CURRENT_USERAcciónTool to retrieve current authenticated user information. Use after authentication to fetch the current user’s account details.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve ProductGOODY_RETRIEVE_PRODUCTAcciónTool to retrieve details of a specific product by its ID. Use after obtaining the product ID.
GOODY_RETRIEVE_PRODUCTAcciónTool to retrieve details of a specific product by its ID. Use after obtaining the product ID.
Parámetros de entrada
idstringObligatorioUnique ID of the product
use_custom_catalogbooleanLimit to custom catalog only (approved API partners)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not