Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Service order notes

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 Pagination and supports Portfolio Access Tokens.

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

post/api/connector/v1/serviceOrderNotes/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

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

ServiceOrderIdsstring[] required

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

ServiceOrderNoteIdsstring[] nullable

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

TypesOrderNoteTypeEnum[] nullable

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

Response

OK

Cursorstring uuid nullable

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