Shopify
As the primary way that apps interact with Shopify, the Admin API allows you to add your own features to the Shopify user experience. Considerations when using the Shopify Admin include:
- The Admin API supports both GraphQL and REST.
- This is a versioned API. Updates are released quarterly and supported API versions are listed in the release notes.
- Apps must explicitly request the relevant access scopes from the user during installation.
- Apps must authenticate to interact with the Admin API.
- The Admin API enforces rate limits on all requests. Note that there are different rate-limiting methods for GraphQL and REST. All apps connecting to the Admin API are subject to Shopify’s API Terms of Service.
Operations
Retrieves an application charge
Retrieves a list of application charges
Creates an application charge
Retrieves a single application credit
Retrieves all application credits
Retrieves a list of all article authors
Retrieves a list of all article tags
Retrieves a list of fulfillment orders assigned to the shop locations that are owned by the app
Deletes an article
Receive a single Article
Updates an article
Retrieves a count of all articles from a blog
Retrieves a list of all articles from a blog
Creates an article for a blog
Retrieves a list of all article tags from a specific blog
Remove an existing Blog
Receive a single Blog
Modify an existing Blog
Receive a count of all Blogs
Retrieve a list of all blogs
Create a new Blog
Deletes a carrier service
Retrieves a single carrier service
Modify an existing CarrierService
Retrieves a list of carrier services
Creates a carrier service
Retrieves a count of checkouts
Retrieves a list of abandoned checkouts
Creates a checkout
Completes a checkout
Retrieves a checkout
Modifies an existing checkout
Counts the number of payments attempted on a checkout
Retrieves a list of payments on a particular checkout
Creates a new payment
Retrieves a single payment
Retrieves a list of shipping rates
Delete a collection listing to unpublish a collection from your app
Retrieve a specific collection listing that is published to your app
Create a collection listing to publish a collection to your app
Retrieve product_ids that are published to a collection_id
Retrieve collection listings that are published to your app
Retrieves a single collection
Retrieve a list of products belonging to a collection
Removes a product from a collection
Retrieves a specific collect by its ID
Retrieves a count of collects
Retrieves a list of collects
Adds a product to a custom collection
Approves a comment
Retrieves a single comment by its ID
Updates a comment of an article
Marks a comment as not spam
Removes a comment
Restores a previously removed comment
Marks a comment as spam
Retrieves a count of comments
Retrieves a list of comments
Creates a comment for an article
Retrieves a count of countries
Remove an existing Country
Retrieves a specific county
Updates an existing country
Retrieves a count of provinces for a country
Retrieves a list of provinces for a country
Retrieves a single province for a country
Updates an existing province for a country
Receive a list of all Countries
Creates a country
Retrieves a list of currencies enabled on a shop
Retrieves a count of custom collections
Deletes a custom collection
Retrieves a single custom collection
Updates an existing custom collection
Retrieves a list of custom collections
Creates a custom collection
Retrieves a count of customers
Creates an account activation URL for a customer
Sets the default address for a customer
Removes an address from a customer’s address list
Retrieves details for a single customer address
Updates an existing customer address
Retrieves a list of addresses for a customer
Creates a new address for a customer
Performs bulk operations for multiple customer addresses
Deletes a customer.
Retrieves a single customer
Updates a customer
Retrieves all orders belonging to a customer
Sends an account invite to a customer
Retrieves a list of customers
Creates a customer
Searches for customers that match a supplied query
Retrieves a count of discount codes for a shop
Retrieves the location of a discount code
Receive a count of all DraftOrders
Complete a draft order
Remove an existing DraftOrder
Receive a single DraftOrder
Modify an existing DraftOrder
Retrieves a list of draft orders
Create a new DraftOrder
Retrieves a count of events
Retrieves a single event
Retrieves a list of events
Cancel a fulfillment order
Accepts a cancellation request
Sends a cancellation request
Rejects a cancellation request
Marks a fulfillment order as incomplete
Accepts a fulfillment request
Sends a fulfillment request
Rejects a fulfillment request
Retrieves fulfillments associated with a fulfillment order
Applies a fulfillment hold on an open fulfillment order
Retrieves a specific fulfillment order
Retrieves a list of locations that a fulfillment order can potentially move to.
Moves a fulfillment order to a new location
Marks the fulfillment order as open
Releases the fulfillment hold on a fulfillment order
Reschedules the fulfill_at time of a scheduled fulfillment order
Sets deadline for fulfillment orders
Remove an existing FulfillmentService
Receive a single FulfillmentService
Modify an existing FulfillmentService
Receive a list of all FulfillmentServices
Create a new FulfillmentService
Cancels a fulfillment
Updates the tracking information for a fulfillment
Creates a fulfillment for one or many fulfillment orders
Retrieves a count of gift cards
Disables a gift card
Retrieves a single gift card
Updates an existing gift card
Retrieves a list of gift cards
Creates a gift card
Searches for gift cards
Retrieves a single inventory item by ID
Updates an existing inventory item
Retrieves a detailed list for inventory items by IDs
Adjusts the inventory level of an inventory item at a location
Connects an inventory item to a location
Deletes an inventory level from a location
Retrieves a list of inventory levels
Sets the inventory level for an inventory item at a location
Retrieves a count of locations
Retrieves a list of locations
Retrieves a list of inventory levels for a location.
Retrieves a single location by its ID
Retrieves a count of all marketing events
Retrieves a list of all marketing events
Creates a marketing event
Creates marketing engagements on a marketing event
Deletes a marketing event
Retrieves a single marketing event
Updates a marketing event
[Shop] Retrieve a count of a resource's metafields.
[Shop] Retrieve a list of metafields from the resource's endpoint
[Shop] Create a metafield
[Shop] Deletes a metafield by its ID.
[Shop] Retrieve a specific metafield
[Shop] Updates a metafield
List all of the mobile platform applications associated with the app
Create a mobile platform application
Update a mobile platform application Copy
Get a mobile platform application
Update a mobile platform application
Retrieves an order count
Retrieves a list of orders
Create an order
Close an order
Retrieves a list of fulfillment orders for a specific order
Retrieves a count of fulfillments associated with a specific order
Deletes a fulfillment event
Retrieves a specific fulfillment event
Retrieves a list of fulfillment events for a specific fulfillment
Creates a fulfillment event
Receive a single Fulfillment
Retrieves fulfillments associated with an order
Deletes an order
Retrieves a specific order
Updates an order
Re-open a closed order
Calculates a refund
Retrieves a list of refunds for an order
Creates a refund
Retrieves a specific refund
Retrieves a list of all order risks for an order
Creates an order risk for an order
Deletes an order risk for an order
Retrieves a single order risk by its ID
Updates an order risk
Retrieves a count of an order's transactions
Retrieves a list of transactions
Creates a transaction for an order
Retrieves a specific transaction
Retrieve a count of a resource's metafields.
Retrieve a list of metafields from the resource's endpoint
Create a metafield
Deletes a metafield by its ID
Retrieve a specific metafield
Retrieves a page count
Retrieves a list of pages
Create a new Page
Deletes a page
Retrieves a single page by its ID
Updates a page
Retrieves a list of the shop's policies
Retrieves a count of all price rules
Retrieves a list of price rules
Creates a price rule
Retrieves a list of discount codes for a discount code creation job
Retrieves a discount code creation job
Creates a discount code creation job
Retrieves a single discount code
Updates an existing discount code
Retrieves a list of discount codes
Creates a discount code
Remove an existing PriceRule
Retrieves a single price rule
Updates an existing a price rule
Retrieve a count of products that are published to your app
Retrieve product listings that are published to your app
Retrieve product_ids that are published to your app
Delete a product listing to unpublish a product from your app
Retrieve a specific product listing that is published to your app
Create a product listing to publish a product to your app
Retrieves a count of products
Retrieves a list of products
Creates a new product
Receive a count of all Product Images
Remove an existing Product Image
Receive a single Product Image
Modify an existing Product Image
Receive a list of all Product Images
Create a new Product Image
Deletes a product
Retrieves a single product
Updates a product
Receive a list of all Product ResourceFeedbacks
Create a new Product ResourceFeedback
Receive a count of all Product Variants
Retrieves a list of product variants
Create a new Product Variant
Remove an existing Product Variant
Retrieves a list of recurring application charges
Creates a recurring application charge
Updates the capped amount of a recurring application charge
DELETE /admin/api/{api_version}/recurring_application_charges/{recurring_application_charge_id}.json
Cancels a recurring application charge
Retrieves a single charge
Retrieves a list of usage charges
Retrieves a count of URL redirects
Retrieves a list of URL redirects
Creates a redirect
Deletes a redirect
Retrieves a single redirect
Updates an existing redirect
Retrieves a list of reports
Creates a new report
Deletes a report
Retrieves a single report
Updates a report
Receive a list of all ResourceFeedbacks
Create a new ResourceFeedback
Retrieves a count of all script tags
Retrieves a list of all script tags
Creates a new script tag
Deletes a script tag
Retrieves a single script tag
Updates a script tag
Receive a list of all ShippingZones
Retrieves the shop's configuration
Return the current balance
Return a list of all balance transactions
Returns evidence associated with the dispute
Returns evidence associated with the dispute Copy
Delete a dispute evidence file
Upload a file to a dispute
Return a single dispute
Return a list of all disputes
Return a list of all payouts
Return a single payout
Retrieves a count of smart collections
Retrieves a list of smart collections
Creates a smart collection
Removes a smart collection
Retrieves a single smart collection
Updates an existing smart collection
Updates the ordering type of products in a smart collection
Retrieves a list of storefront access tokens that have been issued
Creates a new StorefrontAccessToken
Deletes an existing storefront access token
Retrieves a list of tender transactions
Retrieves a list of themes
Creates a theme
Deletes an asset from a theme
Retrieves a list of assets for a theme
Creates or updates an asset for a theme
Remove an existing Theme
Retrieves a single theme
Modify an existing Theme
Retrieves the currently logged-in user
Retrieves a list of all users
Retrieves a single user
Receive a single Product Variant
Modify an existing Product Variant
Receive a count of all Webhooks
Retrieves a list of webhooks
Create a new Webhook
Remove an existing Webhook
Receive a single Webhook
Modify an existing Webhook
Get a list of access scopes