MageSmith
POSTInventoryInStorePickupSalesApi · Magento 2.4.9 Admin · Magento_InventoryInStorePickupApi::notify_orders_are_ready_for_pickup

POST /V1/order/notify-orders-are-ready-for-pickup

POST /V1/order/notify-orders-are-ready-for-pickup is a Magento 2 REST endpoint in the InventoryInStorePickupSalesApi module. Notify customer that the orders is ready for pickup. Requires an admin Bearer token with ACL Magento_InventoryInStorePickupApi::notify_orders_are_ready_for_pickup.

Last verified: against Magento 2.4.9.

Returns

Magento\InventoryInStorePickupSalesApi\Api\Data\ResultInterface

Service contract

Magento\InventoryInStorePickupSalesApi\Api\NotifyOrdersAreReadyForPickupInterface::execute

Authorization

Admin Bearer token with ACL:

  • Magento_InventoryInStorePickupApi::notify_orders_are_ready_for_pickup

Body parameters

orderIds int[] Required

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

Accept
application/json
Content-Type
application/json
Authorization
Bearer <ACCESS_TOKEN> admin token with ACL: Magento_InventoryInStorePickupApi::notify_orders_are_ready_for_pickup

Path

/V1/order/notify-orders-are-ready-for-pickup

Body

{
  "orderIds": [
    0
  ]
}

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →