ExtractAI
Nylas ExtractAI allows you to connect to a user's email inbox and detect messages that match certain criteria. ExtractAI is currently available for online order tracking and delivery tracking, but you can apply it to many other scenarios.
ExtractAI uses the Order Consolidation endpoints to retrieve information about e-commerce order and tracking information from users' messages.
ExtractAI documentation
You can find more information about ExtractAI in the main documentation:
Order Consolidation scopes
The table below lists the Order Consolidation endpoints and which scopes they require. The table shortens the full scope URI for space reasons, so add the prefix for the provider when requesting scopes.
The ☑️ character indicates the most restrictive scope you can use for each provider.
| Endpoint | Google Scopeshttps://www.googleapis.com/auth/... |
Microsoft Scopeshttps://graph.microsoft.com/... |
|---|---|---|
GET /v3/grants/<NYLAS_GRANT_ID>/consolidated-orderGET /v3/grants/<NYLAS_GRANT_ID>/consolidated-shipment |
/gmail.readonly ☑️ |
Mail.Read ☑️Mail.Read.Shared |
For more information, see Using scopes to request user data.
Extract AI notifications
You can subscribe to the following triggers so Nylas notifies you about changes to your users' email inboxes:
message.intelligence.ordermessage.intelligence.trackingmessage.intelligence.return
For more information about the notification schema, see ExtractAI notifications.
GET /v3/grants/{grant_id}/consolidated-orderReturns a list of extracted e-commerce orders.
GET /v3/grants/{grant_id}/consolidated-shipmentReturns a list of extracted e-commerce shipments.
GET /v3/grants/{grant_id}/consolidated-returnReturns a list of extracted e-commerce returns.