order_status_url is not returned in the Admin REST API Orders

Solved

order_status_url is not returned in the Admin REST API Orders

soulchild37
Shopify Partner
183 9 55

Seems like starting 12 February 2024, Shopify has stopped returning the "order_status_url" field for GET /admin/api/<version>/orders/<id>.json , with no announcement.

This applies to all production version (from 2024-04 to 2023-04), which broke my apps (and I believe many other partners' apps too)

This is a breaking change to production API without any notice or workaround. There is no way to retrieve order status URL using API now.

Spent too much support time dealing with order cancellation request from customer? Wouldn't it be good if customer can cancel order on their own without bugging your support? Try out Cancellable app! https://apps.shopify.com/cancellable . I also write articles about store customization that can improve your customer shopping experience here : Yagi Software Blog
Accepted Solution (1)

Liam
Community Manager
3108 340 871

This is an accepted solution.

Hi,

 

We have a changelog update on this API change, which was necessary for protecting customer data that you can read for more information. Your app will need Level 2 Protected Customer Data Requirements in order to access the `order_status_url` field, more information on how to request this via your partner dashboard in our developer docs. 

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

View solution in original post

Replies 6 (6)

Liam
Community Manager
3108 340 871

This is an accepted solution.

Hi,

 

We have a changelog update on this API change, which was necessary for protecting customer data that you can read for more information. Your app will need Level 2 Protected Customer Data Requirements in order to access the `order_status_url` field, more information on how to request this via your partner dashboard in our developer docs. 

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

pratikvii
Shopify Partner
7 1 12

Hey @Liam !

What actions are required for the custom Apps.

 

Thanks!
Pratik

ReturnHelper
Shopify Partner
1 0 0

The first URL "a changelog update on this API change"  does not exist. Has the change been canceled?

 

Csaba_R
Shopify Partner
4 0 0

Hello,

 

I've had no issues with receiving the "order_status_url" from the REST API until last week. I'm guessing removing it was reverted from February but got reintroduced last week somehow? Now I also have the issue of missing the "order_status_url" entirely from the Order resource when I query for it from a custom app.

 

Could we please get some assistance on what to expect? The changelog url is still a 404 page.

 

Thanks!

Csaba

yukiteststore_A
Shopify Partner
4 0 1

I have Level 2 approval of Customer data access, but I still do not see order_status_url when requesting an order with `GET /admin/api/2024-04/orders.json?status=any`

 

I think the changelog is the following.  
https://shopify.dev/changelog/level-2-protected-customer-data-requirements-are-now-needed-to-access-...
I do not see statusPageUrl either.  I'm using the REST endpoint.

yukiteststore_A
Shopify Partner
4 0 1

Ok I figured it out.  It's really awful and written nowhere in the documentation, but you must request for customer Name in order to get the order_status_url in the retrieved orders response.   I was requesting only Email and it was not enough to get order_status_url.