Skip to content
Skip to main content
GET
/v3/grants/{grant_id}/consolidated-order

Get all e-commerce ordersBeta

Returns a list of extracted e-commerce orders.

NYLAS API KEY

Parameters

Path parameters

grant_id*string

The email address or ID of the grant to access.

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

Default: 50
page_tokenstring

An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.

Responses

request_idstring

The request ID.

dataobject

Base response object for an ExtractAI result.

GEThttps://api.us.nylas.com/v3/grants/{grant_id}/consolidated-order?limit=50

Find your API key in the Nylas Dashboard under API Keys in your application settings.

grant_idrequiredstring

The email address or ID of the grant to access.

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.