Orders
Add order
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
[PlatformAddress]/api/connector/v1/orders/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the Enterprise. Required when using a Portfolio Access Token, ignored otherwise. |
|
|
|
|
| string | required | |
| string | required | Identifier of the Service to be ordered. |
| string | optional | 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. |
| string | optional | Identifier of the Reservation to which the created order will be linked. |
| string | optional | 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 |
| string | optional | Additional notes of the order. |
| array of Product order parameters | optional | Parameters of the ordered products. |
| array of Item parameters | optional | Parameters of the ordered custom items. |
Product order parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Product to be ordered. |
| number | optional | Count of products to be ordered, e.g. 10 in case of 10 beers. |
| optional | Unit amount of the product that overrides the amount defined in Mews. | |
| string | optional | Product start in UTC timezone in ISO 8601 format. For products with charging |
| string | optional | Product end in UTC timezone in ISO 8601 format. For products with charging |
Item parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Name of the item. |
| number | required | Count of units to be ordered, e.g. 10 in case of 10 beers. |
| required | Unit amount, e.g. amount for one beer (note that total amount of the item is therefore | |
| string | optional | Unique identifier of an Accounting category to be assigned to the item. |
Amount parameters
Property | Type | Contract | Description |
---|---|---|---|
| decimal | optional | Amount including tax. Required for Gross Pricing environments. |
| decimal | optional | Amount excluding tax. Required for Net Pricing environments. |
| string | required | ISO-4217 code of the Currency. |
| array of string | required | Codes of Tax rates to be applied to the item. (Note, you can only define one tax when sending |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the created order. |
Last updated