Can I use Shopify as a CLI?

Yes. KosmoKrator exposes a Shopify CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Shopify through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Shopify tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Shopify credentials stored?

Shopify credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Shopify MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Shopify Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Shopify KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.shopify.*. Use lua_read_doc("integrations.shopify") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Shopify workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.shopify.api_get({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("shopify"))' --json
kosmo integrations:lua --eval 'print(docs.read("shopify.api_get"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local shopify = app.integrations.shopify
local result = shopify.api_get({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.shopify, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.shopify.default.* or app.integrations.shopify.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Shopify, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Shopify Lua Reference

Namespace: app.integrations.shopify

Shopify tools use the Admin REST API. Configure access_token and shop_domain; the service sends X-Shopify-Access-Token to https://{shop_domain}/admin/api/{api_version}. base_url is only for proxies or tests.

Most write tools accept a payload object containing the documented Shopify REST request body, including the expected root resource key when Shopify requires one, such as { product = {...} }. Read tools accept common filters plus query for additional documented parameters.

Examples

local products = app.integrations.shopify.list_products({
  limit = 25,
  status = "active",
  query = { fields = "id,title,status" }
})

local product = app.integrations.shopify.create_product({
  payload = {
    product = {
      title = "Example Widget",
      status = "draft"
    }
  }
})

local orders = app.integrations.shopify.list_orders({
  status = "open",
  financial_status = "paid",
  limit = 10
})

local refund_preview = app.integrations.shopify.calculate_order_refund({
  order_id = "1234567890",
  payload = { refund = { shipping = { full_refund = true } } }
})

Coverage Notes

Named tools cover shop metadata, products, product variants/images/metafields, orders, order transactions/refunds/fulfillments/risks/actions, fulfillment orders, customers, addresses, collections, collects, price rules, discount codes, inventory items/levels, fulfillment services, locations, webhooks, themes/assets, pages, blogs/articles, script tags, and shop metafields.
api_get, api_post, api_put, and api_delete can call any Admin REST path such as /products/count.json or /orders/{id}/events.json when a less common endpoint is needed.
Shopify REST responses are returned as decoded JSON exactly as Shopify sends them, usually with a root key such as products, product, orders, or shop.

Multi-Account Usage

app.integrations.shopify.list_products({ limit = 10 })
app.integrations.shopify.default.list_products({ limit = 10 })
app.integrations.shopify.us_store.list_products({ limit = 10 })

Raw agent markdown

# Shopify Lua Reference

Namespace: `app.integrations.shopify`

Shopify tools use the Admin REST API. Configure `access_token` and `shop_domain`; the service sends `X-Shopify-Access-Token` to `https://{shop_domain}/admin/api/{api_version}`. `base_url` is only for proxies or tests.

Most write tools accept a `payload` object containing the documented Shopify REST request body, including the expected root resource key when Shopify requires one, such as `{ product = {...} }`. Read tools accept common filters plus `query` for additional documented parameters.

## Examples

```lua
local products = app.integrations.shopify.list_products({
  limit = 25,
  status = "active",
  query = { fields = "id,title,status" }
})

local product = app.integrations.shopify.create_product({
  payload = {
    product = {
      title = "Example Widget",
      status = "draft"
    }
  }
})

local orders = app.integrations.shopify.list_orders({
  status = "open",
  financial_status = "paid",
  limit = 10
})

local refund_preview = app.integrations.shopify.calculate_order_refund({
  order_id = "1234567890",
  payload = { refund = { shipping = { full_refund = true } } }
})
```

## Coverage Notes

- Named tools cover shop metadata, products, product variants/images/metafields, orders, order transactions/refunds/fulfillments/risks/actions, fulfillment orders, customers, addresses, collections, collects, price rules, discount codes, inventory items/levels, fulfillment services, locations, webhooks, themes/assets, pages, blogs/articles, script tags, and shop metafields.
- `api_get`, `api_post`, `api_put`, and `api_delete` can call any Admin REST path such as `/products/count.json` or `/orders/{id}/events.json` when a less common endpoint is needed.
- Shopify REST responses are returned as decoded JSON exactly as Shopify sends them, usually with a root key such as `products`, `product`, `orders`, or `shop`.

## Multi-Account Usage

```lua
app.integrations.shopify.list_products({ limit = 10 })
app.integrations.shopify.default.list_products({ limit = 10 })
app.integrations.shopify.us_store.list_products({ limit = 10 })
```

Metadata-derived Lua example

local result = app.integrations.shopify.api_get({})
print(result)

Functions

api_get Read

Call any Shopify Admin REST GET endpoint path.

Lua path: app.integrations.shopify.api_get
Full name: shopify.shopify_api_get

Parameter	Type	Required	Description
No parameters.

api_post Write

Call any Shopify Admin REST POST endpoint path.

Lua path: app.integrations.shopify.api_post
Full name: shopify.shopify_api_post

Parameter	Type	Required	Description
No parameters.

api_put Write

Call any Shopify Admin REST PUT endpoint path.

Lua path: app.integrations.shopify.api_put
Full name: shopify.shopify_api_put

Parameter	Type	Required	Description
No parameters.

api_delete Write

Call any Shopify Admin REST DELETE endpoint path.

Lua path: app.integrations.shopify.api_delete
Full name: shopify.shopify_api_delete

Parameter	Type	Required	Description
No parameters.

get Read

Get shop metadata and verify Admin REST access.

Lua path: app.integrations.shopify.get
Full name: shopify.shopify_get_shop

Parameter	Type	Required	Description
No parameters.

get_current_user Read

Compatibility alias for shop metadata.

Lua path: app.integrations.shopify.get_current_user
Full name: shopify.shopify_get_current_user

Parameter	Type	Required	Description
No parameters.

list_products Read

List Shopify Products.

Lua path: app.integrations.shopify.list_products
Full name: shopify.shopify_list_products

Parameter	Type	Required	Description
No parameters.

get_product Read

Get one Shopify Product.

Lua path: app.integrations.shopify.get_product
Full name: shopify.shopify_get_product

Parameter	Type	Required	Description
No parameters.

create_product Write

Create a Shopify Product.

Lua path: app.integrations.shopify.create_product
Full name: shopify.shopify_create_product

Parameter	Type	Required	Description
No parameters.

update_product Write

Update a Shopify Product.

Lua path: app.integrations.shopify.update_product
Full name: shopify.shopify_update_product

Parameter	Type	Required	Description
No parameters.

delete_product Write

Delete a Shopify Product.

Lua path: app.integrations.shopify.delete_product
Full name: shopify.shopify_delete_product

Parameter	Type	Required	Description
No parameters.

list_orders Read

List Shopify Orders.

Lua path: app.integrations.shopify.list_orders
Full name: shopify.shopify_list_orders

Parameter	Type	Required	Description
No parameters.

get_order Read

Get one Shopify Order.

Lua path: app.integrations.shopify.get_order
Full name: shopify.shopify_get_order

Parameter	Type	Required	Description
No parameters.

create_order Write

Create a Shopify Order.

Lua path: app.integrations.shopify.create_order
Full name: shopify.shopify_create_order

Parameter	Type	Required	Description
No parameters.

update_order Write

Update a Shopify Order.

Lua path: app.integrations.shopify.update_order
Full name: shopify.shopify_update_order

Parameter	Type	Required	Description
No parameters.

delete_order Write

Delete a Shopify Order.

Lua path: app.integrations.shopify.delete_order
Full name: shopify.shopify_delete_order

Parameter	Type	Required	Description
No parameters.

list_customers Read

List Shopify Customers.

Lua path: app.integrations.shopify.list_customers
Full name: shopify.shopify_list_customers

Parameter	Type	Required	Description
No parameters.

get_customer Read

Get one Shopify Customer.

Lua path: app.integrations.shopify.get_customer
Full name: shopify.shopify_get_customer

Parameter	Type	Required	Description
No parameters.

create_customer Write

Create a Shopify Customer.

Lua path: app.integrations.shopify.create_customer
Full name: shopify.shopify_create_customer

Parameter	Type	Required	Description
No parameters.

update_customer Write

Update a Shopify Customer.

Lua path: app.integrations.shopify.update_customer
Full name: shopify.shopify_update_customer

Parameter	Type	Required	Description
No parameters.

delete_customer Write

Delete a Shopify Customer.

Lua path: app.integrations.shopify.delete_customer
Full name: shopify.shopify_delete_customer

Parameter	Type	Required	Description
No parameters.

list_custom_collections Read

List Shopify Custom Collections.

Lua path: app.integrations.shopify.list_custom_collections
Full name: shopify.shopify_list_custom_collections

Parameter	Type	Required	Description
No parameters.

get_custom_collection Read

Get one Shopify Custom Collection.

Lua path: app.integrations.shopify.get_custom_collection
Full name: shopify.shopify_get_custom_collection

Parameter	Type	Required	Description
No parameters.

create_custom_collection Write

Create a Shopify Custom Collection.

Lua path: app.integrations.shopify.create_custom_collection
Full name: shopify.shopify_create_custom_collection

Parameter	Type	Required	Description
No parameters.

update_custom_collection Write

Update a Shopify Custom Collection.

Lua path: app.integrations.shopify.update_custom_collection
Full name: shopify.shopify_update_custom_collection

Parameter	Type	Required	Description
No parameters.

delete_custom_collection Write

Delete a Shopify Custom Collection.

Lua path: app.integrations.shopify.delete_custom_collection
Full name: shopify.shopify_delete_custom_collection

Parameter	Type	Required	Description
No parameters.

list_smart_collections Read

List Shopify Smart Collections.

Lua path: app.integrations.shopify.list_smart_collections
Full name: shopify.shopify_list_smart_collections

Parameter	Type	Required	Description
No parameters.

get_smart_collection Read

Get one Shopify Smart Collection.

Lua path: app.integrations.shopify.get_smart_collection
Full name: shopify.shopify_get_smart_collection

Parameter	Type	Required	Description
No parameters.

create_smart_collection Write

Create a Shopify Smart Collection.

Lua path: app.integrations.shopify.create_smart_collection
Full name: shopify.shopify_create_smart_collection

Parameter	Type	Required	Description
No parameters.

update_smart_collection Write

Update a Shopify Smart Collection.

Lua path: app.integrations.shopify.update_smart_collection
Full name: shopify.shopify_update_smart_collection

Parameter	Type	Required	Description
No parameters.

delete_smart_collection Write

Delete a Shopify Smart Collection.

Lua path: app.integrations.shopify.delete_smart_collection
Full name: shopify.shopify_delete_smart_collection

Parameter	Type	Required	Description
No parameters.

list_collects Read

List Shopify Collects.

Lua path: app.integrations.shopify.list_collects
Full name: shopify.shopify_list_collects

Parameter	Type	Required	Description
No parameters.

get_collect Read

Get one Shopify Collect.

Lua path: app.integrations.shopify.get_collect
Full name: shopify.shopify_get_collect

Parameter	Type	Required	Description
No parameters.

create_collect Write

Create a Shopify Collect.

Lua path: app.integrations.shopify.create_collect
Full name: shopify.shopify_create_collect

Parameter	Type	Required	Description
No parameters.

update_collect Write

Update a Shopify Collect.

Lua path: app.integrations.shopify.update_collect
Full name: shopify.shopify_update_collect

Parameter	Type	Required	Description
No parameters.

delete_collect Write

Delete a Shopify Collect.

Lua path: app.integrations.shopify.delete_collect
Full name: shopify.shopify_delete_collect

Parameter	Type	Required	Description
No parameters.

list_price_rules Read

List Shopify Price Rules.

Lua path: app.integrations.shopify.list_price_rules
Full name: shopify.shopify_list_price_rules

Parameter	Type	Required	Description
No parameters.

get_price_rule Read

Get one Shopify Price Rule.

Lua path: app.integrations.shopify.get_price_rule
Full name: shopify.shopify_get_price_rule

Parameter	Type	Required	Description
No parameters.

create_price_rule Write

Create a Shopify Price Rule.

Lua path: app.integrations.shopify.create_price_rule
Full name: shopify.shopify_create_price_rule

Parameter	Type	Required	Description
No parameters.

update_price_rule Write

Update a Shopify Price Rule.

Lua path: app.integrations.shopify.update_price_rule
Full name: shopify.shopify_update_price_rule

Parameter	Type	Required	Description
No parameters.

delete_price_rule Write

Delete a Shopify Price Rule.

Lua path: app.integrations.shopify.delete_price_rule
Full name: shopify.shopify_delete_price_rule

Parameter	Type	Required	Description
No parameters.

list_webhooks Read

List Shopify Webhooks.

Lua path: app.integrations.shopify.list_webhooks
Full name: shopify.shopify_list_webhooks

Parameter	Type	Required	Description
No parameters.

get_webhook Read

Get one Shopify Webhook.

Lua path: app.integrations.shopify.get_webhook
Full name: shopify.shopify_get_webhook

Parameter	Type	Required	Description
No parameters.

create_webhook Write

Create a Shopify Webhook.

Lua path: app.integrations.shopify.create_webhook
Full name: shopify.shopify_create_webhook

Parameter	Type	Required	Description
No parameters.

update_webhook Write

Update a Shopify Webhook.

Lua path: app.integrations.shopify.update_webhook
Full name: shopify.shopify_update_webhook

Parameter	Type	Required	Description
No parameters.

delete_webhook Write

Delete a Shopify Webhook.

Lua path: app.integrations.shopify.delete_webhook
Full name: shopify.shopify_delete_webhook

Parameter	Type	Required	Description
No parameters.

list_script_tags Read

List Shopify Script Tags.

Lua path: app.integrations.shopify.list_script_tags
Full name: shopify.shopify_list_script_tags

Parameter	Type	Required	Description
No parameters.

get_script_tag Read

Get one Shopify Script Tag.

Lua path: app.integrations.shopify.get_script_tag
Full name: shopify.shopify_get_script_tag

Parameter	Type	Required	Description
No parameters.

create_script_tag Write

Create a Shopify Script Tag.

Lua path: app.integrations.shopify.create_script_tag
Full name: shopify.shopify_create_script_tag

Parameter	Type	Required	Description
No parameters.

update_script_tag Write

Update a Shopify Script Tag.

Lua path: app.integrations.shopify.update_script_tag
Full name: shopify.shopify_update_script_tag

Parameter	Type	Required	Description
No parameters.

delete_script_tag Write

Delete a Shopify Script Tag.

Lua path: app.integrations.shopify.delete_script_tag
Full name: shopify.shopify_delete_script_tag

Parameter	Type	Required	Description
No parameters.

list_themes Read

List Shopify Themes.

Lua path: app.integrations.shopify.list_themes
Full name: shopify.shopify_list_themes

Parameter	Type	Required	Description
No parameters.

get_theme Read

Get one Shopify Theme.

Lua path: app.integrations.shopify.get_theme
Full name: shopify.shopify_get_theme

Parameter	Type	Required	Description
No parameters.

create_theme Write

Create a Shopify Theme.

Lua path: app.integrations.shopify.create_theme
Full name: shopify.shopify_create_theme

Parameter	Type	Required	Description
No parameters.

update_theme Write

Update a Shopify Theme.

Lua path: app.integrations.shopify.update_theme
Full name: shopify.shopify_update_theme

Parameter	Type	Required	Description
No parameters.

delete_theme Write

Delete a Shopify Theme.

Lua path: app.integrations.shopify.delete_theme
Full name: shopify.shopify_delete_theme

Parameter	Type	Required	Description
No parameters.

list_pages Read

List Shopify Pages.

Lua path: app.integrations.shopify.list_pages
Full name: shopify.shopify_list_pages

Parameter	Type	Required	Description
No parameters.

get_page Read

Get one Shopify Page.

Lua path: app.integrations.shopify.get_page
Full name: shopify.shopify_get_page

Parameter	Type	Required	Description
No parameters.

create_page Write

Create a Shopify Page.

Lua path: app.integrations.shopify.create_page
Full name: shopify.shopify_create_page

Parameter	Type	Required	Description
No parameters.

update_page Write

Update a Shopify Page.

Lua path: app.integrations.shopify.update_page
Full name: shopify.shopify_update_page

Parameter	Type	Required	Description
No parameters.

delete_page Write

Delete a Shopify Page.

Lua path: app.integrations.shopify.delete_page
Full name: shopify.shopify_delete_page

Parameter	Type	Required	Description
No parameters.

list_blogs Read

List Shopify Blogs.

Lua path: app.integrations.shopify.list_blogs
Full name: shopify.shopify_list_blogs

Parameter	Type	Required	Description
No parameters.

get_blog Read

Get one Shopify Blog.

Lua path: app.integrations.shopify.get_blog
Full name: shopify.shopify_get_blog

Parameter	Type	Required	Description
No parameters.

create_blog Write

Create a Shopify Blog.

Lua path: app.integrations.shopify.create_blog
Full name: shopify.shopify_create_blog

Parameter	Type	Required	Description
No parameters.

update_blog Write

Update a Shopify Blog.

Lua path: app.integrations.shopify.update_blog
Full name: shopify.shopify_update_blog

Parameter	Type	Required	Description
No parameters.

delete_blog Write

Delete a Shopify Blog.

Lua path: app.integrations.shopify.delete_blog
Full name: shopify.shopify_delete_blog

Parameter	Type	Required	Description
No parameters.

list_fulfillment_services Read

List Shopify Fulfillment Services.

Lua path: app.integrations.shopify.list_fulfillment_services
Full name: shopify.shopify_list_fulfillment_services

Parameter	Type	Required	Description
No parameters.

get_fulfillment_service Read

Get one Shopify Fulfillment Service.

Lua path: app.integrations.shopify.get_fulfillment_service
Full name: shopify.shopify_get_fulfillment_service

Parameter	Type	Required	Description
No parameters.

create_fulfillment_service Write

Create a Shopify Fulfillment Service.

Lua path: app.integrations.shopify.create_fulfillment_service
Full name: shopify.shopify_create_fulfillment_service

Parameter	Type	Required	Description
No parameters.

update_fulfillment_service Write

Update a Shopify Fulfillment Service.

Lua path: app.integrations.shopify.update_fulfillment_service
Full name: shopify.shopify_update_fulfillment_service

Parameter	Type	Required	Description
No parameters.

delete_fulfillment_service Write

Delete a Shopify Fulfillment Service.

Lua path: app.integrations.shopify.delete_fulfillment_service
Full name: shopify.shopify_delete_fulfillment_service

Parameter	Type	Required	Description
No parameters.

list_locations Read

List Shopify Locations.

Lua path: app.integrations.shopify.list_locations
Full name: shopify.shopify_list_locations

Parameter	Type	Required	Description
No parameters.

get_location Read

Get one Shopify Location.

Lua path: app.integrations.shopify.get_location
Full name: shopify.shopify_get_location

Parameter	Type	Required	Description
No parameters.

list_inventory_items Read

List Shopify Inventory Items.

Lua path: app.integrations.shopify.list_inventory_items
Full name: shopify.shopify_list_inventory_items

Parameter	Type	Required	Description
No parameters.

get_inventory_item Read

Get one Shopify Inventory Item.

Lua path: app.integrations.shopify.get_inventory_item
Full name: shopify.shopify_get_inventory_item

Parameter	Type	Required	Description
No parameters.

update_inventory_item Write

Update a Shopify inventory item.

Lua path: app.integrations.shopify.update_inventory_item
Full name: shopify.shopify_update_inventory_item

Parameter	Type	Required	Description
No parameters.

list_product_variants Read

List Variants for a Shopify product.

Lua path: app.integrations.shopify.list_product_variants
Full name: shopify.shopify_list_product_variants

Parameter	Type	Required	Description
No parameters.

get_product_variant Read

Get one product Variant.

Lua path: app.integrations.shopify.get_product_variant
Full name: shopify.shopify_get_product_variant

Parameter	Type	Required	Description
No parameters.

create_product_variant Write

Create a product Variant.

Lua path: app.integrations.shopify.create_product_variant
Full name: shopify.shopify_create_product_variant

Parameter	Type	Required	Description
No parameters.

update_product_variant Write

Update a product Variant.

Lua path: app.integrations.shopify.update_product_variant
Full name: shopify.shopify_update_product_variant

Parameter	Type	Required	Description
No parameters.

delete_product_variant Write

Delete a product Variant.

Lua path: app.integrations.shopify.delete_product_variant
Full name: shopify.shopify_delete_product_variant

Parameter	Type	Required	Description
No parameters.

list_product_images Read

List Images for a Shopify product.

Lua path: app.integrations.shopify.list_product_images
Full name: shopify.shopify_list_product_images

Parameter	Type	Required	Description
No parameters.

get_product_image Read

Get one product Image.

Lua path: app.integrations.shopify.get_product_image
Full name: shopify.shopify_get_product_image

Parameter	Type	Required	Description
No parameters.

create_product_image Write

Create a product Image.

Lua path: app.integrations.shopify.create_product_image
Full name: shopify.shopify_create_product_image

Parameter	Type	Required	Description
No parameters.

update_product_image Write

Update a product Image.

Lua path: app.integrations.shopify.update_product_image
Full name: shopify.shopify_update_product_image

Parameter	Type	Required	Description
No parameters.

delete_product_image Write

Delete a product Image.

Lua path: app.integrations.shopify.delete_product_image
Full name: shopify.shopify_delete_product_image

Parameter	Type	Required	Description
No parameters.

list_product_metafields Read

List Metafields for a Shopify product.

Lua path: app.integrations.shopify.list_product_metafields
Full name: shopify.shopify_list_product_metafields

Parameter	Type	Required	Description
No parameters.

get_product_metafield Read

Get one product Metafield.

Lua path: app.integrations.shopify.get_product_metafield
Full name: shopify.shopify_get_product_metafield

Parameter	Type	Required	Description
No parameters.

create_product_metafield Write

Create a product Metafield.

Lua path: app.integrations.shopify.create_product_metafield
Full name: shopify.shopify_create_product_metafield

Parameter	Type	Required	Description
No parameters.

update_product_metafield Write

Update a product Metafield.

Lua path: app.integrations.shopify.update_product_metafield
Full name: shopify.shopify_update_product_metafield

Parameter	Type	Required	Description
No parameters.

delete_product_metafield Write

Delete a product Metafield.

Lua path: app.integrations.shopify.delete_product_metafield
Full name: shopify.shopify_delete_product_metafield

Parameter	Type	Required	Description
No parameters.

close_order Write

Close a Shopify order.

Lua path: app.integrations.shopify.close_order
Full name: shopify.shopify_close_order

Parameter	Type	Required	Description
No parameters.

reopen_order Write

Reopen a Shopify order.

Lua path: app.integrations.shopify.reopen_order
Full name: shopify.shopify_reopen_order

Parameter	Type	Required	Description
No parameters.

cancel_order Write

Cancel a Shopify order.

Lua path: app.integrations.shopify.cancel_order
Full name: shopify.shopify_cancel_order

Parameter	Type	Required	Description
No parameters.

list_order_transactions Read

List Transactions for a Shopify order.

Lua path: app.integrations.shopify.list_order_transactions
Full name: shopify.shopify_list_order_transactions

Parameter	Type	Required	Description
No parameters.

get_order_transaction Read

Get one order Transaction.

Lua path: app.integrations.shopify.get_order_transaction
Full name: shopify.shopify_get_order_transaction

Parameter	Type	Required	Description
No parameters.

create_order_transaction Write

Create an order Transaction.

Lua path: app.integrations.shopify.create_order_transaction
Full name: shopify.shopify_create_order_transaction

Parameter	Type	Required	Description
No parameters.

update_order_transaction Write

Update an order Transaction.

Lua path: app.integrations.shopify.update_order_transaction
Full name: shopify.shopify_update_order_transaction

Parameter	Type	Required	Description
No parameters.

delete_order_transaction Write

Delete an order Transaction.

Lua path: app.integrations.shopify.delete_order_transaction
Full name: shopify.shopify_delete_order_transaction

Parameter	Type	Required	Description
No parameters.

list_order_fulfillments Read

List Fulfillments for a Shopify order.

Lua path: app.integrations.shopify.list_order_fulfillments
Full name: shopify.shopify_list_order_fulfillments

Parameter	Type	Required	Description
No parameters.

get_order_fulfillment Read

Get one order Fulfillment.

Lua path: app.integrations.shopify.get_order_fulfillment
Full name: shopify.shopify_get_order_fulfillment

Parameter	Type	Required	Description
No parameters.

create_order_fulfillment Write

Create an order Fulfillment.

Lua path: app.integrations.shopify.create_order_fulfillment
Full name: shopify.shopify_create_order_fulfillment

Parameter	Type	Required	Description
No parameters.

update_order_fulfillment Write

Update an order Fulfillment.

Lua path: app.integrations.shopify.update_order_fulfillment
Full name: shopify.shopify_update_order_fulfillment

Parameter	Type	Required	Description
No parameters.

delete_order_fulfillment Write

Delete an order Fulfillment.

Lua path: app.integrations.shopify.delete_order_fulfillment
Full name: shopify.shopify_delete_order_fulfillment

Parameter	Type	Required	Description
No parameters.

list_order_refunds Read

List Refunds for a Shopify order.

Lua path: app.integrations.shopify.list_order_refunds
Full name: shopify.shopify_list_order_refunds

Parameter	Type	Required	Description
No parameters.

get_order_refund Read

Get one order Refund.

Lua path: app.integrations.shopify.get_order_refund
Full name: shopify.shopify_get_order_refund

Parameter	Type	Required	Description
No parameters.

create_order_refund Write

Create an order Refund.

Lua path: app.integrations.shopify.create_order_refund
Full name: shopify.shopify_create_order_refund

Parameter	Type	Required	Description
No parameters.

list_order_risks Read

List Risks for a Shopify order.

Lua path: app.integrations.shopify.list_order_risks
Full name: shopify.shopify_list_order_risks

Parameter	Type	Required	Description
No parameters.

get_order_risk Read

Get one order Risk.

Lua path: app.integrations.shopify.get_order_risk
Full name: shopify.shopify_get_order_risk

Parameter	Type	Required	Description
No parameters.

create_order_risk Write

Create an order Risk.

Lua path: app.integrations.shopify.create_order_risk
Full name: shopify.shopify_create_order_risk

Parameter	Type	Required	Description
No parameters.

update_order_risk Write

Update an order Risk.

Lua path: app.integrations.shopify.update_order_risk
Full name: shopify.shopify_update_order_risk

Parameter	Type	Required	Description
No parameters.

delete_order_risk Write

Delete an order Risk.

Lua path: app.integrations.shopify.delete_order_risk
Full name: shopify.shopify_delete_order_risk

Parameter	Type	Required	Description
No parameters.

calculate_order_refund Write

Calculate refund transactions for an order.

Lua path: app.integrations.shopify.calculate_order_refund
Full name: shopify.shopify_calculate_order_refund

Parameter	Type	Required	Description
No parameters.

list_fulfillment_orders Read

List assigned fulfillment orders.

Lua path: app.integrations.shopify.list_fulfillment_orders
Full name: shopify.shopify_list_fulfillment_orders

Parameter	Type	Required	Description
No parameters.

list_order_fulfillment_orders Read

List fulfillment orders for an order.

Lua path: app.integrations.shopify.list_order_fulfillment_orders
Full name: shopify.shopify_list_order_fulfillment_orders

Parameter	Type	Required	Description
No parameters.

get_fulfillment_order Read

Get one fulfillment order.

Lua path: app.integrations.shopify.get_fulfillment_order
Full name: shopify.shopify_get_fulfillment_order

Parameter	Type	Required	Description
No parameters.

search_customers Read

Search Shopify customers.

Lua path: app.integrations.shopify.search_customers
Full name: shopify.shopify_search_customers

Parameter	Type	Required	Description
No parameters.

list_customer_addresses Read

List Addresses for a Shopify customer.

Lua path: app.integrations.shopify.list_customer_addresses
Full name: shopify.shopify_list_customer_addresses

Parameter	Type	Required	Description
No parameters.

get_customer_address Read

Get one customer Address.

Lua path: app.integrations.shopify.get_customer_address
Full name: shopify.shopify_get_customer_address

Parameter	Type	Required	Description
No parameters.

create_customer_address Write

Create a customer Address.

Lua path: app.integrations.shopify.create_customer_address
Full name: shopify.shopify_create_customer_address

Parameter	Type	Required	Description
No parameters.

update_customer_address Write

Update a customer Address.

Lua path: app.integrations.shopify.update_customer_address
Full name: shopify.shopify_update_customer_address

Parameter	Type	Required	Description
No parameters.

delete_customer_address Write

Delete a customer Address.

Lua path: app.integrations.shopify.delete_customer_address
Full name: shopify.shopify_delete_customer_address

Parameter	Type	Required	Description
No parameters.

list_customer_metafields Read

List Metafields for a Shopify customer.

Lua path: app.integrations.shopify.list_customer_metafields
Full name: shopify.shopify_list_customer_metafields

Parameter	Type	Required	Description
No parameters.

get_customer_metafield Read

Get one customer Metafield.

Lua path: app.integrations.shopify.get_customer_metafield
Full name: shopify.shopify_get_customer_metafield

Parameter	Type	Required	Description
No parameters.

create_customer_metafield Write

Create a customer Metafield.

Lua path: app.integrations.shopify.create_customer_metafield
Full name: shopify.shopify_create_customer_metafield

Parameter	Type	Required	Description
No parameters.

update_customer_metafield Write

Update a customer Metafield.

Lua path: app.integrations.shopify.update_customer_metafield
Full name: shopify.shopify_update_customer_metafield

Parameter	Type	Required	Description
No parameters.

delete_customer_metafield Write

Delete a customer Metafield.

Lua path: app.integrations.shopify.delete_customer_metafield
Full name: shopify.shopify_delete_customer_metafield

Parameter	Type	Required	Description
No parameters.

set_default_customer_address Write

Set the default address for a customer.

Lua path: app.integrations.shopify.set_default_customer_address
Full name: shopify.shopify_set_default_customer_address

Parameter	Type	Required	Description
No parameters.

list_discount_codes Read

List discount codes for a price rule.

Lua path: app.integrations.shopify.list_discount_codes
Full name: shopify.shopify_list_discount_codes

Parameter	Type	Required	Description
No parameters.

get_discount_code Read

Get one discount code.

Lua path: app.integrations.shopify.get_discount_code
Full name: shopify.shopify_get_discount_code

Parameter	Type	Required	Description
No parameters.

create_discount_code Write

Create a discount code for a price rule.

Lua path: app.integrations.shopify.create_discount_code
Full name: shopify.shopify_create_discount_code

Parameter	Type	Required	Description
No parameters.

update_discount_code Write

Update a discount code.

Lua path: app.integrations.shopify.update_discount_code
Full name: shopify.shopify_update_discount_code

Parameter	Type	Required	Description
No parameters.

delete_discount_code Write

Delete a discount code.

Lua path: app.integrations.shopify.delete_discount_code
Full name: shopify.shopify_delete_discount_code

Parameter	Type	Required	Description
No parameters.

lookup_discount_code Read

Look up a discount code by code string.

Lua path: app.integrations.shopify.lookup_discount_code
Full name: shopify.shopify_lookup_discount_code

Parameter	Type	Required	Description
No parameters.

list_inventory_levels Read

List Shopify inventory levels.

Lua path: app.integrations.shopify.list_inventory_levels
Full name: shopify.shopify_list_inventory_levels

Parameter	Type	Required	Description
No parameters.

connect_inventory_level Write

Connect an inventory item to a location.

Lua path: app.integrations.shopify.connect_inventory_level
Full name: shopify.shopify_connect_inventory_level

Parameter	Type	Required	Description
No parameters.

set_inventory_level Write

Set available inventory at a location.

Lua path: app.integrations.shopify.set_inventory_level
Full name: shopify.shopify_set_inventory_level

Parameter	Type	Required	Description
No parameters.

adjust_inventory_level Write

Adjust available inventory at a location.

Lua path: app.integrations.shopify.adjust_inventory_level
Full name: shopify.shopify_adjust_inventory_level

Parameter	Type	Required	Description
No parameters.

delete_inventory_level Write

Delete an inventory level.

Lua path: app.integrations.shopify.delete_inventory_level
Full name: shopify.shopify_delete_inventory_level

Parameter	Type	Required	Description
No parameters.

list_assets Read

List assets for a theme.

Lua path: app.integrations.shopify.list_assets
Full name: shopify.shopify_list_assets

Parameter	Type	Required	Description
No parameters.

get_asset Read

Get a theme asset by key.

Lua path: app.integrations.shopify.get_asset
Full name: shopify.shopify_get_asset

Parameter	Type	Required	Description
No parameters.

put_asset Write

Create or update a theme asset.

Lua path: app.integrations.shopify.put_asset
Full name: shopify.shopify_put_asset

Parameter	Type	Required	Description
No parameters.

delete_asset Write

Delete a theme asset by key.

Lua path: app.integrations.shopify.delete_asset
Full name: shopify.shopify_delete_asset

Parameter	Type	Required	Description
No parameters.

list_articles Read

List articles for a blog.

Lua path: app.integrations.shopify.list_articles
Full name: shopify.shopify_list_articles

Parameter	Type	Required	Description
No parameters.

get_article Read

Get one blog article.

Lua path: app.integrations.shopify.get_article
Full name: shopify.shopify_get_article

Parameter	Type	Required	Description
No parameters.

create_article Write

Create a blog article.

Lua path: app.integrations.shopify.create_article
Full name: shopify.shopify_create_article

Parameter	Type	Required	Description
No parameters.

update_article Write

Update a blog article.

Lua path: app.integrations.shopify.update_article
Full name: shopify.shopify_update_article

Parameter	Type	Required	Description
No parameters.

delete_article Write

Delete a blog article.

Lua path: app.integrations.shopify.delete_article
Full name: shopify.shopify_delete_article

Parameter	Type	Required	Description
No parameters.

list_metafields Read

List shop-level metafields.

Lua path: app.integrations.shopify.list_metafields
Full name: shopify.shopify_list_metafields

Parameter	Type	Required	Description
No parameters.

get_metafield Read

Get one shop-level metafield.

Lua path: app.integrations.shopify.get_metafield
Full name: shopify.shopify_get_metafield

Parameter	Type	Required	Description
No parameters.

create_metafield Write

Create a shop-level metafield.

Lua path: app.integrations.shopify.create_metafield
Full name: shopify.shopify_create_metafield

Parameter	Type	Required	Description
No parameters.

update_metafield Write

Update a shop-level metafield.

Lua path: app.integrations.shopify.update_metafield
Full name: shopify.shopify_update_metafield

Parameter	Type	Required	Description
No parameters.

delete_metafield Write

Delete a shop-level metafield.

Lua path: app.integrations.shopify.delete_metafield
Full name: shopify.shopify_delete_metafield

Parameter	Type	Required	Description
No parameters.