Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API clean up] Clean up api/shipments endpoints #4279

Open
luisramos0 opened this issue Sep 19, 2019 · 0 comments
Open

[API clean up] Clean up api/shipments endpoints #4279

luisramos0 opened this issue Sep 19, 2019 · 0 comments

Comments

@luisramos0
Copy link
Contributor

What we should change and why (this is tech debt)

Api/shipments comes from Spree and is used in the admin orders edit page to add variants to the order.
In OFN one order has only one shipment so shipments are actually dummy in OFN.

We can keep the shipments or we can hide the shipments API. Long term, it may be a bad idea to keep shipments public as we may want to get rid or change them as we abandon Spree...
An alternative would be to have a nice API under /order/{order_number}/contents

So, maybe the decision is to keep shipments api for the admin orders edit page as is and wait for an opportunity to build a new API, probably under /order/{order_number}/contents. This will come from a API feature request to use the API to create orders from an external client.

Context

This came up from the API documentation work #3001

Impact and timeline

I conclude that we should NOT have external clients using /api/shipments and if anyone wants to add items to an order, we need to build new endpoints. So I think this issue to clean up shipments is low value and will probably never be done.

I keep it open for reference.... as this topic will arise very soon.

@luisramos0 luisramos0 mentioned this issue Sep 19, 2019
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: All the things
Development

No branches or pull requests

1 participant