rest api - can two endpoints return different models if both return order?

Question

Is it under the rules of REST to return a different model of 'order' if someone call:

/me/orders/222

Return values:
- OrderId
- Price

or

/customers/111/orders/222

Return values:
- OrderId
- Price
- Tags
- Risk
- Comment

Maybe the model of 'order' should always be the same instead of different endpoints? Or it can differ? Is there any rule?

please don't cross-post: stackoverflow.com/questions/69258669/… "Cross-posting is frowned upon as it leads to fragmented answers splattered all over the network..." — gnat, Commented Sep 21, 2021 at 8:51

Ewan · Accepted Answer · 2021-09-21 11:49:46Z

0

There are no "rules of REST", but having two different objects with the same name is confusing. And that's basically what you have done here.

I would suggest using the same fields if they are the same thing, or choosing a different name, Item vs Order or whatnot

answered Sep 21, 2021 at 11:49

Ewan

78.6k5 gold badges83 silver badges176 bronze badges

Add a comment |

1 Answer 1