Skip to main content
New to Corsair? See API access, authentication, and error handling.

Collections

addProducts

collections.addProducts Add products to a collection; the whole call fails if any is already present Risk: write
Input Output

create

collections.create Create a manual collection with a title and handle Risk: write
Input Output

get

collections.get Read one collection by GID Risk: read
Input Output

list

collections.list List collections with their product counts, cursor-paged Risk: read
Input Output

Customers

create

customers.create Create a customer with an email, name and tags Risk: write
Input Output

get

customers.get Read one customer by GID, including addresses and spend Risk: read
Input Needs protected customer data access on the app. Fields the app was not granted (name, email, phone) come back null with an ACCESS_DENIED warning, and the rest of the customer is returned. Output

list

customers.list List customers with order counts and spend, cursor-paged and filtered Risk: read
Input Needs protected customer data access on the app; without it the call fails. With access to the Customer object but not to a field (Name, Email, Phone, Address), Shopify nulls that field and returns an ACCESS_DENIED warning beside the rows, and the plugin keeps the rows. Output

update

customers.update Update a customer, overwriting tags when tags are passed Risk: write
Input Passing tags replaces the full tag set. Use the Shopify admin or a tagsAdd mutation to append one without dropping the rest. Output

Inventory

adjust

inventory.adjust Adjust available stock by a signed delta at one location, with a reason Risk: write
Input Adjusts the available quantity by a signed delta at one location. A positive delta adds stock and a negative one removes it. Each call sends a new idempotency key unless you pass idempotencyKey; pass the same key only to retry the same adjustment. Output

list

inventory.list Read the available stock of one inventory item at every active location Risk: read
Input Output

Orders

cancel

orders.cancel Cancel an order, optionally restocking and notifying the customer; does not refund Risk: destructive · Irreversible
Input Cancels the order without refunding. Cancelling and refunding are separate decisions, so the deprecated refund flag is not used and no money moves on a cancel. Output

close

orders.close Close a completed or cancelled order so it no longer counts as open Risk: write
Input Output

get

orders.get Read one order by GID with its customer and a page of its line items Risk: read
Input Output

list

orders.list List orders with totals and line items, filtered and sorted, cursor-paged Risk: read
Input Output

listLineItems

orders.listLineItems Read one page of an order line items, cursor-paged, for orders with more than one page Risk: read
Input Output

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
Input Output

Products

create

products.create Create a product with its title and catalog fields; variants are added separately Risk: write
Input Output

delete

products.delete Permanently delete a product with its variants, media and inventory items Risk: destructive · Irreversible
Input Deletes synchronously by default and returns deletedProductId. Set synchronous to false for a product with many variants: the delete then runs in the background and returns productDeleteOperation, whose id and status let you track it, while deletedProductId may be null. Output

get

products.get Read one product by GID, including its first variants and inventory totals Risk: read
Input Output

list

products.list List products with their first variants, cursor-paged and filtered with Shopify search syntax Risk: read
Input Output

update

products.update Update a product, changing only the fields that are passed Risk: write
Input Output

Shop

get

shop.get Read the shop name, domain, currency and plan for the configured token Risk: read
Input: empty object Output

listLocations

shop.listLocations List the inventory locations of the shop, for use with inventory.adjust Risk: read
Input Returns the inventory locations. Pass a location id to inventory.adjust to change stock at that location. Output

Variants

list

variants.list List the variants of one product, cursor-paged, with price and stock Risk: read
Input Output

update

variants.update Update price, SKU, barcode or inventory policy on one variant Risk: write
Input Output

Webhook Subscriptions

create

webhookSubscriptions.create Register a JSON webhook subscription for one topic and URI Risk: write
Input Registers a JSON subscription. Shopify also delivers XML, which this plugin cannot verify or parse, so the format is not configurable. Output

delete

webhookSubscriptions.delete Delete a webhook subscription, stopping further deliveries for that topic Risk: destructive · Irreversible
Input Output

list

webhookSubscriptions.list List shop-scoped webhook subscriptions, optionally filtered by topic Risk: read
Input Output