Shopify Admin API

https://shopify.dev/docs/api/admin
Admin
The Shopify Admin API is a GraphQL API that allows developers to build apps and integrations to...
Tokens:2,042,733
Snippets:32,597
Trust Score:9.5
Update:2 hours ago
Show doc for...
Tokens:
Raw
### QueryRoot.appInstallation

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/QueryRoot

Retrieves an AppInstallation by ID. If no ID is provided, returns the installation for the currently authenticated App. Provides essential data for validating installation state and managing app functionality.

```APIDOC
## QueryRoot.appInstallation

### Description
Retrieves an AppInstallation by ID. If no ID is provided, returns the installation for the currently authenticated App. Provides essential data for validating installation state and managing app functionality.

### Type
AppInstallation

### Arguments
- **id** (ID) - Optional - ID used to lookup AppInstallation.

### Example
```graphql
query {
  appInstallation(id: "gid://shopify/AppInstallation/123") {
    id
  }
}
```
```

--------------------------------

### QueryRoot.app

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/QueryRoot

Retrieves an `App` by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information. If the app isn't installed on the current shop, then the `installation` field will be `null`.

```APIDOC
## QueryRoot.app

### Description
Retrieves an `App` by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information. If the app isn't installed on the current shop, then the `installation` field will be `null`.

### Type
App

### Arguments
#### Optional Arguments
- **id** (ID) - Optional - The ID to lookup the App by.

### Example
```graphql
query {
  app(id: "gid://shopify/App/123") {
    title
  }
}
```
```

--------------------------------

### appInstallation

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation

Retrieves an AppInstallation by ID. If no ID is provided, returns the installation for the currently authenticated App. Provides essential data for validating installation state and managing app functionality.

```APIDOC
## appInstallation

### Description
Retrieves an `AppInstallation` by ID. If no ID is provided, returns the installation for the currently authenticated `App`. The query provides essential data for validating installation state and managing app functionality within a store.

### Type
query

### Arguments
- **id** (ID) - Optional - ID used to lookup AppInstallation.

### Returns
- **AppInstallation** - The AppInstallation object.
```

--------------------------------

### productCreate

Source: https://shopify.dev/docs/apps/build/product-merchandising/products-and-collections/metafield-linked

Creates a product with basic options. The example creates a T-shirt with a Size option and assigns a taxonomy category.

```APIDOC
## POST https://{shop}.myshopify.com/api/{api_version}/graphql.json

### Description
Creates a product with basic options. The example creates a T-shirt with a Size option and assigns a taxonomy category.

### Method
POST

### Endpoint
https://{shop}.myshopify.com/api/{api_version}/graphql.json

### GraphQL Mutation
```graphql
mutation CreateProduct {
  productCreate(product: {
    title: "T-Shirt",
    category: "gid://shopify/TaxonomyCategory/aa-1-13-7",
    productOptions: [
      {
        name: "Size",
        values: [
          { name: "Small" },
          { name: "Medium" }
        ]
      }
    ]
  }) {
    product {
      id
      title
      options {
        id
        name
        optionValues {
          id
          name
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}
```

### JSON Response
```json
{
  "data": {
    "productCreate": {
      "product": {
        "id": "gid://shopify/Product/456",
        "title": "T-Shirt",
        "options": [
          {
            "id": "gid://shopify/ProductOption/101",
            "name": "Size",
            "optionValues": [
              {
                "id": "gid://shopify/ProductOptionValue/1",
                "name": "Small"
              },
              {
                "id": "gid://shopify/ProductOptionValue/2",
                "name": "Medium"
              }
            ]
          }
        ]
      },
      "userErrors": []
    }
  }
}
```
```

--------------------------------

### appInstallations

Source: https://shopify.dev/docs/api/admin-graphql/latest/connections/AppInstallationConnection

A paginated list of AppInstallation objects across multiple stores where your app is installed. Use this query to monitor installation status, track billing and subscriptions through AppSubscription objects, and review granted AccessScope objects.

```APIDOC
## appInstallations

### Description
A paginated list of `AppInstallation` objects across multiple stores where your app is installed. Use this query to monitor installation status, track billing and subscriptions through `AppSubscription` objects, and review granted `AccessScope` objects.

### Type
query

### Arguments
#### after
- **Type**: String
- **Description**: The elements that come after the specified cursor.

#### before
- **Type**: String
- **Description**: The elements that come before the specified cursor.

#### category
- **Type**: AppInstallationCategory
- **Description**: The category of app installations to fetch.

#### first
- **Type**: Int
- **Description**: The first `n` elements from the paginated list.

#### last
- **Type**: Int
- **Description**: The last `n` elements from the paginated list.

#### privacy
- **Type**: AppInstallationPrivacy
- **Default**: PUBLIC
- **Description**: The privacy level of app installations to fetch.

#### reverse
- **Type**: Boolean
- **Default**: false
- **Description**: Reverse the order of the underlying list.

#### sortKey
- **Type**: AppInstallationSortKeys
- **Default**: INSTALLED_AT
- **Description**: Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

### Returns
#### edges
- **Type**: [AppInstallationEdge!]!
- **Description**: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

#### nodes
- **Type**: [AppInstallation!]!
- **Description**: A list of nodes that are contained in AppInstallationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

#### pageInfo
- **Type**: PageInfo!
- **Description**: An object that’s used to retrieve cursor information about the current page.
```

--------------------------------

### Query app

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/App

Retrieves an App by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information. If the app isn't installed on the current shop, the installation field will be null.

```APIDOC
## Query app

### Description
Retrieves an `App` by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information. If the app isn't installed on the current shop, the `installation` field will be `null`.

### Method
query

### Endpoint
app

### Parameters
#### Arguments
- **id** (ID) - Optional - The ID to lookup the App by.

### Response
Returns an `App` object.
```

--------------------------------

### webPresenceCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/mutations/webPresenceCreate

Creates a web presence. Requires read_markets for queries and both read_markets and write_markets for mutations.

```APIDOC
## webPresenceCreate

### Description
Creates a web presence.

### Mutation
webPresenceCreate

### Arguments
- input (WebPresenceCreateInput!) - required - The details of the web presence to be created.

### Returns
- userErrors ([MarketUserError!]!) - non-null - The list of errors that occurred from executing the mutation.
- webPresence (MarketWebPresence) - The created web presence object.

### Permissions
Requires `read_markets` for queries and both `read_markets` as well as `write_markets` for mutations.
```

--------------------------------

### Install Shopify API gem for Ruby

Source: https://shopify.dev/docs/api/admin-graphql/latest

Install the official Shopify API client for Ruby using Bundler.

```ruby
bundle add shopify_api
```

--------------------------------

### Install Shopify API client for Node.js

Source: https://shopify.dev/docs/api/admin-graphql/latest

Install the official Shopify API client for Node.js using npm or yarn.

```ts
npm install --save @shopify/shopify-api
# or
yarn add @shopify/shopify-api
```

--------------------------------

### GET <callbackUrl>/fetch_tracking_numbers

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService

Shopify sends GET requests to this endpoint to retrieve tracking numbers for orders if trackingSupport is set to true.

```APIDOC
## GET <callbackUrl>/fetch_tracking_numbers

### Description
Shopify sends GET requests to this endpoint to retrieve tracking numbers for orders if trackingSupport is set to true.

### Method
GET

### Endpoint
<callbackUrl>/fetch_tracking_numbers

### Parameters
#### Path Parameters
- **callbackUrl** (String) - Required - The common prefix supplied in the fulfillmentServiceCreate mutation.

### Response
#### Success Response
No response schema documented.

```

--------------------------------

### bulkOperationCancel

Source: https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkOperationCancel

Starts the cancelation process of a running bulk operation. There may be a short delay from when a cancelation starts until the operation is actually canceled.

```APIDOC
## bulkOperationCancel

### Description
Starts the cancelation process of a running bulk operation. There may be a short delay from when a cancelation starts until the operation is actually canceled.

### Type
mutation

### Arguments
- **id** (ID!) - required - The ID of the bulk operation to cancel.

### Returns
- **bulkOperation** (BulkOperation) - The bulk operation to be canceled.
- **userErrors** ([UserError!]!) - non-null - The list of errors that occurred from executing the mutation.
```

--------------------------------

### marketWebPresenceCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/mutations/marketWebPresenceCreate

Creates a web presence for a market. Deprecated; use webPresenceCreate instead. Requires read_markets for queries and both read_markets and write_markets for mutations.

```APIDOC
## marketWebPresenceCreate

### Description
Creates a web presence for a market. This mutation is deprecated; use webPresenceCreate instead.

### Mutation
marketWebPresenceCreate

### Arguments
- **marketId** (ID!) - Required - The ID of the market for which to create a web presence.
- **webPresence** (MarketWebPresenceCreateInput!) - Required - The details of the web presence to be created.

### Returns
- **market** (Market) - The market object.
- **userErrors** ([MarketUserError!]!) - The list of errors that occurred from executing the mutation.

### Access Scopes
Requires `read_markets` for queries and both `read_markets` and `write_markets` for mutations.
```

--------------------------------

### productCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/Product

Creates a new product.

```APIDOC
## productCreate

### Description
Creates a new product.

### Method
mutation

### Arguments
- **input** (ProductCreateInput!) - The input for the product.

### Response
Returns a `ProductCreatePayload`.
```

--------------------------------

### Install Shopify CLI and initialize app (React Router)

Source: https://shopify.dev/docs/api/admin-graphql/latest

Install the Shopify CLI globally and initialize a new app for React Router development.

```bash
npm install -g @shopify/cli@latest
shopify app init
```

--------------------------------

### GET <callbackUrl>/fetch_stock

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService

Shopify sends GET requests to this endpoint to retrieve on hand inventory levels for the fulfillment service location if inventoryManagement is set to true.

```APIDOC
## GET <callbackUrl>/fetch_stock

### Description
Shopify sends GET requests to this endpoint to retrieve on hand inventory levels for the fulfillment service location if inventoryManagement is set to true.

### Method
GET

### Endpoint
<callbackUrl>/fetch_stock

### Parameters
#### Path Parameters
- **callbackUrl** (String) - Required - The common prefix supplied in the fulfillmentServiceCreate mutation.

### Response
#### Success Response
No response schema documented.

```

--------------------------------

### DiscountProducts.products

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountProducts

Returns the list of products that the discount can have as a prerequisite or to which the discount can be applied. Supports pagination arguments.

```APIDOC
## DiscountProducts.products

### Description
The list of products that the discount can have as a prerequisite or the list of products to which the discount can be applied.

### Type
ProductConnection! (non-null)

### Arguments
- **after** (String) - Optional - The elements that come after the specified cursor.
- **before** (String) - Optional - The elements that come before the specified cursor.
- **first** (Int) - Optional - The first `n` elements from the paginated list.
- **last** (Int) - Optional - The last `n` elements from the paginated list.
- **reverse** (Boolean) - Optional - Default: false - Reverse the order of the underlying list.

### Access Scope
Requires `read_discounts` access scope.
```

--------------------------------

### Example response JSON for carrier service rates

Source: https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node

Example JSON response object with a rates array containing three shipping rate objects. Includes fields like service_name, service_code, total_price, currency, delivery dates, and an optional metafields array. The example shows rates from canadapost-overnight, fedex-2dayground, and fedex-priorityovernight.

```json
{
"rates": [
{
"service_name": "canadapost-overnight",
"service_code": "ON",
"total_price": "1295",
"description": "This is the fastest option by far",
"currency": "CAD",
"min_delivery_date": "2013-04-12 14:48:45 -0400",
"max_delivery_date": "2013-04-12 14:48:45 -0400"
},
{
"service_name": "fedex-2dayground",
"service_code": "2D",
"total_price": "2934",
"currency": "USD",
"min_delivery_date": "2013-04-12 14:48:45 -0400",
"max_delivery_date": "2013-04-12 14:48:45 -0400"
},
{
"service_name": "fedex-priorityovernight",
"service_code": "1D",
"total_price": "3587",
"currency": "USD",
"min_delivery_date": "2013-04-12 14:48:45 -0400",
"max_delivery_date": "2013-04-12 14:48:45 -0400",
"metafields": [
{
"key": "tracking_url",
"value": "abc123",
"namespace": "carrier_service_metadata",
"type": "single_line_text_field"
}
]
}
]
}
```

--------------------------------

### QueryRoot.appInstallations

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/QueryRoot

Returns a paginated list of AppInstallation objects across multiple stores where your app is installed. Supports filtering by category and privacy, and sorting.

```APIDOC
## QueryRoot.appInstallations

### Description
Returns a paginated list of AppInstallation objects across multiple stores where your app is installed. Supports filtering by category and privacy, and sorting.

### Type
AppInstallationConnection!

### Arguments
- **after** (String) - Optional - The elements that come after the specified cursor.
- **before** (String) - Optional - The elements that come before the specified cursor.
- **category** (AppInstallationCategory) - Optional - The category of app installations to fetch.
- **first** (Int) - Optional - The first `n` elements from the paginated list.
- **last** (Int) - Optional - The last `n` elements from the paginated list.
- **privacy** (AppInstallationPrivacy) - Optional - The privacy level of app installations to fetch. Default: PUBLIC.
- **reverse** (Boolean) - Optional - Reverse the order of the underlying list. Default: false.
- **sortKey** (AppInstallationSortKeys) - Optional - Sort the underlying list using a key. Default: INSTALLED_AT.

### Example
```graphql
query {
  appInstallations(first: 10, privacy: PUBLIC) {
    edges {
      node {
        id
      }
    }
  }
}
```
```

--------------------------------

### blogCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/mutations/blogCreate

Creates a new blog within a shop. Requires any of write_content or write_online_store_pages access scopes. The mutation validates blog settings and establishes the structure for article publishing.

```APIDOC
## blogCreate

### Description
Creates a new blog within a shop, establishing a container for organizing articles. For example, a fitness equipment retailer launching a wellness blog would use this mutation to create the blog, enabling them to publish workout guides and nutrition tips.

### Access Scopes
Requires any of `write_content`, `write_online_store_pages` access scopes.

### Type
mutation

### Arguments
- **blog** (BlogCreateInput!) - required - The properties of the new blog.

### Returns
- **blog** (Blog) - The blog that was created.
- **userErrors** ([BlogCreateUserError!]!) - non-null - The list of errors that occurred from executing the mutation.
```

--------------------------------

### currentAppInstallation Query

Source: https://shopify.dev/docs/api/admin-graphql/latest/queries/currentAppInstallation

The currentAppInstallation query returns details about the current app installation. It includes fields for revenue attribution records, uninstall URL, and deprecated fields. Pagination arguments are available for list fields.

```APIDOC
## currentAppInstallation Query

### Description
The `currentAppInstallation` query returns information about the current app installation. It provides access to revenue attribution records, the uninstall URL, and deprecated fields such as channel, publication, and subscriptions.

### Fields

#### revenueAttributionRecords
- **Type**: `AppRevenueAttributionRecordConnection!` (non-null)
- **Description**: The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.

##### Arguments
- **after** (String) - Optional - The elements that come after the specified cursor.
- **before** (String) - Optional - The elements that come before the specified cursor.
- **first** (Int) - Optional - The first `n` elements from the paginated list.
- **last** (Int) - Optional - The last `n` elements from the paginated list.
- **reverse** (Boolean) - Optional - Default: `false` - Reverse the order of the underlying list.
- **sortKey** (AppRevenueAttributionRecordSortKeys) - Optional - Default: `CREATED_AT` - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

#### uninstallUrl
- **Type**: `URL`
- **Description**: The URL to uninstall the application.

#### channel (Deprecated)
- **Type**: `Channel`
- **Description**: Deprecated. Use other fields instead.

#### publication (Deprecated)
- **Type**: `Publication`
- **Description**: Deprecated. Use other fields instead.

#### subscriptions (Deprecated)
- **Type**: `[AppSubscription!]!` (non-null)
- **Description**: Deprecated. Use other fields instead.

### Example Query
```graphql
query {
  currentAppInstallation {
    revenueAttributionRecords(first: 10) {
      edges {
        node {
          # fields
        }
      }
    }
    uninstallUrl
  }
}
```

```

--------------------------------

### Abandonment.visitStartedAt

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/Abandonment

The date and time when the visit started.

```APIDOC
## Field visitStartedAt

### Description
The date and time when the visit started.

### Type
DateTime

```

--------------------------------

### Product

Source: https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node

The `Product` object lets you manage products in a merchant’s store.

```APIDOC
## Product

### Description
The `Product` object lets you manage products in a merchant’s store.

### Type
OBJECT

### Fields
- **id** (ID!) - The ID of the product.
- **title** (String!) - The title of the product.
- **description** (String!) - The description of the product.
- **price** (Money!) - The price of the product.
- **images** ([Image!]!) - The images associated with the product.
- **options** ([ProductOption!]!) - The options for the product.
- **variants** ([ProductVariant!]!) - The variants of the product.
- **media** ([Media!]!) - The media associated with the product.
- **collections** ([Collection!]!) - The collections that include this product.

### Notes
Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.
```

--------------------------------

### AppInstallation

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation

The AppInstallation object provides fields to access access scopes, subscriptions, metafields, and URLs for an installed app. Fields with arguments support pagination and filtering.

```APIDOC
## AppInstallation

### Description
An app installed on a shop. Each installation tracks the permissions granted to the app through `AccessScope` objects, along with billing subscriptions and `Metafield` objects.

### Fields

#### accessScopes
- Type: `[AccessScope!]!` (non-null)
- Description: The access scopes granted to the application by a merchant during installation.

#### activeSubscriptions
- Type: `[AppSubscription!]!` (non-null)
- Description: The active application subscriptions billed to the shop on a recurring basis.

#### allSubscriptions
- Type: `AppSubscriptionConnection!` (non-null)
- Description: All subscriptions created for a shop.
- Arguments:
  - `after` (String) - The elements that come after the specified cursor.
  - `before` (String) - The elements that come before the specified cursor.
  - `first` (Int) - The first `n` elements from the paginated list.
  - `last` (Int) - The last `n` elements from the paginated list.
  - `reverse` (Boolean, default: `false`) - Reverse the order of the underlying list.
  - `sortKey` (AppSubscriptionSortKeys, default: `CREATED_AT`) - Sort the underlying list using a key.

#### app
- Type: `App!` (non-null)
- Description: Application which is installed.

#### credits
- Type: `AppCreditConnection!` (non-null)
- Description: Credits that can be used towards future app purchases.
- Arguments:
  - `after` (String) - The elements that come after the specified cursor.
  - `before` (String) - The elements that come before the specified cursor.
  - `first` (Int) - The first `n` elements from the paginated list.
  - `last` (Int) - The last `n` elements from the paginated list.
  - `reverse` (Boolean, default: `false`) - Reverse the order of the underlying list.
  - `sortKey` (AppTransactionSortKeys, default: `CREATED_AT`) - Sort the underlying list using a key.

#### id
- Type: `ID!` (non-null)
- Description: A globally-unique ID.

#### launchUrl
- Type: `URL!` (non-null)
- Description: The URL to launch the application.

#### metafield
- Type: `Metafield`
- Description: A custom field, including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
- Arguments:
  - `key` (String!, required) - The key for the metafield.
  - `namespace` (String) - The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

#### metafields
- Type: `MetafieldConnection!` (non-null)
- Description: A list of custom fields that a merchant associates with a Shopify resource.
- Arguments:
  - `after` (String) - The elements that come after the specified cursor.
  - `before` (String) - The elements that come before the specified cursor.
  - `first` (Int) - The first `n` elements from the paginated list.
  - `keys` ([String!]) - List of keys of metafields in the format `namespace.key`, will be returned in the same format.
  - `last` (Int) - The last `n` elements from the paginated list.
  - `namespace` (String) - The metafield namespace to filter by. If omitted, all metafields are returned.
  - `reverse` (Boolean, default: `false`) - Reverse the order of the underlying list.

#### oneTimePurchases
- Type: `AppPurchaseOneTimeConnection!` (non-null)
- Description: One-time purchases to a shop.

#### revenueAttributionRecords
- Type: `AppRevenueAttributionRecordConnection!` (non-null)
- Description: Revenue attribution records for the app.

#### uninstallUrl
- Type: `URL`
- Description: The URL to uninstall the application.
```

--------------------------------

### AppInstallation.subscriptions (Deprecated)

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation

Retrieves the subscriptions for the app installation. This field is deprecated.

```APIDOC
## subscriptions

### Description
Subscriptions (Deprecated)

### Type
[AppSubscription!]! (non-null)

### Deprecated
This field is deprecated.

```

--------------------------------

### productCreateMedia

Source: https://shopify.dev/docs/api/admin-graphql/latest/mutations/productCreateMedia

Adds media files to a product. Requires write_products access scope and permission to create media. Deprecated; use productUpdate or productSet instead.

```APIDOC
## productCreateMedia

### Description
Adds media files to a `Product`, such as images, videos, or 3D models. Media files enhance product listings by providing visual representations that help customers understand the product. The mutation accepts an array of `CreateMediaInput` objects, each specifying the source URL, content type, and optional alt text. You can add multiple media files in a single request. The mutation adds all valid files and returns errors for any invalid ones.

### Method
mutation

### Endpoint
productCreateMedia

### Arguments
- **media** ([CreateMediaInput!]!) - required - List of new media to be added to a product.
- **productId** (ID!) - required - Specifies the product associated with the media.

### Returns
- **media** ([Media!]) - The newly created media.
- **mediaUserErrors** ([MediaUserError!]!) - non-null - The list of errors that occurred from executing the mutation.
- **product** (Product) - The product associated with the media.
- **userErrors** ([UserError!]!) - non-null - Deprecated - The list of errors that occurred from executing the mutation.
```

--------------------------------

### PointOfSaleDevice

Source: https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node

Represents a mobile device that Shopify Point of Sale has been installed on.

```APIDOC
## PointOfSaleDevice

### Description
Represents a mobile device that Shopify Point of Sale has been installed on.

### Type
OBJECT

### Fields
- **id** (ID!) - The ID of the device.
- **name** (String!) - The name of the device.
- **deviceType** (PointOfSaleDeviceType!) - The type of device.
- **status** (PointOfSaleDeviceStatus!) - The status of the device.
```

--------------------------------

### webPresenceCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/Mutation

Mutation to create a web presence. Returns a WebPresenceCreatePayload.

```APIDOC
## webPresenceCreate

### Description
Create a web presence.

### Return Type
WebPresenceCreatePayload
```

--------------------------------

### AppInstallation.publication (Deprecated)

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation

Retrieves the publication associated with the app installation. This field is deprecated.

```APIDOC
## publication

### Description
Publication (Deprecated)

### Type
Publication

### Deprecated
This field is deprecated.

```

--------------------------------

### AppInstallation Query

Source: https://shopify.dev/docs/api/admin-graphql/latest/queries/appInstallation

The AppInstallation query retrieves details about an app installation, including one-time purchases, revenue attribution records, and the uninstall URL. It supports pagination and filtering arguments.

```APIDOC
## AppInstallation Query

### Description
The AppInstallation query returns information about an app installation, including one-time purchases, revenue attribution records, and the uninstall URL. It supports pagination and filtering arguments.

### Fields

#### oneTimePurchases
- **Type**: AppPurchaseOneTimeConnection! (non-null)
- **Description**: One-time purchases to a shop.

##### Arguments
- **after** (String) - Optional - The elements that come after the specified cursor.
- **before** (String) - Optional - The elements that come before the specified cursor.
- **first** (Int) - Optional - The first `n` elements from the paginated list.
- **last** (Int) - Optional - The last `n` elements from the paginated list.
- **reverse** (Boolean) - Optional - Default: false - Reverse the order of the underlying list.
- **sortKey** (AppTransactionSortKeys) - Optional - Default: CREATED_AT - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

#### revenueAttributionRecords
- **Type**: AppRevenueAttributionRecordConnection! (non-null)
- **Description**: The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.

##### Arguments
- **after** (String) - Optional - The elements that come after the specified cursor.
- **before** (String) - Optional - The elements that come before the specified cursor.
- **first** (Int) - Optional - The first `n` elements from the paginated list.
- **last** (Int) - Optional - The last `n` elements from the paginated list.
- **reverse** (Boolean) - Optional - Default: false - Reverse the order of the underlying list.
- **sortKey** (AppRevenueAttributionRecordSortKeys) - Optional - Default: CREATED_AT - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

#### uninstallUrl
- **Type**: URL
- **Description**: The URL to uninstall the application.

#### channel (Deprecated)
- **Type**: Channel
- **Description**: Deprecated. Show fields.

#### publication (Deprecated)
- **Type**: Publication
- **Description**: Deprecated. Show fields.

#### subscriptions (Deprecated)
- **Type**: [AppSubscription!]! (non-null)
- **Description**: Deprecated. Show fields.

### Arguments

#### keys
- **Type**: [String!]
- **Description**: List of keys of metafields in the format `namespace.key`, will be returned in the same format.

#### namespace
- **Type**: String
- **Description**: The metafield namespace to filter by. If omitted, all metafields are returned.

#### after
- **Type**: String
- **Description**: The elements that come after the specified cursor.

#### before
- **Type**: String
- **Description**: The elements that come before the specified cursor.

#### first
- **Type**: Int
- **Description**: The first `n` elements from the paginated list.

#### last
- **Type**: Int
- **Description**: The last `n` elements from the paginated list.

#### reverse
- **Type**: Boolean
- **Description**: Default: false - Reverse the order of the underlying list.

```

--------------------------------

### AppInstallation.channel (Deprecated)

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation

Retrieves the channel associated with the app installation. This field is deprecated.

```APIDOC
## channel

### Description
Channel (Deprecated)

### Type
Channel

### Deprecated
This field is deprecated.

```

--------------------------------

### Product.options

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/Product

Retrieves a list of product options. The limit is defined by the shop's resource limits for product options.

```APIDOC
## Product.options

### Description
Retrieves a list of product options. The limit is defined by the shop's resource limits for product options.

### Arguments
- **first** (Int) - Optional - Truncate the array result to this size.

### Return Type
- **[ProductOption!]!** (non-null) - A list of product options. The limit is defined by the shop's resource limits for product options (`Shop.resourceLimits.maxProductOptions`).
```

--------------------------------

### appDiscountTypes

Source: https://shopify.dev/docs/api/admin-graphql/latest/objects/AppDiscountType

Query to retrieve a list of app discount types installed by apps.

```APIDOC
## Query: appDiscountTypes

### Description
A list of app discount types installed by apps.

### Return Type
[AppDiscountType!]!

### Example
```graphql
query {
  appDiscountTypes {
    app {
      name
    }
    appBridge {
      # fields
    }
    appKey
    description
    discountClasses
    functionId
    title
  }
}
```
```

--------------------------------

### catalogCreate

Source: https://shopify.dev/docs/api/admin-graphql/latest/payloads/CatalogCreatePayload

Creates a Catalog that controls product availability and pricing for specific contexts like markets or B2B company locations. The mutation returns a CatalogCreatePayload containing the newly created catalog and any user errors.

```APIDOC
## catalogCreate

### Description
Creates a `Catalog` that controls product availability and pricing for specific contexts like markets or B2B company locations. The mutation returns a `CatalogCreatePayload`.

### Method
mutation

### Endpoint
catalogCreate

### Arguments
- **input** (CatalogCreateInput!) - required - The properties of the new catalog.

### Return Type
CatalogCreatePayload

### Fields
- **catalog** (Catalog) - The newly created catalog.
- **userErrors** ([CatalogUserError!]!) - non-null - The list of errors that occurred from executing the mutation.

### Usage Notes
- **Publication** objects control which products are visible in a catalog. Publications are optional. When a publication isn't associated with a catalog, product availability is determined by the sales channel.
- **PriceList** objects define custom pricing for products in a catalog.
- You can optionally associate a publication and price list when creating the catalog, or add them later using separate mutations.
- Create a publication only if you need to limit which products are visible in a specific context or publish a curated subset of your product catalog.
- Do NOT create a publication if you want product availability determined by the sales channel or if you only need to customize pricing (use a price list without a publication).
- For company location catalogs that only require custom pricing, create the catalog with a price list but without a publication.
```
Tokens:
Raw