Requests
The Mews POS API is REST-based and follows the JSON:API specification for formatting HTTP requests and responses. All requests must include the Content-Type header set to the JSON:API media type application/vnd.api+json.
JSON:API
JSON:API is a widely-used specification for structuring API requests and responses. Understanding this format will help you effectively interact with the Mews POS API.
Key features supported
Relationships – Link resources together. Learn more about relationships.
Filtering – Narrow down results based on selected criteria. Learn more about filtering.
Sparse Fieldsets – Retrieve only the fields you need. Learn more about sparse fieldsets.
For more tools and resources:
Client Libraries – Use libraries from the JSON:API Implementations list to streamline development.
Media Type – Ensure that requests use the media type
application/vnd.api+json.
Address pattern
All operations in the Mews POS API follow a consistent URL structure:
[PlatformAddress]/v1/[Resource]/{id}PlatformAddress – The base address of the API (varies by environment: test, demo, production).
Resource – The pluralized name of the target resource (e.g. bills, reservations).
id – Unique identifier of the Resource, used only when referencing a specific Resource.
Example:
Query parameters
The Mews POS API supports query parameters for Relationships, Filtering and Sparse fieldsets.
Example:
Request body
Each request will include a header with authentication information, and a body with any data needed to perform the operation, formatted as per JSON:API. 'Get' operations, such as Get invoices, use the GET http verb and therefore do not have any data in the request body.
Last updated