/gist-ecommerce | Type: Application | PCID required: Yes
Tools
gist_ecommerce_create_category
Create a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
category_id | string | Yes | — | Category ID |
name | string | Yes | — | Category name |
gist_ecommerce_create_customer
Create an e-commerce customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
billing_address | object | No | — | Billing address |
customer_id | string | Yes | — | Customer ID |
email_address | string | Yes | — | Customer email |
first_name | string | No | — | First name |
last_name | string | No | — | Last name |
shipping_address | object | No | — | Shipping address |
gist_ecommerce_create_or_update_cart
Create or update a customer’s cart Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
customer_id | string | Yes | — | Customer ID |
checkout_url | string | No | — | Checkout URL (required for abandoned cart automations) |
created_at | string | No | — | Creation timestamp (ISO 8601) |
currency_code | string | Yes | — | Currency code (ISO 4217) |
discount_total | number | No | — | Discount total |
line_items | object[] | Yes | — | Cart line items |
order_total | number | Yes | — | Order total |
updated_at | string | No | — | Update timestamp (ISO 8601) |
gist_ecommerce_create_order
Create an e-commerce order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
billing_address | object | No | — | Billing Address |
cart_id | string | No | — | Cart Id |
currency_code | string | Yes | — | Currency code (ISO 4217) |
customer_id | string | Yes | — | Customer ID |
discount_total | number | No | — | Discount Total |
financial_status | string | No | — | Financial Status |
fulfillment_status | string | No | — | Fulfillment Status |
line_items | object[] | Yes | — | Line Items |
order_id | string | Yes | — | Order ID |
order_total | number | Yes | — | Order total |
order_url | string | No | — | Order Url |
processed_at | string | Yes | — | Processing timestamp (ISO 8601) |
shipping_address | object | No | — | Shipping Address |
shipping_total | number | No | — | Shipping Total |
tax_total | number | No | — | Tax Total |
tracking_carrier | string | No | — | Tracking Carrier |
tracking_number | string | No | — | Tracking Number |
tracking_url | string | No | — | Tracking Url |
gist_ecommerce_create_product
Create an e-commerce product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
backorders | string | No | — | Backorders setting |
categories | object[] | No | — | Product categories |
description | string | No | — | Product description |
image_url | string | No | — | Image URL |
inventory_quantity | integer | No | — | Inventory quantity |
price | string | No | — | The price value |
product_id | string | Yes | — | Product ID |
product_published_at | string | No | — | Publication timestamp |
product_url | string | No | — | Product URL |
sku | string | No | — | The sku value |
title | string | Yes | — | Product title |
vendor | string | No | — | Vendor name |
gist_ecommerce_create_product_variant
Create a product variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
product_id | string | Yes | — | Product ID |
backorders | string | No | — | The backorders value |
description | string | No | — | The description value |
image_url | string | No | — | Image Url |
inventory_quantity | integer | No | — | Inventory Quantity |
price | string | No | — | The price value |
product_url | string | No | — | Product Url |
product_variant_id | string | Yes | — | Variant ID |
sku | string | No | — | The sku value |
title | string | Yes | — | Variant title |
vendor | string | No | — | The vendor value |
gist_ecommerce_create_store
Create an e-commerce store Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
abandon_cart_interval | number | Yes | — | Abandoned cart interval in hours |
contact_tags | string | No | — | Comma-separated tag names |
currency_code | string | Yes | — | Currency code (ISO 4217) |
domain | string | Yes | — | Store domain |
name | string | Yes | — | Store name |
status | string | No | — | Store status |
gist_ecommerce_delete_cart
Delete a customer’s cart Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
customer_id | string | Yes | — | Customer ID |
gist_ecommerce_get_category
Retrieve a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
category_id | string | Yes | — | Category ID |
gist_ecommerce_get_customer
Retrieve an e-commerce customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
customer_id | string | Yes | — | Customer ID |
gist_ecommerce_get_product
Retrieve an e-commerce product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
product_id | string | Yes | — | Product ID |
gist_ecommerce_get_product_variant
Retrieve a product variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
product_id | string | Yes | — | Product ID |
variant_id | string | Yes | — | Variant ID |
gist_ecommerce_get_store
Retrieve an e-commerce store Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
gist_ecommerce_list_stores
List all e-commerce storesgist_ecommerce_update_category
Update a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
category_id | string | Yes | — | Category ID |
name | string | No | — | Category name |
gist_ecommerce_update_customer
Update an e-commerce customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
customer_id | string | Yes | — | Customer ID |
billing_address | object | No | — | Billing Address |
email_address | string | No | — | Email Address |
first_name | string | No | — | First Name |
last_name | string | No | — | Last Name |
shipping_address | object | No | — | Shipping Address |
gist_ecommerce_update_order
Update an e-commerce order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
order_id | string | Yes | — | Order ID |
billing_address | object | No | — | Billing Address |
cart_id | string | No | — | Cart Id |
currency_code | string | No | — | Currency Code |
discount_total | number | No | — | Discount Total |
financial_status | string | No | — | Financial Status |
fulfillment_status | string | No | — | Fulfillment Status |
line_items | object[] | No | — | Line Items |
order_total | number | No | — | Order Total |
order_url | string | No | — | Order Url |
shipping_address | object | No | — | Shipping Address |
shipping_total | number | No | — | Shipping Total |
tax_total | number | No | — | Tax Total |
tracking_carrier | string | No | — | Tracking Carrier |
tracking_number | string | No | — | Tracking Number |
tracking_url | string | No | — | Tracking Url |
gist_ecommerce_update_product
Update an e-commerce product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
product_id | string | Yes | — | Product ID |
backorders | string | No | — | The backorders value |
categories | object[] | No | — | The categories value |
description | string | No | — | The description value |
image_url | string | No | — | Image Url |
inventory_quantity | integer | No | — | Inventory Quantity |
price | string | No | — | The price value |
product_published_at | string | No | — | Product Published At |
product_url | string | No | — | Product Url |
sku | string | No | — | The sku value |
title | string | No | — | The title value |
vendor | string | No | — | The vendor value |
gist_ecommerce_update_product_variant
Update a product variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
product_id | string | Yes | — | Product ID |
variant_id | string | Yes | — | Variant ID |
backorders | string | No | — | The backorders value |
description | string | No | — | The description value |
image_url | string | No | — | Image Url |
inventory_quantity | integer | No | — | Inventory Quantity |
price | string | No | — | The price value |
product_url | string | No | — | Product Url |
sku | string | No | — | The sku value |
title | string | No | — | The title value |
vendor | string | No | — | The vendor value |
gist_ecommerce_update_store
Update an e-commerce store Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store ID |
abandon_cart_interval | number | No | — | Abandon Cart Interval |
contact_tags | string | No | — | Contact Tags |
currency_code | string | No | — | Currency code |
domain | string | No | — | Store domain |
name | string | No | — | Store name |
status | string | No | — | The status value |

