Gelato
App · 17 actions
Gelato Order v4, product catalogs, quotes, stock and shipping.
Actions
| Action | What it does |
|---|---|
| Cancel order | Cancel order. |
| Create order | Create order. |
| Delete draft order | Delete draft order. |
| Get catalog | Get catalog. |
| Get order | Get order. |
| Get product | Get product. |
| Get product prices | Get product prices. |
| Get shipping address | Get shipping address. |
| Get stock availability | Get stock availability. |
| Get template | Get template. |
| List catalogs | List catalogs. |
| List shipment methods | List shipment methods. |
| List store products | List store products. |
| Quote order | Quote order. |
| Search orders | Search orders. |
| Update order | Update order. |
| Update shipping address | Update shipping address. |
Cancel order
Cancel order.
Inputs
- Order id
order_idtextRequired - Order id.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Create order
Create order.
Inputs
- Order type
order_typetextRequired - Order type.One of:
draft,order. - Order reference id
order_reference_idtextRequired - Order reference id.
- Customer reference id
customer_reference_idtextRequired - Customer reference id.
- Currency
currencytextRequired - Three-letter currency code, such as USD or EUR.
- Items
itemslistRequired - Items.
- Shipment method uid
shipment_method_uidtext - Shipment method uid.
- Shipping address
shipping_addressobjectRequired - Shipping address.
Outputs
dataobject- Api result.
Example output
{
"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_idtextRequired - Order id.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Get catalog
Get catalog.
Inputs
- Catalog uid
catalog_uidtextRequired - Catalog uid.
Outputs
dataobject- Api result.
Example output
{
"data": {
"catalogUid": "example",
"productAttributes": [],
"title": "example"
}
}Get order
Get order.
Inputs
- Order id
order_idtextRequired - Order id.
Outputs
dataobject- Api result.
Example output
{
"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_uidtextRequired - Product uid.
Outputs
dataobject- Api result.
Example output
{
"data": {
"productAttributes": {},
"productUid": "example"
}
}Get product prices
Get product prices.
Inputs
- Product uid
product_uidtextRequired - Product uid.
- Country
countrytext - 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
currencytext - Three-letter currency code, such as USD or EUR.
Outputs
datalist- Api result.
Example output
{
"data": []
}Get shipping address
Get shipping address.
Inputs
- Order id
order_idtextRequired - Order id.
Outputs
dataobject- Api result.
Example output
{
"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
productslistRequired - Products.
Outputs
dataobject- Api result.
Example output
{
"data": {
"productsAvailability": []
}
}Get template
Get template.
Inputs
- Template id
template_idtextRequired - Template id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"description": "example",
"id": "example",
"products": [],
"templateName": "example",
"title": "example"
}
}List catalogs
List catalogs.
Inputs
None.
Outputs
datalist- Api result.
Example output
{
"data": []
}List shipment methods
List shipment methods.
Inputs
- Country
countrytext - 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
dataobject- Api result.
Example output
{
"data": {
"shipmentMethods": []
}
}List store products
List store products.
Inputs
- Store id
store_idtextRequired - Store id.
- Order
ordertext - Order.One of:
asc,desc. - Order by
order_bytext - Order by.One of:
createdAt,updatedAt. - Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
Outputs
dataobject- Api result.
Example output
{
"data": {
"products": []
}
}Quote order
Quote order.
Inputs
- Order reference id
order_reference_idtextRequired - Order reference id.
- Customer reference id
customer_reference_idtextRequired - Customer reference id.
- Currency
currencytextRequired - Three-letter currency code, such as USD or EUR.
- Recipient
recipientobjectRequired - Recipient.
- Products
productslistRequired - Products.
- Allow multiple quotes
allow_multiple_quotestrue/false - Allow multiple quotes.
Outputs
dataobject- Api result.
Example output
{
"data": {
"quotes": []
}
}Search orders
Search orders.
Inputs
- Ids
idslist - Ids.
- Order reference ids
order_reference_idslist - Order reference ids.
- Financial statuses
financial_statuseslist - Financial statuses.One or more of:
draft,pending,invoiced,to_be_invoiced(To be invoiced),paid,canceled,partially_refunded(Partially refunded),refunded,refused. - Offset
offsetnumber - How many orders to skip. Defaults to zero.At least 0.
- Page size
limitnumber - How many orders to return, from 1 to 100. Defaults to 50.From 1 to 100.
- Order reference
order_reference_idtext - Only this order reference from your own system.
- Fulfillment statuses
fulfillment_statuseslist - 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
channelslist - Only orders from one of these channels.One or more of:
ui,api,shopify,etsy. - Search
searchtext - Match the recipient name or order reference.
Outputs
dataobject- Api result.
Example output
{
"data": {
"orders": []
}
}Update order
Update order.
Inputs
- Order id
order_idtextRequired - Order id.
- Order type
order_typetext - Order type.One of:
draft,order. - Order reference id
order_reference_idtext - Order reference id.
- Customer reference id
customer_reference_idtext - Customer reference id.
- Currency
currencytext - Three-letter currency code, such as USD or EUR.
- Items
itemslist - Items.
- Shipment method uid
shipment_method_uidtext - Shipment method uid.
- Shipping address
shipping_addressobject - Shipping address.
Outputs
dataobject- Api result.
Example output
{
"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_idtextRequired - Order id.
- Country
countrytext - 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
companyNametext - Company Name.
- First Name
firstNametext - First Name.
- Last Name
lastNametext - Last Name.
- Address Line1
addressLine1text - Address Line1.
- Address Line2
addressLine2text - Address Line2.
- State
statetext - State.
- City
citytext - City.
- Post Code
postCodetext - Post Code.
- Email
emailtext - Email.
- Phone
phonetext - Phone.
Outputs
dataobject- Api result.
Example output
{
"data": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"companyName": "example",
"country": "example",
"email": "example",
"firstName": "example",
"lastName": "example",
"phone": "example",
"postCode": "example",
"state": "example"
}
}