Skip to main content
Server path: /gist-ecommerce | Type: Application | PCID required: Yes

Tools

ToolDescription
gist_ecommerce_create_categoryCreate a product category
gist_ecommerce_create_customerCreate an e-commerce customer
gist_ecommerce_create_or_update_cartCreate or update a customer’s cart
gist_ecommerce_create_orderCreate an e-commerce order
gist_ecommerce_create_productCreate an e-commerce product
gist_ecommerce_create_product_variantCreate a product variant
gist_ecommerce_create_storeCreate an e-commerce store
gist_ecommerce_delete_cartDelete a customer’s cart
gist_ecommerce_get_categoryRetrieve a product category
gist_ecommerce_get_customerRetrieve an e-commerce customer
gist_ecommerce_get_productRetrieve an e-commerce product
gist_ecommerce_get_product_variantRetrieve a product variant
gist_ecommerce_get_storeRetrieve an e-commerce store
gist_ecommerce_list_storesList all e-commerce stores
gist_ecommerce_update_categoryUpdate a product category
gist_ecommerce_update_customerUpdate an e-commerce customer
gist_ecommerce_update_orderUpdate an e-commerce order
gist_ecommerce_update_productUpdate an e-commerce product
gist_ecommerce_update_product_variantUpdate a product variant
gist_ecommerce_update_storeUpdate an e-commerce store

gist_ecommerce_create_category

Create a product category Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
category_idstringYesCategory ID
namestringYesCategory name

gist_ecommerce_create_customer

Create an e-commerce customer Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
billing_addressobjectNoBilling address
customer_idstringYesCustomer ID
email_addressstringYesCustomer email
first_namestringNoFirst name
last_namestringNoLast name
shipping_addressobjectNoShipping address

gist_ecommerce_create_or_update_cart

Create or update a customer’s cart Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
customer_idstringYesCustomer ID
checkout_urlstringNoCheckout URL (required for abandoned cart automations)
created_atstringNoCreation timestamp (ISO 8601)
currency_codestringYesCurrency code (ISO 4217)
discount_totalnumberNoDiscount total
line_itemsobject[]YesCart line items
order_totalnumberYesOrder total
updated_atstringNoUpdate timestamp (ISO 8601)

gist_ecommerce_create_order

Create an e-commerce order Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
billing_addressobjectNoBilling Address
cart_idstringNoCart Id
currency_codestringYesCurrency code (ISO 4217)
customer_idstringYesCustomer ID
discount_totalnumberNoDiscount Total
financial_statusstringNoFinancial Status
fulfillment_statusstringNoFulfillment Status
line_itemsobject[]YesLine Items
order_idstringYesOrder ID
order_totalnumberYesOrder total
order_urlstringNoOrder Url
processed_atstringYesProcessing timestamp (ISO 8601)
shipping_addressobjectNoShipping Address
shipping_totalnumberNoShipping Total
tax_totalnumberNoTax Total
tracking_carrierstringNoTracking Carrier
tracking_numberstringNoTracking Number
tracking_urlstringNoTracking Url

gist_ecommerce_create_product

Create an e-commerce product Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
backordersstringNoBackorders setting
categoriesobject[]NoProduct categories
descriptionstringNoProduct description
image_urlstringNoImage URL
inventory_quantityintegerNoInventory quantity
pricestringNoThe price value
product_idstringYesProduct ID
product_published_atstringNoPublication timestamp
product_urlstringNoProduct URL
skustringNoThe sku value
titlestringYesProduct title
vendorstringNoVendor name

gist_ecommerce_create_product_variant

Create a product variant Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
product_idstringYesProduct ID
backordersstringNoThe backorders value
descriptionstringNoThe description value
image_urlstringNoImage Url
inventory_quantityintegerNoInventory Quantity
pricestringNoThe price value
product_urlstringNoProduct Url
product_variant_idstringYesVariant ID
skustringNoThe sku value
titlestringYesVariant title
vendorstringNoThe vendor value

gist_ecommerce_create_store

Create an e-commerce store Parameters:
ParameterTypeRequiredDefaultDescription
abandon_cart_intervalnumberYesAbandoned cart interval in hours
contact_tagsstringNoComma-separated tag names
currency_codestringYesCurrency code (ISO 4217)
domainstringYesStore domain
namestringYesStore name
statusstringNoStore status

gist_ecommerce_delete_cart

Delete a customer’s cart Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
customer_idstringYesCustomer ID

gist_ecommerce_get_category

Retrieve a product category Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
category_idstringYesCategory ID

gist_ecommerce_get_customer

Retrieve an e-commerce customer Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
customer_idstringYesCustomer ID

gist_ecommerce_get_product

Retrieve an e-commerce product Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
product_idstringYesProduct ID

gist_ecommerce_get_product_variant

Retrieve a product variant Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
product_idstringYesProduct ID
variant_idstringYesVariant ID

gist_ecommerce_get_store

Retrieve an e-commerce store Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID

gist_ecommerce_list_stores

List all e-commerce stores

gist_ecommerce_update_category

Update a product category Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
category_idstringYesCategory ID
namestringNoCategory name

gist_ecommerce_update_customer

Update an e-commerce customer Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
customer_idstringYesCustomer ID
billing_addressobjectNoBilling Address
email_addressstringNoEmail Address
first_namestringNoFirst Name
last_namestringNoLast Name
shipping_addressobjectNoShipping Address

gist_ecommerce_update_order

Update an e-commerce order Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
order_idstringYesOrder ID
billing_addressobjectNoBilling Address
cart_idstringNoCart Id
currency_codestringNoCurrency Code
discount_totalnumberNoDiscount Total
financial_statusstringNoFinancial Status
fulfillment_statusstringNoFulfillment Status
line_itemsobject[]NoLine Items
order_totalnumberNoOrder Total
order_urlstringNoOrder Url
shipping_addressobjectNoShipping Address
shipping_totalnumberNoShipping Total
tax_totalnumberNoTax Total
tracking_carrierstringNoTracking Carrier
tracking_numberstringNoTracking Number
tracking_urlstringNoTracking Url

gist_ecommerce_update_product

Update an e-commerce product Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
product_idstringYesProduct ID
backordersstringNoThe backorders value
categoriesobject[]NoThe categories value
descriptionstringNoThe description value
image_urlstringNoImage Url
inventory_quantityintegerNoInventory Quantity
pricestringNoThe price value
product_published_atstringNoProduct Published At
product_urlstringNoProduct Url
skustringNoThe sku value
titlestringNoThe title value
vendorstringNoThe vendor value

gist_ecommerce_update_product_variant

Update a product variant Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
product_idstringYesProduct ID
variant_idstringYesVariant ID
backordersstringNoThe backorders value
descriptionstringNoThe description value
image_urlstringNoImage Url
inventory_quantityintegerNoInventory Quantity
pricestringNoThe price value
product_urlstringNoProduct Url
skustringNoThe sku value
titlestringNoThe title value
vendorstringNoThe vendor value

gist_ecommerce_update_store

Update an e-commerce store Parameters:
ParameterTypeRequiredDefaultDescription
store_idstringYesStore ID
abandon_cart_intervalnumberNoAbandon Cart Interval
contact_tagsstringNoContact Tags
currency_codestringNoCurrency code
domainstringNoStore domain
namestringNoStore name
statusstringNoThe status value