Outlets

Outlets object

Get outlets

get

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

/v1/outlets

Returns a list of not deleted outlets with pagination

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

• Sparse fieldsets - supports all fields of outlet 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 outlets 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/outlets

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "2bf58012-e340-478e-a123-dbe372ac86fb",
      "type": "outlets",
      "attributes": {
        "name": "Outlet 1",
        "address1": "123 Main St",
        "address2": "Suite 100",
        "city": "Anytown",
        "state": "CA",
        "index": 1,
        "postalCode": "12345",
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-02T00:00:00Z"
      }
    }
  ],
  "links": {
    "prev": "https://api.mews-demo.com/pos/v1/outlets?page%5Bbefore%5D=NA&page%5Bsize%5D=1",
    "next": "https://api.mews-demo.com/pos/v1/outlets?page%5Bafter%5D=NA&page%5Bsize%5D=1"
  }
}