Collections
addProducts
collections.addProducts
Add products to a collection; the whole call fails if any is already present
Risk: write
collection full type
collection full type
create
collections.create
Create a manual collection with a title and handle
Risk: write
collection full type
collection full type
get
collections.get
Read one collection by GID
Risk: read
collection full type
collection full type
list
collections.list
List collections with their product counts, cursor-paged
Risk: read
collections full type
collections full type
Customers
create
customers.create
Create a customer with an email, name and tags
Risk: write
customer full type
customer full type
get
customers.get
Read one customer by GID, including addresses and spend
Risk: read
customer full type
customer full type
list
customers.list
List customers with order counts and spend, cursor-paged and filtered
Risk: read
customers full type
customers full type
update
customers.update
Update a customer, overwriting tags when tags are passed
Risk: write
customer full type
customer full type
Inventory
adjust
inventory.adjust
Adjust available stock by a signed delta at one location, with a reason
Risk: write
inventoryAdjustmentGroup full type
inventoryAdjustmentGroup full type
list
inventory.list
Read the available stock of one inventory item at every active location
Risk: read
inventoryItem full type
inventoryItem full type
Orders
cancel
orders.cancel
Cancel an order, optionally restocking and notifying the customer; does not refund
Risk: destructive · Irreversible
order full type
order full type
close
orders.close
Close a completed or cancelled order so it no longer counts as open
Risk: write
order full type
order full type
get
orders.get
Read one order by GID with its customer and a page of its line items
Risk: read
order full type
order full type
list
orders.list
List orders with totals and line items, filtered and sorted, cursor-paged
Risk: read
orders full type
orders full type
listLineItems
orders.listLineItems
Read one page of an order line items, cursor-paged, for orders with more than one page
Risk: read
lineItems full type
lineItems full type
markAsPaid
orders.markAsPaid
Mark an order as paid: captures an existing payment authorization, or records a manual payment for the outstanding amount
Risk: destructive · Irreversible
order full type
order full type
Products
create
products.create
Create a product with its title and catalog fields; variants are added separately
Risk: write
product full type
product full type
delete
products.delete
Permanently delete a product with its variants, media and inventory items
Risk: destructive · Irreversible
productDeleteOperation full type
productDeleteOperation full type
get
products.get
Read one product by GID, including its first variants and inventory totals
Risk: read
product full type
product full type
list
products.list
List products with their first variants, cursor-paged and filtered with Shopify search syntax
Risk: read
products full type
products full type
update
products.update
Update a product, changing only the fields that are passed
Risk: write
product full type
product full type
Shop
get
shop.get
Read the shop name, domain, currency and plan for the configured token
Risk: read
shop full type
shop full type
listLocations
shop.listLocations
List the inventory locations of the shop, for use with inventory.adjust
Risk: read
locations full type
locations full type
Variants
list
variants.list
List the variants of one product, cursor-paged, with price and stock
Risk: read
productVariants full type
productVariants full type
update
variants.update
Update price, SKU, barcode or inventory policy on one variant
Risk: write
productVariants full type
productVariants full type
Webhook Subscriptions
create
webhookSubscriptions.create
Register a JSON webhook subscription for one topic and URI
Risk: write
webhookSubscription full type
webhookSubscription full type
delete
webhookSubscriptions.delete
Delete a webhook subscription, stopping further deliveries for that topic
Risk: destructive · Irreversible
list
webhookSubscriptions.list
List shop-scoped webhook subscriptions, optionally filtered by topic
Risk: read
webhookSubscriptions full type
webhookSubscriptions full type