Add order
POST /api/connector/v1/orders/add
Creates a new order, with the specified products and items. If the time of consumption is specified, it 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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise.
Identifier of the Service to be ordered.
Identifier of the Customer to be charged. Deprecated!
object
Parameters of the ordered products.
object
Price of the product that overrides the price defined in Mews.
object
Parameters of the ordered custom items.
object
Price of the product that overrides the price defined in Mews.
object
object
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 Product order parameters should not be used.
Additional notes of the order.
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.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "7059D2C25BF64EA681ACAB3A00B859CC-D91BFF2B1E3047A3E0DEC1D57BE1382", "Client": "Sample Client 1.0.0", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AccountId": "407a26f8-dcfc-4e29-b978-ab440117a153", "ServiceId": "d2129910-1da9-4d39-be14-ab3a00c9e70c", "BillId": "22b68915-05fe-4a31-b1cb-bd5efa35d305", "ConsumptionUtc": "2020-02-04T00:00:00Z", "ProductOrders": [ { "ProductId": "2eb7ad8b-8dfb-4381-aba5-ab58009f2993", "Count": 2 } ], "Items": [ { "Name": "Beer", "UnitCount": 3, "UnitAmount": { "Currency": "USD", "NetValue": 7, "TaxCodes": [ "US-DC-G" ] }, "AccountingCategoryId": "90eff5aa-36b4-4689-80c0-ab3a00bb412e" } ]}Responses
Section titled “ Responses ”OK
object
Unique identifier of the created order.
Example
{ "OrderId": "cdfd5caa-2868-411b-ba95-322e70035f1a"}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.