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
    • Billing automations
    • 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 service order notes
  • Request
  • Response
  • Add service order notes
  • Request
  • Response
  • Update service order notes
  • Request
  • Response
  • Delete service order notes
  • Request
  • Response

Was this helpful?

  1. API Operations

Service order notes

PreviousRulesNextService overbooking limits

Last updated 1 month ago

Was this helpful?

Get all service order notes

Returns all notes associated with the given service orders. Service orders can be reservations or product orders. Note this operation uses and supports .

Service order: This is the general name for an order made against a service, which includes both 'stay' service orders, called , and 'product' service orders, which we simply call . Operations such as will accept Reservation IDs or Order IDs as service order identifiers.

Request

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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceOrderIds": [
    "1dc0c6bf-2ce6-4a9f-af97-af5c01676720"
  ],
  "ServiceOrderNoteIds": [
    "a06a225b-00f7-48c8-a463-af5c016768e9"
  ],
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "Limitation": {
    "Count": 100
  }
}
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.

EnterpriseIds

array of string

optional, max 1000 items

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

ServiceOrderIds

array of string

required, max 1000 items

Unique identifiers of Service order. Reservation IDs or Order IDs can be used as service order identifiers.

ServiceOrderNoteIds

array of string

optional, max 1000 items

Unique identifiers of Service order note. Use this property if you want to fetch specific service order notes.

UpdatedUtc

optional, max length 3 months

Timestamp in UTC timezone ISO 8601 format when the service order note was updated.

Types

optional

Type of the service order note. Defaults to ["General", "ChannelManager"].

Limitation

required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "ServiceOrderNotes": [
    {
      "Id": "a06a225b-00f7-48c8-a463-af5c016768e9",
      "OrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
      "Text": "Shaken, not stirred.",
      "Type": "General",
      "CreatedUtc": "2022-11-29T21:48:32Z",
      "UpdatedUtc": "2022-11-30T12:36:37Z"
    }
  ],
  "Cursor": "a06a225b-00f7-48c8-a463-af5c016768e9"
}
Property
Type
Contract
Description

ServiceOrderNotes

required

The collection of service order notes.

Cursor

string

optional

Add service order notes

Adds one or more notes with a provided text to a specific service order. Service orders can be reservations or product orders.

Request

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

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceOrderNotes": [
    {
      "ServiceOrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
      "Text": "Shaken, not stirred."
    }
  ]
}
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.

ServiceOrderNotes

required, max 1000 items

Notes to be added.

Service order note parameters

Property
Type
Contract
Description

ServiceOrderId

string

required

Unique identifier of the Service order to which note will be added.

Text

string

required

Content of the service order note.

Response

{
  "ServiceOrderNotes": [
    {
      "Id": "a06a225b-00f7-48c8-a463-af5c016768e9",
      "OrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
      "Text": "Shaken, not stirred.",
      "Type": "General",
      "CreatedUtc": "2022-11-29T21:48:32Z",
      "UpdatedUtc": "2022-11-30T12:36:37Z"
    }
  ]
}
Property
Type
Contract
Description

ServiceOrderNotes

required

Added service order notes.

Service order note

Property
Type
Contract
Description

Id

string

required

Unique identifier of the service order note.

OrderId

string

required

Unique identifier of the Service order to which the Service Order Note belongs.

Text

string

optional

Content of the service order note.

Type

required

A discriminator specifying the type of service order note, e.g. general or channel manager.

CreatedUtc

string

optional

Creation date and time of the service order note in UTC timezone in ISO 8601 format.

UpdatedUtc

string

optional

Last update date and time of the service order note in UTC timezone in ISO 8601 format.

Service order note type

  • General

  • ChannelManager

  • SpecialRequest

Update service order notes

Updates one or more given service order notes with new text.

Request

[PlatformAddress]/api/connector/v1/serviceOrderNotes/update

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceOrderNoteUpdates": [
    {
      "ServiceOrderNoteId": "a06a225b-00f7-48c8-a463-af5c016768e9",
      "Text": {
        "Value": "Shaken, not stirred."
      }
    }
  ]
}
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.

ServiceOrderNoteUpdates

required, max 1000 items

Notes to be updated.

Service order note update parameters

Property
Type
Contract
Description

ServiceOrderNoteId

string

required

Unique identifier of the Service order note.

Text

optional

Content of the service order note (or null if the content should not be updated).

Response

{
  "ServiceOrderNotes": [
    {
      "Id": "a06a225b-00f7-48c8-a463-af5c016768e9",
      "OrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
      "Text": "Shaken, not stirred.",
      "Type": "General",
      "CreatedUtc": "2022-11-29T21:48:32Z",
      "UpdatedUtc": "2022-11-30T12:36:37Z"
    }
  ]
}
Property
Type
Contract
Description

ServiceOrderNotes

required

Updated service order notes.

Delete service order notes

Deletes service order notes.

Request

[PlatformAddress]/api/connector/v1/serviceOrderNotes/delete

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ServiceOrderNoteIds": [
    "a06a225b-00f7-48c8-a463-af5c016768e9"
  ]
}
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.

ServiceOrderNoteIds

array of string

required, max 1000 items

Unique identifiers of the service order notes to be deleted.

Response

{}

array of

array of

Unique identifier of the last and hence oldest service order note returned. This can be used in in a subsequent request to fetch the next batch of older service order notes.

array of

array of

array of

array of

Service order note type
Service order note
Service order note parameters
Service order note
Service order note type
Service order note update parameters
Service order note
Pagination
Portfolio Access Tokens
Orders
Get all service order notes
Limitation
Limitation
Time interval
String update value
Reservations