Deprecated API calls

Version 2021-01 (Latest)

Private apps

The Deprecated API calls resource is available only for private apps.

You can call this endpoint to get a list of all the deprecated calls your private apps have made in the past 30 days, information on migration steps, and the deadline to update these calls in your apps.

Follow the developer changelog to make sure you're aware of any breaking changes that might affect your app. You can learn more about how to update your apps in our versioning guide.

What you can do with Deprecated API calls

The Shopify API lets you do the following with the Deprecated API calls resource. More detailed versions of these general actions may be available:

GET /admin/api/2021-01/deprecated_api_calls.json Retrieves a list of deprecated API calls

Deprecated API calls properties

data_updated_at

"data_updated_at": "2020-10-13T00:15:30Z"

The date and time (ISO 8601 format) when the data was last updated.

deprecated_api_calls

"deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]

A list of deprecated API calls made by the authenticated app in the past 30 days. Each object has the following properties:

api_type: The type of API that the call was made to. Valid values: REST, Webhook, GraphQL.
description: A description of the deprecation and any required migration steps.
documentation_url: The documentation URL to the deprecated change.
endpoint: A description of the REST endpoint, webhook topic, or GraphQL field called.
last_call_at: The timestamp (ISO 4217 format) when the last deprecated API call was made.
migration_deadline: The time (ISO 4217 format) when the deprecated API call will be removed.
graphql_schema_name: The name of the GraphQL schema. If the call wasn't made to a GraphQL API, then this value is null.
version: The earliest API version to migrate to in order to avoid making the deprecated API calls.

Endpoints

GET /admin/api/2021-01/deprecated_api_calls.json

Retrieves a list of deprecated API calls made by your private apps in the past 30 days.

Retrieves all deprecated API calls

GET /admin/api/2021-01/deprecated_api_calls.json

View Response

HTTP/1.1 200 OK
{
  "data_updated_at": "2020-10-13T00:15:30Z",
  "deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]
}

Version 2021-04 (Release candidate)

Private apps

The Deprecated API calls resource is available only for private apps.

You can call this endpoint to get a list of all the deprecated calls your private apps have made in the past 30 days, information on migration steps, and the deadline to update these calls in your apps.

Follow the developer changelog to make sure you're aware of any breaking changes that might affect your app. You can learn more about how to update your apps in our versioning guide.

What you can do with Deprecated API calls

The Shopify API lets you do the following with the Deprecated API calls resource. More detailed versions of these general actions may be available:

GET /admin/api/2021-04/deprecated_api_calls.json Retrieves a list of deprecated API calls

Deprecated API calls properties

data_updated_at

"data_updated_at": "2020-10-13T00:15:30Z"

The date and time (ISO 8601 format) when the data was last updated.

deprecated_api_calls

"deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]

A list of deprecated API calls made by the authenticated app in the past 30 days. Each object has the following properties:

api_type: The type of API that the call was made to. Valid values: REST, Webhook, GraphQL.
description: A description of the deprecation and any required migration steps.
documentation_url: The documentation URL to the deprecated change.
endpoint: A description of the REST endpoint, webhook topic, or GraphQL field called.
last_call_at: The timestamp (ISO 4217 format) when the last deprecated API call was made.
migration_deadline: The time (ISO 4217 format) when the deprecated API call will be removed.
graphql_schema_name: The name of the GraphQL schema. If the call wasn't made to a GraphQL API, then this value is null.
version: The earliest API version to migrate to in order to avoid making the deprecated API calls.

Endpoints

GET /admin/api/2021-04/deprecated_api_calls.json

Retrieves a list of deprecated API calls made by your private apps in the past 30 days.

Retrieves all deprecated API calls

GET /admin/api/2021-04/deprecated_api_calls.json

View Response

HTTP/1.1 200 OK
{
  "data_updated_at": "2020-10-13T00:15:30Z",
  "deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]
}

Version unstable

Private apps

The Deprecated API calls resource is available only for private apps.

You can call this endpoint to get a list of all the deprecated calls your private apps have made in the past 30 days, information on migration steps, and the deadline to update these calls in your apps.

Follow the developer changelog to make sure you're aware of any breaking changes that might affect your app. You can learn more about how to update your apps in our versioning guide.

What you can do with Deprecated API calls

The Shopify API lets you do the following with the Deprecated API calls resource. More detailed versions of these general actions may be available:

GET /admin/api/unstable/deprecated_api_calls.json Retrieves a list of deprecated API calls

Deprecated API calls properties

data_updated_at

"data_updated_at": "2020-10-13T00:15:30Z"

The date and time (ISO 8601 format) when the data was last updated.

deprecated_api_calls

"deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]

A list of deprecated API calls made by the authenticated app in the past 30 days. Each object has the following properties:

api_type: The type of API that the call was made to. Valid values: REST, Webhook, GraphQL.
description: A description of the deprecation and any required migration steps.
documentation_url: The documentation URL to the deprecated change.
endpoint: A description of the REST endpoint, webhook topic, or GraphQL field called.
last_call_at: The timestamp (ISO 4217 format) when the last deprecated API call was made.
migration_deadline: The time (ISO 4217 format) when the deprecated API call will be removed.
graphql_schema_name: The name of the GraphQL schema. If the call wasn't made to a GraphQL API, then this value is null.
version: The earliest API version to migrate to in order to avoid making the deprecated API calls.

Endpoints

GET /admin/api/unstable/deprecated_api_calls.json

Retrieves a list of deprecated API calls made by your private apps in the past 30 days.

Retrieves all deprecated API calls

GET /admin/api/unstable/deprecated_api_calls.json

View Response

HTTP/1.1 200 OK
{
  "data_updated_at": "2020-10-13T00:15:30Z",
  "deprecated_api_calls": [
  {
    "api_type": "REST",
    "description": "The page filter has been removed from multiple endpoints. Use cursor-based pagination instead.",
    "documentation_url": "https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api",
    "endpoint": "Product",
    "last_call_at": "2020-06-12T03:46:18Z",
    "migration_deadline": "2020-07-02T13:00:00Z",
    "graphql_schema_name": null,
    "version": "2019-07"
  }
]
}