Skip to content

Add service order notes

POST
/api/connector/v1/serviceOrderNotes/add

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

MultipleServiceOrderNoteAddParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ServiceOrderNotes
required

Notes to be added.

Array<object>
>= 1 items <= 1000 items
Service order note parameters
object
ServiceOrderId
required

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

string format: uuid
Text
required

Content of the service order note.

string
>= 1 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ServiceOrderNotes": [
{
"ServiceOrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
"Text": "Shaken, not stirred."
}
]
}

OK

ServiceOrderNoteAdditionResult
object
ServiceOrderNotes
required

Added service order notes.

Array<object>
Service order note
object
Id

Unique identifier of the service order note.

string format: uuid
OrderId

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

string format: uuid
Text

Content of the service order note.

string
nullable
Type
Service order note type

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

General

ChannelManager

SpecialRequest

string
Allowed values: General ChannelManager SpecialRequest
CreatedUtc

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

string format: date-time
nullable
UpdatedUtc

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

string format: date-time
nullable
Example
{
"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"
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable