@W-20890585 - GET Order and Orders APIs accept expand as optional query param #263
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
The Shopper Orders API getOrder endpoint supports an expand query parameter (e.g., expand=oms) to provide Orders data from OMS (Order Management System) if Order is pushed to SOM, otherwise provides Orders data from ECOM. However, this parameter is currently missing from the SDK's paramKeys for getOrder.
Problem
When using commerce-sdk-react hooks like useOrder with expand: 'oms', the parameter is filtered out by pickValidParams() because it's not in the allowed parameter list.
Solution
Add expand to the getOrder paramKeys in the ShopperOrders API definition.
Changes:
Shopper Orders API (shopper-orders-oas-v1-public.yaml)
expandquery parameter to thegetOrderendpointexpandparameter definition in components/parameters sectionShopper Customers API (shopper-customers-oas-v1-public.yaml)
expandquery parameter to thegetCustomerOrdersendpointexpandparameter definition in components/parameters sectionParameter Details:
Example Usage:
Get Order:
GET /organizations/{organizationId}/orders/{orderNo}?siteId=RefArch&expand=oms
Get Customer Orders:
GET /organizations/{organizationId}/customers/{customerId}/orders?siteId=RefArch&expand=oms
Files Changed: