Gelato

App · 17 actions

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

Actions

ActionWhat it does
Cancel orderCancel order.
Create orderCreate order.
Delete draft orderDelete draft order.
Get catalogGet catalog.
Get orderGet order.
Get productGet product.
Get product pricesGet product prices.
Get shipping addressGet shipping address.
Get stock availabilityGet stock availability.
Get templateGet template.
List catalogsList catalogs.
List shipment methodsList shipment methods.
List store productsList store products.
Quote orderQuote order.
Search ordersSearch orders.
Update orderUpdate order.
Update shipping addressUpdate shipping address.

Cancel order

Cancel order.

Inputs

Order idorder_idtextRequired
Order id.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Create order

Create order.

Inputs

Order typeorder_typetextRequired
Order type.One of: draft, order.
Order reference idorder_reference_idtextRequired
Order reference id.
Customer reference idcustomer_reference_idtextRequired
Customer reference id.
CurrencycurrencytextRequired
Three-letter currency code, such as USD or EUR.
ItemsitemslistRequired
Items.
Shipment method uidshipment_method_uidtext
Shipment method uid.
Shipping addressshipping_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 idorder_idtextRequired
Order id.

Outputs

dataobject
Api result.
Example output
{
  "data": {}
}

Get catalog

Get catalog.

Inputs

Catalog uidcatalog_uidtextRequired
Catalog uid.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "catalogUid": "example",
    "productAttributes": [],
    "title": "example"
  }
}

Get order

Get order.

Inputs

Order idorder_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 uidproduct_uidtextRequired
Product uid.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "productAttributes": {},
    "productUid": "example"
  }
}

Get product prices

Get product prices.

Inputs

Product uidproduct_uidtextRequired
Product uid.
Countrycountrytext
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.
Currencycurrencytext
Three-letter currency code, such as USD or EUR.

Outputs

datalist
Api result.
Example output
{
  "data": []
}

Get shipping address

Get shipping address.

Inputs

Order idorder_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

ProductsproductslistRequired
Products.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "productsAvailability": []
  }
}

Get template

Get template.

Inputs

Template idtemplate_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

Countrycountrytext
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 idstore_idtextRequired
Store id.
Orderordertext
Order.One of: asc, desc.
Order byorder_bytext
Order by.One of: createdAt, updatedAt.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.From 1 to 100.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "products": []
  }
}

Quote order

Quote order.

Inputs

Order reference idorder_reference_idtextRequired
Order reference id.
Customer reference idcustomer_reference_idtextRequired
Customer reference id.
CurrencycurrencytextRequired
Three-letter currency code, such as USD or EUR.
RecipientrecipientobjectRequired
Recipient.
ProductsproductslistRequired
Products.
Allow multiple quotesallow_multiple_quotestrue/false
Allow multiple quotes.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "quotes": []
  }
}

Search orders

Search orders.

Inputs

Idsidslist
Ids.
Order reference idsorder_reference_idslist
Order reference ids.
Financial statusesfinancial_statuseslist
Financial statuses.One or more of: draft, pending, invoiced, to_be_invoiced (To be invoiced), paid, canceled, partially_refunded (Partially refunded), refunded, refused.
Offsetoffsetnumber
How many orders to skip. Defaults to zero.At least 0.
Page sizelimitnumber
How many orders to return, from 1 to 100. Defaults to 50.From 1 to 100.
Order referenceorder_reference_idtext
Only this order reference from your own system.
Fulfillment statusesfulfillment_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).
Channelschannelslist
Only orders from one of these channels.One or more of: ui, api, shopify, etsy.
Searchsearchtext
Match the recipient name or order reference.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "orders": []
  }
}

Update order

Update order.

Inputs

Order idorder_idtextRequired
Order id.
Order typeorder_typetext
Order type.One of: draft, order.
Order reference idorder_reference_idtext
Order reference id.
Customer reference idcustomer_reference_idtext
Customer reference id.
Currencycurrencytext
Three-letter currency code, such as USD or EUR.
Itemsitemslist
Items.
Shipment method uidshipment_method_uidtext
Shipment method uid.
Shipping addressshipping_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 idorder_idtextRequired
Order id.
Countrycountrytext
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 NamecompanyNametext
Company Name.
First NamefirstNametext
First Name.
Last NamelastNametext
Last Name.
Address Line1addressLine1text
Address Line1.
Address Line2addressLine2text
Address Line2.
Statestatetext
State.
Citycitytext
City.
Post CodepostCodetext
Post Code.
Emailemailtext
Email.
Phonephonetext
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"
  }
}

On this page