Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • User scenarios
  • User benefits
  • Initiate the export
  • Check export status
  • Download exported data
  • Frequently Asked Questions
  • Will the supported entity types be extended in future?
  • How often should I check for updates?
  • Can I export data from multiple enterprises in one request?
  • For how long are export files available to download?

Was this helpful?

  1. Use cases

Data export

PreviousCustomer messagingNextDevice integration

Last updated 1 year ago

Was this helpful?

The Data export feature of the Mews Connector API provides a streamlined method for retrieving bulk data. This feature is designed for users who require access to a substantial amount of data, such as , without the hassle of making multiple paginated requests subject to timeouts and other constraints.

User scenarios

  • You are a Mews partner onboarding a new property and you need an initial data sync

  • You are a Mews Multi-Property user and want to retrieve data shared across multiple properties

  • You are using a newly added API operation and are loading data for the first time

  • You wish to perform a cross-data sanity check

User benefits

  • Streamlined bulk data export process

  • Reduced API request complexity and potential timeouts

  • Improved scalability for large-scale data retrieval

  • Faster property onboarding process

  • Potential for future expansion to support further data entities

Restricted!

This feature is currently under beta test and is subject to change. If you would like to take advantage of the feature, contact us via .

Initiate the export

'How to' use case

API Operations

How to create a new bulk data export

Check export status

'How to' use case

API Operations

How to check on data export progress

Download exported data

{
    "Exports": [
        {
            "Id": "3fa85f64-5717-4562-b3fd-2c963f66afa6",
            "Status": "Success",
            "EntityType": "OrderItem",
            "ExpiresUtc": "2023-10-26T11:42:28Z",
            "Files": [
                {
                    "Url": "https://example.com/exports/3fa85f64-5717-4562-b3fd-2c963f66afa6-1.jsonl?example=signature",
                    "SizeInBytes": 1215279
                },
                {
                    "Url": "https://example.com/exports/3fa85f64-5717-4562-b3fd-2c963f66afa6-2.jsonl?example=signature",
                    "SizeInBytes": 1398362
                }
            ]
        },
    ]
}

Multiple files: Note the data export may consist of multiple files.

Frequently Asked Questions

Will the supported entity types be extended in future?

Depending on user demand, the Mews Connector API may be expanded to support additional data entities for bulk export.

How often should I check for updates?

Export duration can vary enormously, but checking status every 5 minutes is a reasonable frequency. The current mechanism is considered a trial which may be enhanced in future.

Can I export data from multiple enterprises in one request?

Yes, you can use a Portfolio Access Token to request data from multiple enterprises. Doing so will generate an export of data for all enterprises within scope of the Access Token.

For how long are export files available to download?

To initiate a bulk data export, use the operation, specifying the data Entity type, e.g. OrderItem. The operation returns an object containing the Export Id to use in the next step. If there is already an export pending, the operation returns a 400 HTTP error code.

To monitor the progress of the export and retrieve the exported data, use the operation. This operation returns details of exports for the ExportIds you specify, including their status. You can repeatedly check the status of an export while its status is Pending or Processing, for example every 5 minutes.

Once the export status changes to Success, you can download the exported data from the provided . For example:

Export files are available to download for a limited period, typically 1 week. The expiry time is specified by ExpiresUtc in the object.

partnersuccess@mews.com
Order items
Add export
Export
Get all exports
file URLs
Export
Add export
Get all exports