X-Shopify-API-Deprecated-Reason header not working as expected

sinuhe
Shopify Partner
16 0 5

Hi there, 

 

when making requests to the REST API or GraphQL API, we are using the X-Shopify-API-Deprecated-Reason header to be aware about possible deprecations, as documented in https://shopify.dev/docs/api/usage/versioning#rest-api-deprecation-practices.

 

However, for example when creating a new price rule (https://shopify.dev/docs/api/admin-graphql/2023-04/mutations/priceRuleCreate), we are receiving this deprecation reason:

 

https://shopify.dev/api/usage/versioning#deprecation-practices

 

which is completely generic and does not inform about the deprecated field or the deprecation reason. Indeed, is just a link to the deprecation practices... which does not make much sense.

 

Is this an error? Or is this the expected behavior?

Thanks and kind regards.

Replies 4 (4)

Liam
Shopify Staff
2731 298 769

Hi Sinuhe,

 

Typically the the X-Shopify-API-Deprecated-Reason header is used for getting information related to deprecations on the REST API, while the API health report in your partner dashboard is recommended for GraphQL APIs like the priceRuleCreate mutation. If you check your apps' health report are you seeing info related to the deprecation reason? 

Liam | Developer Advocate @ Shopify 
 - Was my reply helpful? Click Like to let me know! 
 - Was your question answered? Mark it as an Accepted Solution
 - To learn more visit Shopify.dev or the Shopify Web Design and Development Blog

sinuhe
Shopify Partner
16 0 5

Hi Liam, thanks for the response.

 

If you check your apps' health report are you seeing info related to the deprecation reason? 

No. All I see is the ok message "No deprecated calls were detected in the past 30 days.". So the X-Shopify-API-Deprecated-Reason header and the partner dashboard API health report seem not to be synchronized.

Could you take a deeper look?

 

Kind regards!

    Fran



Liam
Shopify Staff
2731 298 769

That does seem strange Fran - so your app is making deprecated calls but this is not being displayed in the API health report page for that app? 

Liam | Developer Advocate @ Shopify 
 - Was my reply helpful? Click Like to let me know! 
 - Was your question answered? Mark it as an Accepted Solution
 - To learn more visit Shopify.dev or the Shopify Web Design and Development Blog

sinuhe
Shopify Partner
16 0 5

Hi Liam, yes.

 

"so your app is making deprecated calls": well... I am not saying that it is making deprecated calls, but at least there is a X-Shopify-API-Deprecated-Reason header in the response.

 

"but this is not being displayed in the API health report page for that app": yes. I don't know if you have access to our partner dashboard, bit if so you can check it 🙂 

Kind regards.