Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Deprecated API calls

Custom apps

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

You can call this endpoint to get a list of all the deprecated calls your custom 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.

Was this section helpful?
#

Endpoints

Anchor to

The Deprecated API calls resource

Anchor to

Properties

data_updated_at

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

deprecated_api_calls

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

Show deprecated_api_calls 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.
Was this section helpful?
{}

The Deprecated API calls resource

{
"data_updated_at": "2020-10-13T00:15:30Z",
"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/api/usage/pagination-rest",
"endpoint": "Product",
"last_call_at": "2020-06-12T03:46:18Z",
"migration_deadline": "2020-07-02T13:00:00Z",
"graphql_schema_name": null,
"version": "2019-07"
}
]
}
}

Anchor to GET request, Retrieves a list of deprecated API calls
get
Retrieves a list of deprecated API calls

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

Anchor to Parameters of Retrieves a list of deprecated API callsParameters

api_version
string
required
Was this section helpful?

Anchor to get-deprecated-api-calls-examplesExamples

Retrieves all deprecated API calls

Was this section helpful?
get

/admin/api/2025-01/deprecated_api_calls.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-01/deprecated_api_calls.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
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/api/usage/pagination-rest",
"endpoint": "Product",
"last_call_at": "2020-06-12T03:46:18Z",
"migration_deadline": "2020-07-02T13:00:00Z",
"graphql_schema_name": null,
"version": "2019-07"
}
]
}