[ENDPOINT] Proposed design change for getShopReceipts to return cancelled status

[peepo3663]

Current Endpoint Design There would be more field like status to know what is the status of the order or receipt

In current design, it has only was_ship and was_paid in the request, how can I receive cancelled orders?

Proposed Endpoint Design Change There would be more field like status to know what is the status of the order or receipt

Why are you proposing this change? I am working on integration with Etsy API 3, I would like to sync to status of the order to my api I could not find any things relating to cancelled order in the response.

[Gareth064]

I would love this feature added.

Currently when an order is cancelled on Etsy, we have to manually update or delete the order from my app because that order is no longer returned in getShopReciepts (or whatever it is called in v2). You could use getShopReciept and provide the ID, but my app is simply syncing data changes using a last modified date. It isn't using individual order ID's anywhere.

So simply have a status field which maybe has 3 options like "Open", "Fulfilled", "Cancelled".

Then for us who do the sync, we get orders updated since it last ran, the cancelled order would be in there, we see the status is "Cancelled" and we do X in our app to handle this as we see fit.

[amitshuklaCedcoss]

@peepo3663 @Gareth064 now we are able to get cancelled order status in V3 API (y)

[Gareth064]

@amitshuklaCedcoss are you saying that they appear in the results a long side open and fulfilled orders, without having to pass any extra parameters with the Get query? If so, then this is great news.

[amitshuklaCedcoss]

status required	stringEnum: "paid" "completed" "open" "payment processing" "canceled"

https://developers.etsy.com/documentation/reference/#operation/getShopReceipts

yes @Gareth064 , many of my clients are already getting this new status

[Gareth064]

@amitshuklaCedcoss - awesome, thank you for letting me know :)

[sowsinsk]

I am using v3 of the API, and I cannot get the getShopReceipts endpoint to return canceled orders. I have tried to query it filtered, and unfiltered, and only non-canceled orders are returned. Is this by design? Is there any way to retrieve canceled orders using getShopReceipts?

Thank you!

[hd-chuong]

I am using this endpoint getShopReceipts, aka https://openapi.etsy.com/v3/application/shops/{shop_id}/receipts. I am not passing any other params. I am still not getting cancelled orders? What is the correct way to fetch a number of canceled orders?

[etsyachristensen]

Etsy does not at this time return canceled orders in the OpenAPI V3. This is on our list of items to address in the coming months. We have no ETA on this however.

[sowsinsk]

Thank you for the clarification, Andrew. Glad to hear you are looking into addressing it!