Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 7390ecb

Browse files
authored
Merge pull request #3269 from magento/kh_rest-mq
Add note about starting the message queue consumer for bulk/async calls
2 parents 1b96ee5 + a515606 commit 7390ecb

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

guides/v2.3/rest/asynchronous-web-endpoints.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ functional_areas:
99

1010
An asynchronous web endpoint intercepts messages to a Web API and writes them to the message queue. Each time the system accepts such an API request, it generates a UUID identifier. Magento includes this UUID when it adds the message to the queue. Then, a consumer reads the messages from the queue and executes them one-by-one.
1111

12+
{:.bs-callout .bs-callout-tip}
13+
Use the `bin/magento queue:consumers:start async.operations.all` command to enable asynchronous requests.
14+
1215
Magento supports the following types of asynchronous requests:
1316

1417
* POST

guides/v2.3/rest/bulk-endpoints.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ functional_areas:
77
- Integration
88
---
99

10-
Bulk API endpoints differ from other endpoints in that they combine multiple calls of the same type into an array and execute them as a single request. The endpoint handler splits the array into individual entities and writes them as separate messages to the message queue.
10+
Bulk API endpoints differ from other REST endpoints in that they combine multiple calls of the same type into an array and execute them as a single request. The endpoint handler splits the array into individual entities and writes them as separate messages to the message queue.
1111

1212
{:.bs-callout .bs-callout-tip}
13-
GET requests are not supported.
13+
Use the `bin/magento queue:consumers:start async.operations.all` command to enable bulk endpoint processing.
1414

1515
### Routes
1616

@@ -32,6 +32,8 @@ Synchronous route | Bulk route
3232
`POST /V1/carts/:quoteId/items` | `POST async/bulk/V1/carts/byQuoteId/items`
3333
`DELETE /V1/customers/:customerId` | `DELETE async/bulk/V1/customers/byCustomerId`
3434

35+
{:.bs-callout .bs-callout-info}
36+
GET requests are not supported.
3537

3638
### Payloads
3739

0 commit comments

Comments
 (0)