Registers

Register object

Get registers

get

https://api.mews.com/poshttps://api.mews-demo.com/pos

/v1/registers

This operation returns a list of registers.

Note: This operation needs Authentication and supports the following JSON:API features:

• Relationships - outlet using include query parameter.

• Sparse fieldsets - supports all fields of registers and related resources with fields query parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters

page[size]integer · int32 · min: 1 · max: 1000Optional

The number of resources to return in a single response.

page[before]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$

page[after]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$

Responses

200

Successful response with registers data in JSON:API format.

application/vnd.api+json

400

Bad request.

application/vnd.api+json

401

Unauthorized.

application/vnd.api+json

429

Too many requests.

application/vnd.api+json

500

Internal Server Error.

application/vnd.api+json

503

Service is unavailable.

application/vnd.api+json

get

/v1/registers

HTTPcURLJavaScriptPython

GET /pos/v1/registers HTTP/1.1
Host: api.mews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "5a43b8fa-8029-4093-895b-bddd8c74ebe1",
      "type": "registers",
      "attributes": {
        "name": "Register 1",
        "invoicesCount": 5,
        "index": 1,
        "virtual": true,
        "createdAt": "2023-10-16T14:30:00Z",
        "updatedAt": "2023-10-16T14:30:00Z"
      },
      "relationships": {
        "outlet": {
          "data": {
            "id": "2bf58012-e340-478e-a123-dbe372ac86fb",
            "type": "outlets"
          }
        }
      },
      "links": {
        "self": "https://api.mews-demo.com/pos/v1/registers/5a43b8fa-8029-4093-895b-bddd8c74ebe1"
      }
    }
  ],
  "links": {
    "prev": "https://api.mews-demo.com/pos/v1/registers?page%5Bbefore%5D=NA&page%5Bsize%5D=1",
    "next": "https://api.mews-demo.com/pos/v1/registers?page%5Bafter%5D=NA&page%5Bsize%5D=1"
  }
}

Get register

get

https://api.mews.com/poshttps://api.mews-demo.com/pos

/v1/registers/{id}

A register represents a terminal or cash register within an outlet, used to issue invoices. Each register is uniquely identified within its outlet and can either be physical or virtual.

Note: This operation needs Authentication and supports the following JSON:API features:

• Relationships - outlet using include query parameter.

• Sparse fieldsets - supports all fields of register and related resources with fields query parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path parameters

idstring · uuid · min: 36 · max: 36Required

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64

Query parameters

includestring[] · max: 1Optional

include query parameter to allow the client to customize which related resource should be returned.

Responses

200

Successful response with registers data in JSON:API format.

application/vnd.api+json

400

Bad request.

application/vnd.api+json

401

Unauthorized.

application/vnd.api+json

429

Too many requests.

application/vnd.api+json

500

Internal Server Error.

application/vnd.api+json

503

Service is unavailable.

application/vnd.api+json

get

/v1/registers/{id}

HTTPcURLJavaScriptPython

GET /pos/v1/registers/{id} HTTP/1.1
Host: api.mews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "31b14937-2524-491f-b0a0-dc0a7393ff3f",
    "type": "registers",
    "attributes": {
      "name": "Main Register",
      "invoicesCount": 1200,
      "index": 3,
      "virtual": false,
      "createdAt": "2023-10-16T14:30:00Z",
      "updatedAt": "2023-10-19T14:30:00Z"
    },
    "relationships": {
      "outlet": {
        "data": {
          "id": "5efa8b3c-b930-4b31-918d-95ab0e212e64",
          "type": "outlets"
        }
      }
    },
    "links": {
      "self": "https://api.mews-demo.com/pos/v1/registers/31b14937-2524-491f-b0a0-dc0a7393ff3f"
    }
  }
}