# Gelato

> Gelato Order v4, product catalogs, quotes, stock and shipping.

App · 17 actions. Web page: https://docs.lodol.com/docs/integrations/gelato

## Actions

### Cancel order

Cancel order.

**Inputs**

- Order id (`order_id`, text, required): Order id.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {}
}
```

### Create order

Create order.

**Inputs**

- Order type (`order_type`, text, required): Order type. One of: `draft`, `order`.
- Order reference id (`order_reference_id`, text, required): Order reference id.
- Customer reference id (`customer_reference_id`, text, required): Customer reference id.
- Currency (`currency`, text, required): Three-letter currency code, such as USD or EUR.
- Items (`items`, list, required): Items.
- Shipment method uid (`shipment_method_uid`, text): Shipment method uid.
- Shipping address (`shipping_address`, object, required): Shipping address.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "currency": "example",
    "customerReferenceId": "example",
    "financialStatus": "example",
    "fulfillmentStatus": "example",
    "id": "example",
    "items": [],
    "orderReferenceId": "example",
    "orderType": "example",
    "updatedAt": "example"
  }
}
```

### Delete draft order

Delete draft order.

**Inputs**

- Order id (`order_id`, text, required): Order id.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {}
}
```

### Get catalog

Get catalog.

**Inputs**

- Catalog uid (`catalog_uid`, text, required): Catalog uid.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "catalogUid": "example",
    "productAttributes": [],
    "title": "example"
  }
}
```

### Get order

Get order.

**Inputs**

- Order id (`order_id`, text, required): Order id.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "currency": "example",
    "customerReferenceId": "example",
    "financialStatus": "example",
    "fulfillmentStatus": "example",
    "id": "example",
    "items": [],
    "orderReferenceId": "example",
    "orderType": "example",
    "updatedAt": "example"
  }
}
```

### Get product

Get product.

**Inputs**

- Product uid (`product_uid`, text, required): Product uid.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "productAttributes": {},
    "productUid": "example"
  }
}
```

### Get product prices

Get product prices.

**Inputs**

- Product uid (`product_uid`, text, required): Product uid.
- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- Currency (`currency`, text): Three-letter currency code, such as USD or EUR.

**Outputs**

- `data` (list): Api result.

**Example output**

```json
{
  "data": []
}
```

### Get shipping address

Get shipping address.

**Inputs**

- Order id (`order_id`, text, required): Order id.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "addressLine1": "example",
    "addressLine2": "example",
    "city": "example",
    "companyName": "example",
    "country": "example",
    "email": "example",
    "firstName": "example",
    "lastName": "example",
    "phone": "example",
    "postCode": "example",
    "state": "example"
  }
}
```

### Get stock availability

Get stock availability.

**Inputs**

- Products (`products`, list, required): Products.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "productsAvailability": []
  }
}
```

### Get template

Get template.

**Inputs**

- Template id (`template_id`, text, required): Template id.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "description": "example",
    "id": "example",
    "products": [],
    "templateName": "example",
    "title": "example"
  }
}
```

### List catalogs

List catalogs.

**Inputs**: None.

**Outputs**

- `data` (list): Api result.

**Example output**

```json
{
  "data": []
}
```

### List shipment methods

List shipment methods.

**Inputs**

- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "shipmentMethods": []
  }
}
```

### List store products

List store products.

**Inputs**

- Store id (`store_id`, text, required): Store id.
- Order (`order`, text): Order. One of: `asc`, `desc`.
- Order by (`order_by`, text): Order by. One of: `createdAt`, `updatedAt`.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. From 1 to 100.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "products": []
  }
}
```

### Quote order

Quote order.

**Inputs**

- Order reference id (`order_reference_id`, text, required): Order reference id.
- Customer reference id (`customer_reference_id`, text, required): Customer reference id.
- Currency (`currency`, text, required): Three-letter currency code, such as USD or EUR.
- Recipient (`recipient`, object, required): Recipient.
- Products (`products`, list, required): Products.
- Allow multiple quotes (`allow_multiple_quotes`, true/false): Allow multiple quotes.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "quotes": []
  }
}
```

### Search orders

Search orders.

**Inputs**

- Ids (`ids`, list): Ids.
- Order reference ids (`order_reference_ids`, list): Order reference ids.
- Financial statuses (`financial_statuses`, list): Financial statuses. One or more of: `draft`, `pending`, `invoiced`, `to_be_invoiced` (To be invoiced), `paid`, `canceled`, `partially_refunded` (Partially refunded), `refunded`, `refused`.
- Offset (`offset`, number): How many orders to skip. Defaults to zero. At least 0.
- Page size (`limit`, number): How many orders to return, from 1 to 100. Defaults to 50. From 1 to 100.
- Order reference (`order_reference_id`, text): Only this order reference from your own system.
- Fulfillment statuses (`fulfillment_statuses`, list): Only orders with one of these production statuses. One or more of: `created`, `passed`, `failed`, `canceled`, `printed`, `shipped`, `draft`, `pending_approval` (Pending approval), `not_connected` (Not connected), `on_hold` (On hold).
- Channels (`channels`, list): Only orders from one of these channels. One or more of: `ui`, `api`, `shopify`, `etsy`.
- Search (`search`, text): Match the recipient name or order reference.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "orders": []
  }
}
```

### Update order

Update order.

**Inputs**

- Order id (`order_id`, text, required): Order id.
- Order type (`order_type`, text): Order type. One of: `draft`, `order`.
- Order reference id (`order_reference_id`, text): Order reference id.
- Customer reference id (`customer_reference_id`, text): Customer reference id.
- Currency (`currency`, text): Three-letter currency code, such as USD or EUR.
- Items (`items`, list): Items.
- Shipment method uid (`shipment_method_uid`, text): Shipment method uid.
- Shipping address (`shipping_address`, object): Shipping address.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "currency": "example",
    "customerReferenceId": "example",
    "financialStatus": "example",
    "fulfillmentStatus": "example",
    "id": "example",
    "items": [],
    "orderReferenceId": "example",
    "orderType": "example",
    "updatedAt": "example"
  }
}
```

### Update shipping address

Update shipping address.

**Inputs**

- Order id (`order_id`, text, required): Order id.
- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- Company Name (`companyName`, text): Company Name.
- First Name (`firstName`, text): First Name.
- Last Name (`lastName`, text): Last Name.
- Address Line1 (`addressLine1`, text): Address Line1.
- Address Line2 (`addressLine2`, text): Address Line2.
- State (`state`, text): State.
- City (`city`, text): City.
- Post Code (`postCode`, text): Post Code.
- Email (`email`, text): Email.
- Phone (`phone`, text): Phone.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "addressLine1": "example",
    "addressLine2": "example",
    "city": "example",
    "companyName": "example",
    "country": "example",
    "email": "example",
    "firstName": "example",
    "lastName": "example",
    "phone": "example",
    "postCode": "example",
    "state": "example"
  }
}
```
