v3

latestOpenAPI 3.0.42026-07-312008682.1 MB

Orders

Add order

Creates a new order, with the specified products and items. If the product being posted already exists in Mews, then use ProductOrders. If the product does not exist in Mews, then use Items. If the time of consumption is specified, this must be either in the future or within the Editable History Interval for the enterprise. Compared to a stay service order (i.e. a reservation), which is consumed over certain span of time, a product service order is consumed at a single point in time. Note this operation supports Portfolio Access Tokens.

Linking orders to reservations

Specify parameter LinkedReservationId in order to link the order to a guest reservation. This will greatly assist the property when using billing automation. This parameter is also a prerequisite for the Allowances flow; without linking the order to the correct reservation, Allowances will not apply to those items. If this parameter is not set, Mews will attempt to predict the linked reservation, but accuracy cannot be guaranteed.

post/api/connector/v1/orders/add

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.

EnterpriseIdstring uuid nullable

Unique identifier of the Enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

ServiceIdstring uuid required

Identifier of the Service to be ordered.

AccountIdstring uuid required

Identifier of the Customer or Company to be charged. Company billing may not be enabled for your integration.

CustomerIdstring uuid nullable

Identifier of the Customer to be charged. Deprecated!

ConsumptionUtcstring date-time nullable

Date and time of the order consumption in UTC timezone in ISO 8601 format. If not specified, current date and time is used. Please note, as order consumption is one-time event, the optional parameters StartUtc and EndUtc in ProductOrders should not be used.

Notesstring nullable

Additional notes of the order.

BusinessSegmentIdstring uuid nullable

Unique identifier of the business segment.

BillIdstring uuid nullable

Identifier of the Bill to which the created order will be assigned. The bill needs to be issued to the same account as the order.

LinkedReservationIdstring uuid nullable

Identifier of the Reservation to which the created order will be linked.

Response

OrderIdstring uuid

Unique identifier of the created order.