open-api icon indicating copy to clipboard operation
open-api copied to clipboard

[DOCS]: Unclear transaction `shipping_method` and `shipping_upgrade` behavior.

Open NathanConroyOrd opened this issue 3 years ago • 0 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Link to Documentation Issue

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

What would you like to change?

About a transaction's shipping_method and shipping_upgrade, there are a few things that need clarification.

From what's been said in prior issues, shipping_method is always null when a transaction has "Standard Shipping". Is that correct? I believe this is a change from the v2 API's behavior. If that is the case, this should be prominently documented.

Further, even when an upgraded shipping option is selected, shipping_method can still be null while shipping_upgrade contains shipping information. This leaves me with many questions, and the docs don't help me answer them:

What are shipping_method and shipping_upgrade exactly? How do they relate to what the shop admin sees in the UI? When are they set? When are they not set? How do they relate to each other? When exactly can I conclude a transaction has "Standard Shipping"?

Thank you in advance for your help!

Related issues: https://github.com/etsy/open-api/issues/271 https://github.com/etsy/open-api/issues/374

Why are you proposing this change?

No response

NathanConroyOrd avatar Aug 10 '22 18:08 NathanConroyOrd