Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Add order
  • Request
  • Response

Was this helpful?

  1. API Operations

Orders

PreviousOrder itemsNextOutlet bills

Last updated 1 month ago

Was this helpful?

Add order

Creates a new order, with the specified products and items. If the product being posted already exists in Mews, then use . If the product does not exist in Mews, then use . 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 .

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.

Request

[PlatformAddress]/api/connector/v1/orders/add

{
    "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",
    "LinkedReservationId": "6c576c9f-653f-4034-8e31-ecb108de9ac5",
    "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"
        }
    ]
}
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.

EnterpriseId

string

optional

CustomerId

string

required

AccountId

string

required

ServiceId

string

required

BillId

string

optional

LinkedReservationId

string

optional

ConsumptionUtc

string

optional

Notes

string

optional

Additional notes of the order.

ProductOrders

optional

Parameters of the ordered products.

Items

optional

Parameters of the ordered custom items.

Product order parameters

Property
Type
Contract
Description

ProductId

string

required

Count

number

optional

Count of products to be ordered, e.g. 10 in case of 10 beers.

UnitAmount

optional

Unit amount of the product that overrides the amount defined in Mews.

StartUtc

string

optional

EndUtc

string

optional

Item parameters

Property
Type
Contract
Description

Name

string

required

Name of the item.

UnitCount

number

required

Count of units to be ordered, e.g. 10 in case of 10 beers.

UnitAmount

required

Unit amount, e.g. amount for one beer (note that total amount of the item is therefore UnitAmount times UnitCount).

AccountingCategoryId

string

optional

Response

{
    "OrderId": "cdfd5caa-2868-411b-ba95-322e70035f1a"
}
Property
Type
Contract
Description

OrderId

string

required

Unique identifier of the created order.

Unique identifier of the . Required when using a , ignored otherwise.

Identifier of the to be charged. Deprecated!

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

Identifier of the to be ordered.

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

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

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 should not be used.

array of

array of

Unique identifier of the to be ordered.

Product start in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as EndUtc. Use only with operation or , can be omitted for operation.

Product end in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as StartUtc. Use only with operation or , can be omitted for operation.

Unique identifier of an to be assigned to the item.

Portfolio Access Tokens
Product order parameters
Item parameters
Amount parameters
Product order parameters
Product order parameters
Item parameters
Portfolio Access Token
Add order
Add order
Enterprise
Service
Company
Amount parameters
Accounting category
Product
Reservation
Add reservations
Add reservation product
Add reservations
Add reservation product
Customer
Customer
Bill