magento/devdocs#7376: REST: Inventory In-Store Pickup endpoints. #7383
Conversation
Add general page content.
magento-engcom-team
added
Partner: Vaimo
partners-contribution
|
An admin must run tests on this PR before it can be merged. |
keharper
added
2.4.0
Community
There was a problem hiding this comment.
@swnsma Be sure to update the src/guides/v2.4/rest/modules/inventory/manage-sources.md file to include the new attributes.
It is not necessary to update the tutorial, because the tutorial needs to be refactored to accommodate In-Store Pickup.
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: review
labels
|
|
||
| The `GET /V1/inventory/in-store-pickup/pickup-locations` endpoint searches for and filters on pickup locations, allowing the shopper to quickly narrow the results. | ||
|
|
||
| Search terms, filters, and other attributes are specified as query parameters in the URL. This endpoint uses different a different syntax than other Magento GET calls that send `searchCriteria` parameters. Instead, the `GET /V1/inventory/in-store-pickup/pickup-locations` endpoint requires that each query parameter begins with `searchRequest`. The `scopeCode` parameter is required. All other parameters are optional. |
There was a problem hiding this comment.
"uses different a different"
There was a problem hiding this comment.
Hello @swnsma, the overall doc looks good to me. Thank you :)
The only thing I would like to add is information about auth permissions.
It would be nice to mention that inventoryInStorePickupSalesApiNotifyOrdersAreReadyForPickupV1 requires the appropriate admin persmissions (resource) Magento_InventoryInStorePickupApi::notify_orders_are_ready_for_pickup.
When inventoryInStorePickupApiGetPickupLocationsV1 has guest permissions and does't require authentication.
But it's not critical and up to you.
Thank you!
m2-community-project
bot
added
Progress: review
and removed
Progress: changes requested
labels
Fix typo, add info about authentication.
Add information about Source extension attributes.
|
running tests |
|
Hi @swnsma, thank you for your contribution! |
Purpose of this pull request
#7376
Affected DevDocs pages
Links to Magento source code
Q:
We already have a wiki page for new REST endpoints and adjustment of already available REST endpoints: https://github.com/magento/inventory/wiki/In-Store-Pickup-API-Tutorials
Should we add "adjustments" as a part of this page or create new one?
whatsnew
Added two new REST endpoints that add support for the Inventory Management In-store Pickup feature.