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
  • Get all exports
  • Request
  • Response
  • Add export
  • Request
  • Response

Was this helpful?

  1. API Operations

Exports

PreviousExchange ratesNextIdentity documents

Last updated 4 months ago

Was this helpful?

Get all exports

Restricted!

This operation is currently in beta-test and as such it is subject to change.

Get exports for the given ExportIds. Note this operation supports .

Request

[PlatformAddress]/api/connector/v1/exports/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ExportIds": [
    "3fa85f64-5717-4562-b3fd-2c963f66afa6",
    "09708665-0e31-4b23-b337-b0a000be0df0",
    "706dc6d5-9511-4751-825e-538ce99da2ce",
    "f776f20a-6f1a-4ddf-93f4-9dae95261415"
  ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

ExportIds

array of string

required, max 1000 items

Response

{
  "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
        }
      ]
    },
    {
      "Id": "09708665-0e31-4b23-b337-b0a000be0df0",
      "Status": "Pending",
      "EntityType": "OrderItem",
      "Files": [],
      "ExpiresUtc": null
    },
    {
      "Id": "706dc6d5-9511-4751-825e-538ce99da2ce",
      "Status": "Processing",
      "EntityType": "OrderItem",
      "Files": [],
      "ExpiresUtc": null
    },
    {
      "Id": "f776f20a-6f1a-4ddf-93f4-9dae95261415",
      "Status": "Expired",
      "EntityType": "OrderItem",
      "Files": [],
      "ExpiresUtc": "2023-10-24T14:12:30Z"
    }
  ]
}
Property
Type
Contract
Description

Exports

required

Requested exports.

Add export

Restricted!

This operation is currently in beta-test and as such it is subject to change.

Request

[PlatformAddress]/api/connector/v1/exports/add

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EntityType": "OrderItem"
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

EntityType

required

Type of exported entities

Response

{
  "Export": {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Status": "Pending",
    "EntityType": "OrderItem",
    "Files": [
      {
        "Url": "string",
        "SizeInBytes": 0
      }
    ],
    "ExpiresUtc": "2024-04-11T08:54:47.193Z"
  }
}
Property
Type
Contract
Description

Export

required

Added export.

Export

Property
Type
Contract
Description

Id

string

required

Unique identifier of the export.

Status

required

Current status of the export.

EntityType

required

Type of exported entities

Files

required

Files with exported data. Empty if no files are available.

ExpiresUtc

string

optional

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.

Export status

  • Pending

  • Processing

  • Success

  • Failed

  • Expired

Exported entity type

  • OrderItem

  • Payment

  • Reservation

  • Customer

  • Company

  • Bill

  • AvailabilityAdjustment

  • AvailabilityBlock

  • ResourceBlock

Export file entry

Property
Type
Contract
Description

Url

string

required

URL of the exported file for download in JSON Lines format.

SizeInBytes

integer

required

Total size of the exported file in bytes.

Unique identifiers of the .

array of

Create a pending export. Export all entities of the specified EntityType within the enterprise. Note this operation supports 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.

array of

Portfolio Access Tokens
Portfolio Access Tokens
Exports
Export
Exported entity type
Export
Export status
Exported entity type
Export file entry