Abandoned checkouts
Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
Showing all 67 documents.
AccessScope
View the access scopes approved by merchants during installation of your app.
ApplicationCharge
Charge a shop a one-time fee by creating an application charge.
ApplicationCredit
Request to create an application credit for a particular shop.
Article
Manage a store's articles. Each article belongs to a blog and can have many comments.
Asset
Manage the files that make up a store's theme to change the look of the online store.
AssignedFulfillmentOrder
View the fulfillment orders of a shop that are assigned to your app.
Balance
View the current balance for a Shopify Payments account
Blog
Create, edit, and delete a store's blogs. Each store can have multiple blogs, and each blog can have many articles (blog posts). Use the Article API to manage each blog's articles.
CancellationRequest
Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
CarrierService
Provide real-time shipping calculations before checkout with your custom shipping service.
Collect
After creating a custom collection, add products to it by creating a collect for each product. Each collect associates one product with one custom collection.
Collection
Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores easier to browse.
CollectionListing
Manage the collections that are published to your sales channel and retrieve their information.
Comment
Manage the reader comments for articles (blog posts). Each article can have many comments. Some available actions include creating comments, updating comments, deleting comments, marking comments as spam, and approving comments.
Country
Manage the country and provincial tax rates that are applied to applicable items at checkout.
Currency
Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
CustomCollection
Manage a store's custom collections. A custom collection is one where products are included manually, as opposed to being included automatically because they meet selection conditions.
Customer
Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
Customer Address
Manage the customer addresses for a store. Customers can have multiple addresses, one of which is the default address that's used to calculate taxes and shipping charges.
Deprecated API calls
Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
DiscountCode
After setting up the logic for a discount using the PriceRule API, use the DiscountCode API to associate the discount with a code, which can be entered at the checkout to apply the discount.
Dispute
Get information regarding Shopify Payments disputes.
Dispute Evidence
Get information regarding Shopify Payments dispute evidences.
Dispute File Upload
Upload dispute evidence files for a dispute.
DraftOrder
Allow merchants to manually create orders on behalf of customers. The order is saved as a draft in the Shopify admin until it's marked as completed.
Event
Retrieve a list of events, which are important actions in the operation of a shop. Shopify records events for a range of resources, and each resource has its own set of actions that create events.
Fulfillment
Manage the fulfillment of an order's line items. Create a fulfillment for each shipment, provide tracking information, and notify the customer that their items have shipped.
FulfillmentEvent
Create fulfillment events for an order's fulfillments. The fulfillment events are displayed on the order status page so the customer can track the progress of their delivery.
FulfillmentOrder
Manage an item or a group of items in an order that are to be fulfilled from the same location. Retrieve and cancel fulfillment orders, mark fulfillment orders as incomplete, or move fulfillment orders to a new location.
FulfillmentRequest
Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
FulfillmentService
Register a fulfillment service with a store. The merchant can then set it as the fulfillment service for their products, and your service can manage the fulfillment of those products using the Fulfillment and FulfillmentEvent APIs.
Gift Card
Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
InventoryItem
List or update the inventory of a variant's inventory item. Each variant can have one inventory item, and each inventory item can have multiple locations. Each location can have multiple inventory items for multiple variants.
InventoryLevel
Get or update the inventory level of an inventory item at a location. Each inventory level is associated to a single inventory item and location.
Location
Retrieve the locations that a merchant has set up from their Shopify admin. Each location refers to the address of a business's headquarters, retail stores, pop-up stores, and warehouses. The store's locations are used to track sales and to configure the tax rates applied at checkout.
LocationsForMove
View the locations that a fulfillment order can potentially move to.
MarketingEvent
Create or update marketing events to track activity associated with a merchant's marketing campaigns.
Metafield
Add metafields to store resources.
MobilePlatformApplication
Enable shared web credentials for Shopify iOS apps and create iOS universal link or Android app link verification endpoints for merchant Shopify iOS or Android apps.
Order
Create and update a store's orders. Each order is a record of a complete purchase that includes details of the customer, their cart, and any transactions.
Order Risk
Display a fraud analysis and recommendations on the details page of an order.
Page
Create and update static pages for an online store.
Payouts
Get information regarding Shopify Payments payouts.
Policy
Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
PriceRule
Create the logic for a discount, and then use the DiscountCode API to associate a code with the discount so it can be applied at checkout.
Product
Manage a store's products, which are the individual items and services for sale in the store.
Product Image
Add or update a store's product images, which sales channels use to display the products to shoppers.
Product ResourceFeedback
Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
Product Variant
Add or update a product's variants. Variants are the different combinations of the product's options. For example, a t-shirt product with size and color options might have a variant in a small size and blue color.
ProductListing
Manage the products that are available to your sales channel and retrieve their information.
Province
Manage the tax rates that are applied to orders from a specific province or state.
RecurringApplicationCharge
Charge a shop a subscription fee to use your app. Charged every 30 days.
Redirect
Manage 301 redirects for a merchant's online store.
Refund
Create and retrieve refunds for an order. Each refund is a record of money being returned to the customer. Use the calculate endpoint to make sure that any refund that you create is accurate.
ResourceFeedback
Notify merchants about actions required to resolve errors with your app.
ScriptTag
Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
Shop
Access a store's general settings and information as configured by the merchant in their Shopify admin.
SmartCollection
Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
StorefrontAccessToken
Generate a storefront access token to access the Storefront API.
TenderTransaction
Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
Theme
Manage a store's themes, which control the look and feel of an online store. Use the Asset API to update specific files within a theme.
Transaction
Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
Transactions
Get information regarding Shopify Payments balance transactions.
UsageCharge
Charge varying amounts based on the monthly usage of your app.
User
Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
Webhook
Retrieve and store event data using webhooks.