---
canonical_url: "https://docs.composio.dev/toolkits/gelato"
markdown_url: "https://docs.composio.dev/toolkits/gelato.md"
product: "platform"
version: null
last_updated: null
---

# Gelato

Gelato is a print-on-demand platform for creating and managing orders, browsing printable products and prices, checking stock, and finding shipment methods.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `GELATO`
- **Version:** 00000000_00

## Tools

### Cancel Order

**Slug:** `GELATO_CANCEL_ORDER`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Gelato UUID-like ID of the regular order to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Stock Availability

**Slug:** `GELATO_CHECK_STOCK_AVAILABILITY`

Check 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_uids` | array | Yes | Unique Gelato product UIDs to check (1-250). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Draft Order

**Slug:** `GELATO_CREATE_DRAFT_ORDER`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `GELATO_CREATE_ORDER`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Draft Order

**Slug:** `GELATO_DELETE_DRAFT_ORDER`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Gelato UUID-like ID of the confirmed draft to permanently delete. This operation cannot delete a regular production order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Catalogs

**Slug:** `GELATO_GET_CATALOGS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | List mode only: maximum catalogs to return in this page (1-100). |
| `offset` | integer | No | List mode only: zero-based offset. Pass `next_offset` from the previous response to continue. |
| `catalog_uid` | string | No | When supplied, return this catalog's full attribute definitions instead of listing catalogs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `GELATO_GET_ORDER`

Retrieve the full current state, financial status, fulfillment status, shipment tracking, items, and totals of one Gelato order by its Gelato order ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Gelato's UUID-like order ID returned by Create Order or Search Orders, not the caller's order reference ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `GELATO_GET_PRODUCT`

Retrieve one Gelato product's attributes, dimensions, weight, supported countries, printability, stockability, content areas, and valid page counts by product UID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_uid` | string | Yes | Exact Gelato product UID returned by Search Products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Prices

**Slug:** `GELATO_GET_PRODUCT_PRICES`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Optional two-letter uppercase destination country code. |
| `currency` | string | No | Optional uppercase ISO 4217 currency for returned prices. |
| `page_count` | integer | No | Total page count for a multipage product, including covers. |
| `product_uid` | string | Yes | Exact Gelato product UID whose quantity price tiers to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Quote Order

**Slug:** `GELATO_QUOTE_ORDER`

Quote 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Orders

**Slug:** `GELATO_SEARCH_ORDERS`

Search Gelato orders with status, reference, date, country, currency, channel, type, store, or free-text filters and return one offset-controlled page.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Products

**Slug:** `GELATO_SEARCH_PRODUCTS`

Search 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Draft Order

**Slug:** `GELATO_SUBMIT_DRAFT_ORDER`

Convert 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | No | Complete set of existing items to retain. Supplying this array removes every existing item not represented; omit it to keep all items unchanged. |
| `order_id` | string | Yes | Gelato ID of an order whose current order type is draft. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |