> [!WARNING]
> The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the [GraphQL Admin API](/docs/api/admin-graphql). For details and migration steps, visit our [migration guide](/docs/apps/build/graphql/migrate).

The Admin API lets you build apps and integrations that extend and enhance the Shopify admin.

Some newer platform features may only be available in [GraphQL](/api/admin-graphql).

## Client libraries

Use Shopify's officially supported libraries to build fast, reliable apps with the programming languages and frameworks you already know.

### Remix
The official package for Remix applications, with full TypeScript support.

- [Docs](/docs/api/shopify-app-remix)
- [npm package](https://www.npmjs.com/package/@shopify/shopify-app-remix)
- [GitHub repo](https://github.com/Shopify/shopify-app-js/tree/main/packages/apps/shopify-app-remix#readme)

```typescript
npm install --save @shopify/shopify-app-remix
# or
yarn add @shopify/shopify-app-remix
```

### Node.js
```javascript
npm install --save @shopify/shopify-api
# or
yarn add @shopify/shopify-api
```

### Ruby
```ruby
bundle add shopify_api
```

### Other Libraries
Additional client libraries may be available for other programming languages and frameworks.

## Authentication

All REST Admin API queries require a valid Shopify access token.

Public and custom apps created in the Partner Dashboard generate tokens using [OAuth](https://shopify.dev/apps/auth/oauth), and custom apps made in the Shopify admin are [authenticated in the Shopify admin](https://shopify.dev/apps/auth/admin-app-access-tokens). To simplify the authentication process, use one of the recommended Shopify client libraries.

Include your token as a `X-Shopify-Access-Token` header on all API queries. Using Shopify's supported [client libraries](https://shopify.dev/apps/tools/api-libraries) can simplify this process.

To keep the platform secure, apps need to request specific [access scopes](https://shopify.dev/api/usage/access-scopes) during the install process. Only request as much data access as your app needs to work.

Learn more about [getting started with authentication](https://shopify.dev/apps/auth) and [building apps](https://shopify.dev/apps/getting-started).

### Examples

#### Remix
```typescript
const { admin } = await authenticate.admin(request);
const response = admin.rest.get({path: 'shop'});
```

#### Node.js
```javascript
const Shopify = require('@shopify/shopify-api');

const client = new Shopify.Clients.Rest(shop, accessToken);
const response = await client.get({
  path: 'shop'
});
```

#### PHP
```php
$client = new Shopify\Clients\Rest($shop, $accessToken);
$response = $client->get(['path' => 'shop']);
```

#### Ruby
```ruby
client = ShopifyAPI::Clients::Rest.new(shop: shop, access_token: access_token)
response = client.get(path: 'shop')
```

#### cURL
```bash
curl -X GET "https://{shop}.myshopify.com/admin/api/2024-10/shop.json" \
  -H "X-Shopify-Access-Token: {access_token}"
```

## Endpoints and requests

Admin REST API endpoints are organized by resource type. You'll need to use different endpoints depending on your app's requirements.

All Admin REST API endpoints follow this pattern:

```
https://{store_name}.myshopify.com/admin/api/2024-10/{resource}.json
```

### Example POST request

```typescript
const { admin } = await authenticate.admin(request);
const response = await admin.rest.post({
  path: 'products',
  data: {
    product: {
      title: "Hiking backpack",
      body_html: "A comfortable backpack for hiking",
      vendor: "Outdoor Gear",
      product_type: "Backpack"
    }
  }
});
```

Response:
```json
HTTP/1.1 201 Created
{
  "product": {
    "id": 11235813213455,
    "title": "Hiking backpack",
    "body_html": "A comfortable backpack for hiking",
    "vendor": "Outdoor Gear",
    "product_type": "Backpack",
    "created_at": "2024-01-01T12:00:00-05:00",
    "updated_at": "2024-01-01T12:00:00-05:00"
  }
}
```

### Example GET request

```typescript
const productId = "11235813213455";

const { admin } = await authenticate.admin(request);
const product = await admin.rest.get({
  path: `products/${productId}`,
  query: {id: 1, title: "title"}
});
```

Response:
```json
HTTP/1.1 200 OK
{
  "product": {
    "id": 11235813213455,
    "title": "Hiking backpack"
  }
}
```

### Example PUT request

```typescript
const productId = "11235813213455";

const { admin } = await authenticate.admin(request);
const response = await admin.rest.put({
  path: `products/${productId}`,
  data: {
    product: {
      title: "Updated Hiking backpack",
      body_html: "An updated comfortable backpack for hiking"
    }
  }
});
```

Response:
```json
HTTP/1.1 200 OK
{
  "product": {
    "id": 11235813213455,
    "title": "Updated Hiking backpack",
    "body_html": "An updated comfortable backpack for hiking",
    "updated_at": "2024-01-01T12:30:00-05:00"
  }
}
```

### Example DELETE request

```typescript
const productId = "11235813213455";

const { admin } = await authenticate.admin(request);
const response = await admin.rest.delete({
  path: `products/${productId}`
});
```

Response:
```json
HTTP/1.1 200 OK
```

The Admin API is versioned, with new releases four times per year. To keep your app stable, make sure you specify a supported version in the URL. Learn more about [API versioning](/api/usage/versioning).

All REST endpoints support [cursor-based pagination](/api/usage/pagination-rest). All requests produce HTTP [response status codes](/api/usage/response-codes).

Learn more about [API usage](/api/usage).

## Rate limits

The REST Admin API supports a limit of 40 requests per app per store per minute. This allotment replenishes at a rate of 2 requests per second. The rate limit is increased by a factor of 10 for Shopify Plus stores.

---

### Usage limitations
REST Admin API supports a limit of **40 requests per app per store per minute**.

Past the limit, the API will return a `429 Too Many Requests` error.

All REST API responses include the `X-Shopify-Shop-Api-Call-Limit` header, which shows how many requests the client has made, and the total number allowed per minute.

A `429` response will also include a `Retry-After` header with the number of seconds to wait until retrying your query.

Example rate limit headers:
```
X-Shopify-Shop-Api-Call-Limit: 40/40
Retry-After: 2.0
```

Example rate limit response:
```json
HTTP/1.1 429 Too Many Requests
{
  "customers": [
    {
      "id": 207119551,
      "email": "bob.norman@hostmail.com",
      "accepts_marketing": false,
      "created_at": "2021-02-12T13:48:32-05:00",
      "updated_at": "2021-02-12T13:48:32-05:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "199.65",
      "last_order_id": 450789469,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "phone": "+16136120707",
      "tags": "",
      "last_order_name": "#1001",
      "currency": "USD",
      "addresses": [
        {
          "id": 207119551
        }
      ]
    }
  ]
}
```

Learn more about [rate limits](/api/usage/rate-limits#rest-admin-api-rate-limits).

## Status and error codes

All API queries return HTTP status codes that can tell you more about the response.

### 401 Unauthorized

The client doesn't have correct [authentication](#authentication) credentials.

Example:
```json
HTTP/1.1 401 Unauthorized
{
  "errors": "[API] Invalid API key or access token (unrecognized login or wrong password)"
}
```

### 402 Payment Required

The shop is frozen. The shop owner will need to pay the outstanding balance to [unfreeze](https://help.shopify.com/en/manual/your-account/pause-close-store#unfreeze-your-shopify-store) the shop.

Example:
```json
HTTP/1.1 402 Payment Required
{
  "errors": "Shop is frozen. Please pay the outstanding balance to unfreeze"
}
```

### 403 Forbidden

The server is refusing to respond. This is typically caused by incorrect [access scopes](/api/usage/access-scopes).

Example:
```json
HTTP/1.1 403 Forbidden
{
  "errors": "You do not have permission to access this resource"
}
```

### 404 Not Found

The requested resource was not found but could be available again in the future.

Example:
```json
HTTP/1.1 404 Not Found
{
  "errors": "Not Found"
}
```

### 422 Unprocessable Entity

The request body contains semantic errors. This is typically caused by incorrect formatting, omitting required fields, or logical errors such as initiating a checkout for an out-of-stock product.

Example:
```json
HTTP/1.1 422 Unprocessable Entity
{
  "errors": {
    "title": [
      "can't be blank"
    ],
    "product_type": [
      "is not included in the list"
    ]
  }
}
```

### 429 Too Many Requests

The client has exceeded the [rate limit](#rate-limits).

Example:
```json
HTTP/1.1 429 Too Many Requests
{
  "errors": "Exceeded 2 calls per second for api client. Reduce request rates to resume uninterrupted service."
}
```

Headers:
```
X-Shopify-Shop-Api-Call-Limit: 40/40
Retry-After: 2.0
```

### 5xx Errors

An internal error occurred in Shopify. Check out the [Shopify status page](https://www.shopifystatus.com) for more information.

Example:
```json
HTTP/1.1 500 Internal Server Error
{
  "errors": "An internal error occurred at Shopify"
}
```

WARNING: Didn't find the status code you're looking for? View the complete list of [API status response and error codes](/api/usage/response-codes).

## **2025-01** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/2025-01/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/2025-01/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/2025-01/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/2025-01/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/2025-01/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/2025-01/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/2025-01/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/2025-01/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/2025-01/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/2025-01/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/2025-01/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/2025-01/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/2025-01/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/2025-01/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/2025-01/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/2025-01/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/2025-01/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/2025-01/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/2025-01/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/2025-01/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/2025-01/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/2025-01/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/2025-01/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/2025-01/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/2025-01/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/2025-01/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/2025-01/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/2025-01/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/2025-01/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/2025-01/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/2025-01/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/2025-01/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/2025-01/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/2025-01/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/2025-01/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/2025-01/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/2025-01/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/2025-01/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/2025-01/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/2025-01/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/2025-01/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/2025-01/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/2025-01/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2025-01/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2025-01/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2025-01/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/2025-01/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/2025-01/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/2025-01/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-01/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/2025-01/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/2025-01/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/2025-01/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/2025-01/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/2025-01/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/2025-01/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/2025-01/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/2025-01/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/2025-01/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/2025-01/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/2025-01/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/2025-01/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/2025-01/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/2025-01/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/2025-01/resources/webhook.txt) - Retrieve and store event data using webhooks.

## **unstable** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/unstable/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/unstable/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/unstable/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/unstable/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/unstable/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/unstable/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/unstable/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/unstable/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/unstable/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/unstable/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/unstable/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/unstable/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [CustomerSavedSearch](https://shopify.dev/docs/api/admin-rest/unstable/resources/customersavedsearch.txt) - Add or update customer saved searches. Saved searches help merchants to organize their customers into groups that they can access quickly from their admin. They're also useful for specifying sets of customers, such as the customers that are eligible to use a certain discount code.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/unstable/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/unstable/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/unstable/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/unstable/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/unstable/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/unstable/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/unstable/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/unstable/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/unstable/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/unstable/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/unstable/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/unstable/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/unstable/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/unstable/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/unstable/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/unstable/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/unstable/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/unstable/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/unstable/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/unstable/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/unstable/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/unstable/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/unstable/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/unstable/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/unstable/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/unstable/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/unstable/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/unstable/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/unstable/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/unstable/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/unstable/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/unstable/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/unstable/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/unstable/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/unstable/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/unstable/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/unstable/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/unstable/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/unstable/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/unstable/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/unstable/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/unstable/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/unstable/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/unstable/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/unstable/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/unstable/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/unstable/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/unstable/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/unstable/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/unstable/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/unstable/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/unstable/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/unstable/resources/webhook.txt) - Retrieve and store event data using webhooks.

## **2025-04** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/2025-04/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/2025-04/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/2025-04/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/2025-04/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/2025-04/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/2025-04/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/2025-04/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/2025-04/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/2025-04/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/2025-04/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/2025-04/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/2025-04/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/2025-04/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/2025-04/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/2025-04/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/2025-04/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/2025-04/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/2025-04/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/2025-04/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/2025-04/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/2025-04/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/2025-04/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/2025-04/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/2025-04/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/2025-04/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/2025-04/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/2025-04/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/2025-04/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/2025-04/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/2025-04/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/2025-04/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/2025-04/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/2025-04/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/2025-04/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/2025-04/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/2025-04/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/2025-04/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/2025-04/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/2025-04/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/2025-04/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/2025-04/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/2025-04/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/2025-04/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2025-04/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2025-04/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2025-04/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/2025-04/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/2025-04/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/2025-04/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/2025-04/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/2025-04/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/2025-04/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/2025-04/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/2025-04/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/2025-04/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/2025-04/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/2025-04/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/2025-04/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/2025-04/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/2025-04/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/2025-04/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/2025-04/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/2025-04/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/2025-04/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/2025-04/resources/webhook.txt) - Retrieve and store event data using webhooks.

## **2024-10** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/2024-10/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/2024-10/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/2024-10/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/2024-10/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/2024-10/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/2024-10/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-10/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/2024-10/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-10/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/2024-10/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/2024-10/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/2024-10/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/2024-10/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/2024-10/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/2024-10/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/2024-10/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/2024-10/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/2024-10/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/2024-10/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/2024-10/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/2024-10/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/2024-10/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/2024-10/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/2024-10/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/2024-10/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/2024-10/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/2024-10/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/2024-10/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/2024-10/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/2024-10/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/2024-10/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/2024-10/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/2024-10/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/2024-10/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/2024-10/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/2024-10/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/2024-10/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/2024-10/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/2024-10/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/2024-10/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/2024-10/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/2024-10/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/2024-10/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-10/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-10/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2024-10/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/2024-10/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/2024-10/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/2024-10/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-10/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/2024-10/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/2024-10/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/2024-10/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/2024-10/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/2024-10/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/2024-10/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/2024-10/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/2024-10/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/2024-10/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/2024-10/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/2024-10/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/2024-10/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/2024-10/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/2024-10/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/2024-10/resources/webhook.txt) - Retrieve and store event data using webhooks.

## **2024-07** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/2024-07/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/2024-07/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/2024-07/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/2024-07/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/2024-07/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/2024-07/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-07/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/2024-07/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-07/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/2024-07/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/2024-07/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/2024-07/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/2024-07/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/2024-07/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/2024-07/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/2024-07/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/2024-07/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/2024-07/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/2024-07/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/2024-07/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/2024-07/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/2024-07/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/2024-07/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/2024-07/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/2024-07/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/2024-07/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/2024-07/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/2024-07/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/2024-07/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/2024-07/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/2024-07/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/2024-07/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/2024-07/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/2024-07/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/2024-07/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/2024-07/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/2024-07/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/2024-07/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/2024-07/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/2024-07/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/2024-07/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/2024-07/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/2024-07/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-07/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-07/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2024-07/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/2024-07/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/2024-07/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/2024-07/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/2024-07/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/2024-07/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/2024-07/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/2024-07/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/2024-07/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/2024-07/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/2024-07/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/2024-07/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/2024-07/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/2024-07/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/2024-07/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/2024-07/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/2024-07/resources/webhook.txt) - Retrieve and store event data using webhooks.

## **2024-04** API Reference

- [Deprecated API calls](https://shopify.dev/docs/api/admin-rest/2024-04/resources/deprecated-api-calls.txt) - Retrieve deprecated API calls made by the authenticated custom app in the past 30 days.
- [MarketingEvent](https://shopify.dev/docs/api/admin-rest/2024-04/resources/marketingevent.txt) - Create or update marketing events to track activity associated with a merchant's marketing campaigns.
- [Metafield](https://shopify.dev/docs/api/admin-rest/2024-04/resources/metafield.txt) - Add metafields to store resources.
- [TenderTransaction](https://shopify.dev/docs/api/admin-rest/2024-04/resources/tendertransaction.txt) - Retrieve tender transactions for your shop. Tender transactions represent transactions that modify the shop's balance.
- [AccessScope](https://shopify.dev/docs/api/admin-rest/2024-04/resources/accessscope.txt) - View the access scopes approved by merchants during installation of your app.
- [StorefrontAccessToken](https://shopify.dev/docs/api/admin-rest/2024-04/resources/storefrontaccesstoken.txt) - Generate a storefront access token to access the Storefront API.
- [ApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-04/resources/applicationcharge.txt) - Charge a shop a one-time fee by creating an application charge.
- [ApplicationCredit](https://shopify.dev/docs/api/admin-rest/2024-04/resources/applicationcredit.txt) - Request to create an application credit for a particular shop.
- [RecurringApplicationCharge](https://shopify.dev/docs/api/admin-rest/2024-04/resources/recurringapplicationcharge.txt) - Charge a shop a subscription fee         to use your app. Charged every 30 days.
- [UsageCharge](https://shopify.dev/docs/api/admin-rest/2024-04/resources/usagecharge.txt) - Charge varying amounts based on the monthly usage of your app.
- [Customer Address](https://shopify.dev/docs/api/admin-rest/2024-04/resources/customer-address.txt) - 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.
- [Customer](https://shopify.dev/docs/api/admin-rest/2024-04/resources/customer.txt) - Add or update information about a store's customers, including their addresses and whether they have an active customer account with the store.
- [DiscountCode](https://shopify.dev/docs/api/admin-rest/2024-04/resources/discountcode.txt) - 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.
- [PriceRule](https://shopify.dev/docs/api/admin-rest/2024-04/resources/pricerule.txt) - 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.
- [Event](https://shopify.dev/docs/api/admin-rest/2024-04/resources/event.txt) - 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.
- [Gift Card](https://shopify.dev/docs/api/admin-rest/2024-04/resources/gift-card.txt) - Create and manage gift card codes, which can be entered at checkout to pay using a gift card.
- [InventoryItem](https://shopify.dev/docs/api/admin-rest/2024-04/resources/inventoryitem.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/inventorylevel.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/location.txt) - 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.
- [MobilePlatformApplication](https://shopify.dev/docs/api/admin-rest/2024-04/resources/mobileplatformapplication.txt) - 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.
- [Article](https://shopify.dev/docs/api/admin-rest/2024-04/resources/article.txt) - Manage a store's articles. Each article belongs to a blog and can have many comments.
- [Asset](https://shopify.dev/docs/api/admin-rest/2024-04/resources/asset.txt) - Manage the files that make up a store's theme to change the look of the online store.
- [Blog](https://shopify.dev/docs/api/admin-rest/2024-04/resources/blog.txt) - 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.
- [Comment](https://shopify.dev/docs/api/admin-rest/2024-04/resources/comment.txt) - 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.
- [Page](https://shopify.dev/docs/api/admin-rest/2024-04/resources/page.txt) - Create and update static pages for an online store.
- [Redirect](https://shopify.dev/docs/api/admin-rest/2024-04/resources/redirect.txt) - Manage 301 redirects for a merchant's online store.
- [ScriptTag](https://shopify.dev/docs/api/admin-rest/2024-04/resources/scripttag.txt) - Load remote JavaScript into the storefront and order status pages of an online store to add functionality without modifying the store's theme files.
- [Theme](https://shopify.dev/docs/api/admin-rest/2024-04/resources/theme.txt) - 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.
- [Abandoned checkouts](https://shopify.dev/docs/api/admin-rest/2024-04/resources/abandoned-checkouts.txt) - Retrieve a list of incomplete checkouts. Each Checkout object includes a URL to the online checkout, where the customer can complete their purchase.
- [DraftOrder](https://shopify.dev/docs/api/admin-rest/2024-04/resources/draftorder.txt) - 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.
- [Order Risk](https://shopify.dev/docs/api/admin-rest/2024-04/resources/order-risk.txt) - Display a fraud analysis and recommendations on the details page of an order.
- [Order](https://shopify.dev/docs/api/admin-rest/2024-04/resources/order.txt) - 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.
- [Refund](https://shopify.dev/docs/api/admin-rest/2024-04/resources/refund.txt) - 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.
- [Transaction](https://shopify.dev/docs/api/admin-rest/2024-04/resources/transaction.txt) - Create and retrieve transactions for an order. Transactions are created for every order that results in an exchange of money.
- [User](https://shopify.dev/docs/api/admin-rest/2024-04/resources/user.txt) - Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify.
- [Collect](https://shopify.dev/docs/api/admin-rest/2024-04/resources/collect.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/collection.txt) - Manage a store's collections. A collectionis a grouping of products that merchants can create to make their stores  easier to browse.
- [CustomCollection](https://shopify.dev/docs/api/admin-rest/2024-04/resources/customcollection.txt) - 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.
- [Product Image](https://shopify.dev/docs/api/admin-rest/2024-04/resources/product-image.txt) - Add or update a store's product images, which sales channels use to display the products to shoppers.
- [Product Variant](https://shopify.dev/docs/api/admin-rest/2024-04/resources/product-variant.txt) - 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.
- [Product](https://shopify.dev/docs/api/admin-rest/2024-04/resources/product.txt) - Manage a store's products, which are the individual items and services for sale in the store.
- [SmartCollection](https://shopify.dev/docs/api/admin-rest/2024-04/resources/smartcollection.txt) - Create or update smart collections by defining selection conditions. Products that match the conditions are included in the collection automatically.
- [Checkout](https://shopify.dev/docs/api/admin-rest/2024-04/resources/checkout.txt) - Create and update checkouts to provide a custom checkout experience for your sales channel.
- [CollectionListing](https://shopify.dev/docs/api/admin-rest/2024-04/resources/collectionlisting.txt) - Manage the collections that are published to your sales channel and retrieve their information.
- [Payment](https://shopify.dev/docs/api/admin-rest/2024-04/resources/payment.txt) - Create and update payments to provide a custom checkout experience for your sales channel.
- [ProductListing](https://shopify.dev/docs/api/admin-rest/2024-04/resources/productlisting.txt) - Manage the products that are available to your sales channel and retrieve their information.
- [Product ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-04/resources/product-resourcefeedback.txt) - Product resource feedback allows you to communicate the state of a shop's individual products, as it pertains to your application.
- [ResourceFeedback](https://shopify.dev/docs/api/admin-rest/2024-04/resources/resourcefeedback.txt) - Notify merchants about actions required to resolve errors with your app.
- [AssignedFulfillmentOrder](https://shopify.dev/docs/api/admin-rest/2024-04/resources/assignedfulfillmentorder.txt) - View the fulfillment orders of a shop that are assigned to your app.
- [CancellationRequest](https://shopify.dev/docs/api/admin-rest/2024-04/resources/cancellationrequest.txt) - Manage the cancellation request flow of fulfillment orders assigned to fulfillment services.
- [CarrierService](https://shopify.dev/docs/api/admin-rest/2024-04/resources/carrierservice.txt) - Provide real-time shipping calculations before checkout with your custom shipping service.
- [Fulfillment](https://shopify.dev/docs/api/admin-rest/2024-04/resources/fulfillment.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/fulfillmentevent.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/fulfillmentorder.txt) - 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](https://shopify.dev/docs/api/admin-rest/2024-04/resources/fulfillmentrequest.txt) - Manage the fulfillment request flow of fulfillment orders assigned to fulfillment services.
- [FulfillmentService](https://shopify.dev/docs/api/admin-rest/2024-04/resources/fulfillmentservice.txt) - 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.
- [LocationsForMove](https://shopify.dev/docs/api/admin-rest/2024-04/resources/locationsformove.txt) - View the locations that a fulfillment order can potentially move to.
- [Balance](https://shopify.dev/docs/api/admin-rest/2024-04/resources/balance.txt) - View the current balance for a Shopify Payments account
- [Dispute](https://shopify.dev/docs/api/admin-rest/2024-04/resources/dispute.txt) - Get information regarding Shopify Payments disputes.
- [Payouts](https://shopify.dev/docs/api/admin-rest/2024-04/resources/payouts.txt) - Get information regarding Shopify Payments payouts.
- [Transactions](https://shopify.dev/docs/api/admin-rest/2024-04/resources/transactions.txt) - Get information regarding Shopify Payments balance transactions.
- [Dispute Evidence](https://shopify.dev/docs/api/admin-rest/2024-04/resources/dispute-evidence.txt) - Get information regarding Shopify Payments dispute evidences.
- [Dispute File Upload](https://shopify.dev/docs/api/admin-rest/2024-04/resources/dispute-file-upload.txt) - Upload dispute evidence files for a dispute.
- [Country](https://shopify.dev/docs/api/admin-rest/2024-04/resources/country.txt) - Manage the country and provincial tax rates that are applied to applicable items at checkout.
- [Currency](https://shopify.dev/docs/api/admin-rest/2024-04/resources/currency.txt) - Retrieve a list of enabled currencies and the time when their conversion rate was last updated.
- [Policy](https://shopify.dev/docs/api/admin-rest/2024-04/resources/policy.txt) - Retrieve a list of a shop's policies, such as their refund policy, privacy policy, or terms of service.
- [Province](https://shopify.dev/docs/api/admin-rest/2024-04/resources/province.txt) - Manage the tax rates that are applied to orders from a specific province or state.
- [ShippingZone](https://shopify.dev/docs/api/admin-rest/2024-04/resources/shippingzone.txt) - Retrieve the shipping zones that a merchant has set up from their Shopify admin. Each Shipping Zone object includes the countries and provinces added to the shipping zone, as well as the tax rates and shipping rates that are set up.
- [Shop](https://shopify.dev/docs/api/admin-rest/2024-04/resources/shop.txt) - Access a store's general settings and information as configured by the merchant in their Shopify admin.
- [Webhook](https://shopify.dev/docs/api/admin-rest/2024-04/resources/webhook.txt) - Retrieve and store event data using webhooks.