Skip to main content
Gelato logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: GELATO
  • Version: 20261030_00

Tools

Slug: GELATO_CANCEL_ORDERCancel a regular Gelato order before production advances too far. DESTRUCTIVE: cancellation is an irreversible lifecycle change and may fail with conflict once the order is printed or shipped. Confirm the target order and do not retry blindly.

Input Parameters

string
required
Gelato UUID-like ID of the regular order to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_CHECK_STOCK_AVAILABILITYCheck current regional stock status for 1 to 250 Gelato product UIDs. Availability is volatile; call near quote or order time and do not treat an earlier result as a reservation.

Input Parameters

array
required
Unique Gelato product UIDs to check (1-250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_CREATE_DRAFT_ORDERCreate a Gelato draft for review or later submission without entering production. Use a unique order_reference_id; delete the draft when it is no longer needed.

Input Parameters

array
required
One or more line items with unique item_reference_id values and print files where required.
string
required
Uppercase ISO 4217 currency in which the order is charged.
array
Up to 20 key-value metadata entries.
object
Optional sender return-address override.
object
required
Recipient shipping address used for fulfillment, taxes, and delivery.
string
required
Caller-owned unique internal order ID. Reusing it can collide with an existing order or duplicate intent.
string
Preferred method UID from Quote Order, or a supported selector such as normal, standard, or express. If omitted, Gelato chooses the cheapest available method.
string
required
Caller-owned customer reference for this order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_CREATE_ORDERCreate a production order that can immediately enter fulfillment and charge the connected account. IRREVERSIBLE: call only after explicit purchase authorization, use a unique order_reference_id, and never retry an ambiguous result.

Input Parameters

array
required
One or more line items with unique item_reference_id values and print files where required.
string
required
Uppercase ISO 4217 currency in which the order is charged.
array
Up to 20 key-value metadata entries.
object
Optional sender return-address override.
object
required
Recipient shipping address used for fulfillment, taxes, and delivery.
string
required
Caller-owned unique internal order ID. Reusing it can collide with an existing order or duplicate intent.
string
Preferred method UID from Quote Order, or a supported selector such as normal, standard, or express. If omitted, Gelato chooses the cheapest available method.
string
required
Caller-owned customer reference for this order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_DELETE_DRAFT_ORDERPermanently delete a Gelato draft. DESTRUCTIVE: only use for a confirmed draft, preferably one created by the same workflow; this cannot delete a regular production order and success was not live-exercised.

Input Parameters

string
required
Gelato UUID-like ID of the confirmed draft to permanently delete. This operation cannot delete a regular production order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_GET_CATALOGSList available Gelato product catalogs, or provide catalog_uid to retrieve one catalog’s full product-attribute definitions and allowed values. Use detail mode before constructing attribute filters.

Input Parameters

integer
List mode only: maximum catalogs to return in this page (1-100).
integer
List mode only: zero-based offset. Pass next_offset from the previous response to continue.
string
When supplied, return this catalog’s full attribute definitions instead of listing catalogs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_GET_ORDERRetrieve the full current state, financial status, fulfillment status, shipment tracking, items, and totals of one Gelato order by its Gelato order ID.

Input Parameters

string
required
Gelato’s UUID-like order ID returned by Create Order or Search Orders, not the caller’s order reference ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_GET_PRODUCTRetrieve one Gelato product’s attributes, dimensions, weight, supported countries, printability, stockability, content areas, and valid page counts by product UID.

Input Parameters

string
required
Exact Gelato product UID returned by Search Products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_GET_PRODUCT_PRICESReturn Gelato’s quantity price tiers for one product, optionally localized by destination country, currency, and multipage page count. These catalog prices do not replace Quote Order for actual shipment options and final order cost.

Input Parameters

string
Optional two-letter uppercase destination country code.
string
Optional uppercase ISO 4217 currency for returned prices.
integer
Total page count for a multipage product, including covers.
string
required
Exact Gelato product UID whose quantity price tiers to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_QUOTE_ORDERQuote product and shipping costs and delivery estimates for a destination before creating an order. This does not place or charge an order, but submitted print-file URLs are sent to Gelato for quote validation.

Input Parameters

string
required
Uppercase ISO 4217 charge currency.
array
required
Products to quote. Item references must be unique; include files for printable products.
object
required
Destination recipient and address used for fulfillment and delivery options. Use local-language address text for CN, JP, KR, and RU.
string
required
Caller-owned unique reference for the prospective order.
boolean
Allow separate quotes from multiple fulfillment facilities. False requests one aggregate quote when possible.
string
required
Caller-owned customer reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_SEARCH_ORDERSSearch Gelato orders with status, reference, date, country, currency, channel, type, store, or free-text filters and return one offset-controlled page.

Input Parameters

array
Gelato order IDs to match.
integer
Maximum orders in this page (1-100).
integer
Zero-based result offset. Pass next_offset from the previous response to continue.
Free-text search across Gelato order summary fields.
array
Order channels to include, for example api.
string
Inclusive ISO 8601 upper date and time bound.
array
Destination two-letter ISO 3166-1 country codes to include.
array
Gelato store IDs to include.
array
Uppercase ISO 4217 currencies to include.
string
Inclusive ISO 8601 lower date and time bound.
array
Order types to include: regular orders, drafts, or both.
array
Gelato financial statuses to include.
string
Single caller-owned order reference to match.
array
Caller-owned order references to match.
array
Gelato fulfillment statuses to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_SEARCH_PRODUCTSSearch printable products in a Gelato catalog by catalog attribute values and return one offset-controlled page. Facet hit maps are omitted by default because they are extremely large; request them only when needed for filter discovery.

Input Parameters

integer
Maximum products in this page (1-100).
integer
Zero-based result offset. Pass next_offset from the previous response to continue.
string
required
Catalog UID from Get Catalogs whose products to search.
boolean
Include Gelato’s potentially huge facet-count maps in the response. This option is not sent to Gelato.
object
Map each product attribute UID to accepted product attribute value UIDs. Obtain exact keys and values from Get Catalogs detail mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GELATO_SUBMIT_DRAFT_ORDERConvert an existing draft into a regular production order. CRITICAL: this is an irreversible, potentially payable transition that can start production. If items are supplied, every omitted existing item is removed; include ID-only entries for items that must remain unchanged. Never retry blindly.

Input Parameters

array
Complete set of existing items to retain. Supplying this array removes every existing item not represented; omit it to keep all items unchanged.
string
required
Gelato ID of an order whose current order type is draft.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not