When you configure an export, import, or other type of flow step using the prebuilt Shopify connector, you can select any of the API operations listed below*, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Shopify API documentation. *You can also create a composite endpoint for this application in HTTP mode.
API |
Operation |
Export |
Import |
---|---|---|---|
Access: StorefrontAccessToken |
Retrieves a list of storefront active tokens that have been issued |
X |
|
Creates a new storefront access token |
X |
||
Delete |
X |
||
Analytics: Report [Deprecating] |
Retrieves a list of reports [Deprecating] |
X |
|
Retrieves a single report [Deprecating] |
X |
||
Create or Update reports [Deprecating] |
X |
||
Creates a new report [Deprecating] |
X |
||
Deletes a report [Deprecating] |
X |
||
Updates a report [Deprecating] |
X |
||
Billing: ApplicationCharge |
Retrieve a list of application charges |
X |
|
Retrieves an application charge |
X |
||
Creates an application charge |
X |
||
Billing: ApplicationCredit |
Retrieves a single application credit |
X |
|
Retrieves all application credits |
X |
||
Creates an application credit |
X |
||
Billing: RecurringApplicationCharge |
Retrieves a list of recurring application charges |
X |
|
Retrieves a single charge |
X |
||
Create |
X |
||
Billing: UsageCharge |
Retrieves a list of usage charges |
X |
|
Retrieves a single charge |
X |
||
Create |
X |
||
Customers: Customer |
Retrieves a list of customers |
X |
|
Retrieves a list of metafields that belong to a customer |
X |
||
Retrieves a single customer |
|||
Searches for customers that match a supplied query |
X |
||
Create or update customer |
X |
||
Creates a customer |
X |
||
Deletes a customer |
X |
||
Updates a customer |
X |
||
Customers: Customer Address |
Retrieves a list of addresses for a customer |
X |
|
Retrieves details a single customer address |
X |
||
Create a new address for a customer |
X |
||
Create or Update customer address |
X |
||
Removes an address from a customer's address list |
X |
||
Updates an existing customer address |
X |
||
Customers: CustomerSavedSearch |
Retrieves a count of all customer saved searches |
X |
|
Retrieves a list of all customer saved searches |
X |
||
Retrieves a single customer saved search |
X |
||
Retrieves all customers returned by a customer saved search |
X |
||
Create or Update customer saved search |
X |
||
Creates a customer saved search |
X |
||
Updates a customer saved search |
X |
||
Deletes a customer saved search |
X |
||
Deprecated API calls (applies to versions later than 2021-01) |
Retrieves all deprecated API calls |
X |
|
Discounts: DiscountCode |
Retrieve a count of discount codes for a shop (applies to versions later than 2021-04) |
X |
|
Retrieve a list of discount codes |
X |
||
Retrieves a single discount code |
X |
||
Retrieves the location of a discount code |
X |
||
Create a new discount code creation job |
X |
||
Create or Update discount code |
X |
||
Deletes a discount code |
X |
||
Updates an existing discount code |
X |
||
Discounts: PriceRule |
Retrieves a list of price rules |
X |
|
Retrieves a single price rule |
X |
||
Create or Update a price rule |
X |
||
Updates an existing price rule |
|||
Creates a price rule |
X |
||
Deletes a price rule |
X |
||
Events: Event |
Retrieve a list of all events from a specific order |
X |
|
Retrieve all events from a specific product |
X |
||
Retrieves a count of events |
X |
||
Retrieves a list of events |
X |
||
Retrieves a single event |
X |
||
Events: Webhook |
Count of all the webhook subscriptions for your shop |
X |
|
Retrieve a single webhook by its ID |
X |
||
Retrieves a list of webhooks |
X |
||
Create a new webhook subscription |
X |
||
Create or Update a webhook subscription |
X |
||
Delete a webhook subscription |
X |
||
Update a webhook subscription |
X |
||
Gift Card |
Retrieves a count of gift cards |
X |
|
Retrieves a list of gift cards |
X |
||
Retrieves a single gift card by its ID |
X |
||
Searches for gift cards |
X |
||
Inventory: InventoryItem |
Retrieves a list of inventory items |
X |
|
Retrieves a single inventory item by ID |
X |
||
Updates an existing inventory item |
X |
||
Inventory: InventoryLevel |
Retrieves a list of inventory levels |
X |
|
Adjusts the inventory level of an inventory item at a single location |
X |
||
Connects an inventory item to a location |
X |
||
Sets the inventory level of an inventory item at a location |
X |
||
Inventory: Location |
Retrieves a count of inventory locations |
X |
|
Retrieves a list of inventory for a location |
X |
||
Retrieves a list of locations |
X |
||
Retrieves a single location by its ID |
X |
||
Marketing Event |
Retrieves a count of all marketing events |
X |
|
Retrieves a list of all marketing events |
X |
||
Retrieves a single marketing event |
X |
||
Create or update marketing event |
X |
||
Creates a marketing event |
X |
||
Creates marketing engagements on marketing event |
X |
||
Deletes a marketing event |
X |
||
Updates a marketing event |
X |
||
Metafield |
Count of metafields that belong to a product |
X |
|
Get a single product metafield |
X |
||
Get metafields that belong to a product |
X |
||
Retrieves a count of a resource's metafields |
X |
||
Retrieves a list of metafields that belong to a resource |
X |
||
Retrieves a single metafield from a resource by its ID |
X |
||
Create a new metafield for a product |
X |
||
Create or update metafield |
X |
||
Create or update metafield for a product |
X |
||
Creates a new metafield for a resource |
X |
||
Delete a metafield for a product |
X |
||
Online store: Article |
Retrieves a single article |
X |
|
Retrieves a count of all articles from a blog |
X |
||
Retrieves a list of all article authors |
X |
||
Retrieves a list of all articles from a blog |
X |
||
Retrieves a list of all the tags |
X |
||
Retrieves a list of metafields that belong to an article |
X |
||
Create or Update Article |
X |
||
Creates an article for a blog |
X |
||
Deletes an article |
X |
||
Updates an article |
X |
||
Online store: Assets |
Retrieves a list of all assets for a theme |
X |
|
Retrieves a single asset for a theme |
X |
||
Creates or updates an asset for a theme |
X |
||
Deletes an asset from a theme |
X |
||
Online store: Blog |
Receive a count of all blogs |
X |
|
Receive a list of all blogs |
X |
||
Receive a single Blog |
X |
||
Retrieves a list of metafields that belong to a blog |
X |
||
Create a new blog |
X |
||
Create or Update |
X |
||
Delete a blog |
X |
||
Update a blog |
X |
||
Online store: Comment |
Retrieves a count of comments |
X |
|
Retrieves a list of comments |
X |
||
Retrieves a single comment by its ID |
X |
||
Approve a comment |
X |
||
Create or Update comment |
X |
||
Creates a comment for an article |
X |
||
Mark a comment as not spam |
X |
||
Mark a comment as spam |
X |
||
Online store: Page |
Retrieve a list of pages |
X |
|
Retrieves a list of metafields that belong to a page |
X |
||
Retrieves a page count |
X |
||
Retrieves a single page by its ID |
X |
||
Create a new page |
X |
||
Create or Update page |
X |
||
Deletes a page |
X |
||
Updates a page |
X |
||
Online store: Redirect |
Retrieves a Count of URL redirects |
X |
|
Retrieves a list of URL redirects |
X |
||
Retrieves a single redirect |
X |
||
Create or Update redirect |
X |
||
Creates a redirect |
X |
||
Deletes a redirect |
X |
||
Updates an existing redirect |
X |
||
Online store: ScriptTag |
Retrieves a count of all script tags |
X |
|
Retrieves a list of all script tags |
X |
||
Retrieves a single script tag |
X |
||
Create or Update script tag |
X |
||
Creates a new script tag |
X |
||
Deletes a script tag |
X |
||
Updates a script tag |
X |
||
Online store: Theme |
Retrieves a list of themes |
X |
|
Retrieves a single theme |
X |
||
Create or Update theme |
X |
||
Creates a theme |
X |
||
Deletes a theme |
X |
||
Updates an existing theme |
X |
||
Orders: Abandoned checkouts |
Retrieves abandoned checkouts |
X |
|
Orders: DraftOrder |
Receive a single draft order |
X |
|
Retrieve a count of all draft orders |
X |
||
Retrieve a list of draft orders |
X |
||
Retrieves a list of metafields that belong to a draft order |
X |
||
Completes a draft order |
X |
||
Create or Update draft order |
X |
||
Creates a draft order |
X |
||
Deletes a draft order |
X |
||
Sends an invoice for the draft order |
X |
||
Orders: Order |
Retrieve a list of orders |
X |
|
Retrieves a list of metafields that belong to a specific order |
X |
||
Retrieves a specific order |
X |
||
Retrieves an order count |
X |
||
Cancels an order |
X |
||
Closes an order |
X |
||
Create or Update order |
X |
||
Creates an order |
X |
||
Deletes an order |
X |
||
Re-opens a closed order |
X |
||
Updates an order |
X |
||
Orders: Order Risk [Deprecating] |
Retrieves a list of all order risks for an order [Deprecating] |
X |
|
Retrieves a single order risk by its ID [Deprecating] |
X |
||
Create or Update an order risk [Deprecating] |
X |
||
Creates an order risk for an order [Deprecating] |
X |
||
Deletes an order risk for an order [Deprecating] |
X |
||
Updates an order risk [Deprecating] |
X |
||
Orders: Refund |
Retrieves a list of refunds from an order |
X |
|
Retrieves a specific refund |
X |
||
Calculates a refund |
X |
||
Creates a refund |
X |
||
Orders: Transactions |
Retrieves a list of transactions |
X |
|
Retrieves a single transaction |
X |
||
Creates a transaction for an order |
X |
||
Products: Collect |
Retrieves a count of collects |
X |
|
Retrieves a list of collects |
X |
||
Retrieves a specific collect by its ID |
X |
||
Plus: Gift Card |
Create or Update gift cards |
X |
|
Creates a gift card |
X |
||
Disables a gift card |
X |
||
Updates an existing gift card |
X |
||
Products: Collection |
Retrieve a specific collection by its ID |
X |
|
Retrieves a list of products belonging to a collection |
X |
||
Adds a product to a custom collection |
X |
||
Removes a product from a collection |
X |
||
Products: CustomCollection |
Retrieves a count of custom collections |
X |
|
Retrieves a list of custom collections |
X |
||
Retrieves a list of metafields that belong to a CustomCollection and Smart Collection |
X |
||
Retrieves a single custom collection |
X |
||
Create or Update custom collection |
X |
||
Creates a custom collection |
X |
||
Deletes a custom collection |
X |
||
Updates an existing custom collection |
X |
||
Products: Product |
Retrieves a list of metafields that belong to a product |
X |
|
Retrieves a list of products |
X |
||
Retrieves a single product |
X |
||
Create or Update product |
X |
||
Creates a new product |
X |
||
Updates a product |
X |
||
Deletes a product |
X |
||
Products: Product Image |
Retrieves a count of all product images |
X |
|
Retrieves a list of metafields that belong to a product |
X |
||
Retrieves a list of product images |
X |
||
Retrieves a single Product Image |
X |
||
Products: Product Variant [Deprecating] |
Retrieves a list of metafields that belong to a product variant [Deprecating] |
X |
|
Retrieves a list of product variants[Deprecating] |
X |
||
Retrieves a single product variant [Deprecating] |
X |
||
Create or Update product [Deprecating] |
X |
||
Creates a new product variant [Deprecating] |
X |
||
Modify an existing product variant [Deprecating] |
X |
||
Remove a product variant from the database [Deprecating] |
X |
||
Products: SmartCollection |
Retrieves a count of smart collections |
X |
|
Retrieves a list of smart collections |
X |
||
Retrieves a single smart collection |
X |
||
Create or Update smart collection |
X |
||
Creates a smart collection |
X |
||
Removes a smart collection |
X |
||
Updates an existing smart collection |
X |
||
Updates the ordering type of products in a smart collection |
X |
||
Removes a smart collection |
X |
||
Sales channel: CollectionListing |
Retrieve a specific collection listing that is published to your app |
X |
|
Retrieve collection listings that are published to your app |
X |
||
Retrieve product_ids that are published to a collection_id |
X |
||
Sales channel: ProductListing |
Retrieve a count of products that are published to your app |
X |
|
Retrieve a specific product listing that is published to your app |
X |
||
Retrieve product listings that are published to your app |
X |
||
Retrieve product_ids that are published to your app |
X |
||
Create a product listing to publish a product to your app |
X |
||
Delete a product listing to unpublish a product from your app |
X |
||
Sales channel: ResourceFeedback |
Retrieve a list of all ResourceFeedbacks |
X |
|
Creates a new ResourceFeedback |
X |
||
Shipping and fulfillment: Carrier Service |
Retrieves a list of all carrier services |
X |
|
Retrieves a single carrier service |
X |
||
Shipping and fulfillment: Fulfillment |
Receive a single fulfillment |
X |
|
Retrieves a count of fulfillments associated with a specific order |
X |
||
Retrieves fulfillments associated with a fulfillment order |
X |
||
Retrieves fulfillments associated with an order |
X |
||
Creates a fulfillment for one or many fulfillment orders |
X |
||
Updates the tracking information for a fulfillment |
X |
||
Create or Update a Fulfillment |
X |
||
Cancel a Fulfillment |
X |
||
Shipping and fulfillment: FulfillmentEvent |
Retrieves a list of fulfillment events for a specific fulfillment |
X |
|
Retrieves a specific fulfillment |
X |
||
Creates a fulfillment event |
X |
||
Deletes a fulfillment event |
X |
||
Shipping and fulfillment: FulfillmentOrder |
Get a single fulfillment order by its ID |
X |
|
Retrieve a list of all fulfillment orders for an order |
X |
||
Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app |
X |
||
Applies a fulfillment hold on an open fulfillment order |
X |
||
Cancel a fulfillment order |
X |
||
Move a fulfillment order to a new location |
X |
||
Transition a fulfillment order from in progress to incomplete |
X |
||
Transition a fulfillment order from scheduled to open |
X |
||
Update the fulfill_at time of a scheduled fulfillment order |
X |
||
Shipping and fulfillment: FulfillmentService |
Receive a list of all Fulfillment Services |
X |
|
Receive a single FulfillmentService |
X |
||
Create a FulfillmentService |
X |
||
Create or Update FulfillmentService |
X |
||
Modify an existing FulfillmentService |
X |
||
Remove a FulfillmentService from the database |
X |
||
Shopify Payments: Payouts |
Retrieves a list of all payouts ordered by payout date |
X |
|
Retrieves a single payout by ID |
X |
||
Shopify Payments: Transactions |
Retrieves a list of all balance transactions |
X |
|
Store Properties: Country |
Receive a list of all countries |
X |
|
Retrieves a count of countries |
X |
||
Retrieves a specific county |
X |
||
Create or Update country |
X |
||
Creates a country |
X |
||
Remove a country from the database |
X |
||
Updates an existing country |
X |
||
Store Properties: Currency |
Retrieves a list of currencies enabled on a shop |
X |
|
Store Properties: Policy |
Retrieves a list of the shop's policies. |
X |
|
Store Properties: Province |
Retrieves a count of provinces for the country |
X |
|
Retrieves a list of provinces for the country |
X |
||
Retrieves a single province for a country |
X |
||
Updates an existing province for a country |
X |
||
Store Properties: Shipping Zone |
Receive a list of all shipping zones |
X |
|
Store Properties: Shop |
Retrieves a list of metafields that belong to a shop |
X |
|
Retrieves the shop's configurations |
X |
||
TenderTransaction |
Retrieves a list of tender transactions |
X |
Comments
Please sign in to leave a comment.