Add export
POST /api/connector/v1/exports/add
Create a pending export. Export all entities of the specified EntityType within the enterprise. Note this operation supports Portfolio Access Tokens but doesn’t have filtering by EnterpriseIds or ChainIds, so will return entities from all enterprises within the scope of the portfolio.
If there is already an export with status Pending or Processing for the specified entity type, the request for a new export will be rejected. Successful exports remain available for download until the expiration date specified in ExpiresUtc.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Type of exported entities
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EntityType": "OrderItem"}Responses
Section titled “ Responses ”OK
object
Added export.
object
Unique identifier of the export.
Current status of the export.
Type of exported entities
Files with exported data. Empty if no files are available.
object
URL of the exported file for download in JSON Lines format.
Total size of the exported file in bytes.
Expiration date and time of the export in UTC timezone in ISO 8601 format. After this time the Exported files may no longer be available for download.
Example
{ "Export": { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Status": "Pending", "EntityType": "OrderItem", "Files": [ { "Url": "string", "SizeInBytes": 0 } ], "ExpiresUtc": "2024-04-11T08:54:47.193Z" }}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.