Product service orders

Get all product service orders

Returns all product service orders associated with the given enterprise. This operation uses Pagination and supports Portfolio Access Tokens.

Request

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

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ProductServiceOrderIds": [
        "9b59b50d-bd32-4ce5-add8-09ea0e1300e7"
    ]
    "ServiceIds": [
        "ae8da28c-e8a4-4141-9df0-8c998976c691",
        "6b02d015-47ac-4c41-8e9f-5b4db61d4284"
    ],
    "LinkedReservationIds": 
    [
        "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
        "b7a3f5cb-1e69-4a5f-a069-10f461996d7f"
    ],
    "UpdatedUtc": {
        "StartUtc": "2023-04-01T00:00:00Z",
        "EndUtc": "2023-05-05T00:00:00Z"
    },
    "Limitation":{
        "Cursor": "819e3435-7d5e-441f-bc68-76d89c69b8f5", 
        "Count": 10
    }
}

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.
ProductServiceOrderIds	array of string	optional, max 1000 items	Unique identifiers of the Product service order.
ServiceIds	array of string	required, max 1000 items	Unique identifiers of the Services.
LinkedReservationIds	array of string	optional, max 1000 items	Unique identifiers of linked Reservations.
States	array of string Service order state	optional	A list of product service order states to filter by.
UpdatedUtc	Time interval	optional, max length 3 months	Interval in which the Product service orders were updated.
Limitation	Limitation	required	Limitation on the quantity of data returned.

Response

{
    "ProductServiceOrders": [
        {
            "Id": "9b59b50d-bd32-4ce5-add8-09ea0e1300e7",            
            "ServiceId": "ae8da28c-e8a4-4141-9df0-8c998976c691",
            "AccountId": "94843f6f-3be3-481b-a1c7-06458774c3df",
            "AccountType": "Customer",
            "CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
            "UpdaterProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
            "BookerId": "ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72",
            "LinkedReservationId": "9e6d4492-315b-4089-b9d6-5b1bd2eddc1b",
            "Number": "52",
            "State": "Confirmed",
            "Origin": "Connector",
            "CommanderOrigin": null,
            "OriginDetails": null,
            "CreatedUtc": "2023-04-23T14:58:02Z",
            "UpdatedUtc": "2023-04-23T14:58:02Z",
            "CancelledUtc": null,
            "VoucherId": null,
            "BusinessSegmentId": null,
            "Options": {
                "OwnerCheckedIn": true,
                "AllCompanionsCheckedIn": true,
                "AnyCompanionCheckedIn": true,
                "ConnectorCheckIn": true
            }
        }
    ],
    "Cursor": "9b59b50d-bd32-4ce5-add8-09ea0e1300e7"
}

Property	Type	Contract	Description
ProductServiceOrders	array of Product service orders	required	The product service order of the enterprise.
Cursor	string	optional	Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Product service order

Property	Type	Contract	Description
Id	string	required	Unique identifier of the product service order.
ServiceId	string	required	Unique identifier of the Service that product service order is made againts.
AccountId	string	required	Unique identifier of the Customer or a Company who owns the product service order.
AccountType	string	required	A discriminator specifying the type of account, e.g. customer or company.
CreatorProfileId	string	required	Unique identifier of the user who created the product service order.
UpdaterProfileId	string	required	Unique identifier of the user who updated the product service order.
BookerId	string	optional	Unique identifier of the Customer on whose behalf the service order was made.
Number	string	required	Confirmation number of the service order in Mews.
State	string Service order state	required	State of the product service order.
Origin	string Service order origin	required	Origin of the product service order.
CommanderOrigin	string Commander origin	optional	Further detail about origin in case of Origin Commander.
OriginDetails	string	optional	Details about the product service order Origin.
CreatedUtc	string	required	Creation date and time of the product service order in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Last update date and time of the product service order in UTC timezone in ISO 8601 format.
CancelledUtc	string	optional	Cancellation date and time in UTC timezone in ISO 8601 format.
VoucherId	string	optional	Unique identifier of the Voucher that has been used to create product service order.
BusinessSegmentId	string	optional	Identifier of the Business segment.
LinkedReservationId	string	optional	Identifier of the linked Reservation.
Options	Service order options	required	Options of the service order.

Service order options

Property	Type	Contract	Description
OwnerCheckedIn	boolean	required	Owner of the reservation checked in.
AllCompanionsCheckedIn	boolean	required	All companions of the reservation checked in.
AnyCompanionCheckedIn	boolean	required	Any of the companions of the reservation checked in.
ConnectorCheckIn	boolean	required	Check in was done via Connector API.

Service order state

• Enquired - Confirmed neither by the customer nor enterprise.

• Requested - Confirmed by the customer but not by the enterprise (waitlist).

• Optional - Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).

• Confirmed - Confirmed by both parties, before check-in.

• Started - Checked in.

• Processed - Checked out.

• Canceled - Canceled.

• ...

Service order origin

• Distributor - Service order from the Mews Booking Engine or Booking Engine API

• ChannelManager - Service order from a channel integration

• Commander - Service order from Mews Operations

• Import - Service order from an import process

• Connector - Service order from the Mews Connector API

• Navigator - Service order from Mews Guest Services

• ...

Reservation cancellation reason

• Other

• ConfirmationMissed

• BookedElsewhere

• ForceMajeure

• GuestComplaint

• NoShow

• PriceTooHigh

• ServiceNotAvailable

• InputError

• InvalidPayment

• TravelAgency

• RequestedByGuest

• Update

• BookingAbandoned

• RequestedByBooker

• ...