Products

Products object

Get products

get

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

/v1/products

This operation returns a list of products.

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

• Relationships - productType, modifierSets, productVariants using include query parameter.

• Sparse fieldsets - supports all fields of product 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-]+$

filter[updatedAtGt]any ofOptional

Filters the objects that were updated after a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16

filter[updatedAtGteq]any ofOptional

Filters the objects that were updated after or on a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16

Responses

200

Successful response with products 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/products

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "286ef74f-e37f-477f-bcda-77f8fbfd13ea",
      "type": "products",
      "attributes": {
        "name": "Product Number One",
        "description": "Description of product number one.",
        "sku": "ABC-123-HR-K",
        "status": "active",
        "barcode": "1234567890",
        "isAvailable": true,
        "createdAt": "2022-10-16T11:29:00Z",
        "updatedAt": "2022-10-19T11:29:00Z",
        "tax": "2.00",
        "retailPriceInclTax": "10.00",
        "retailPriceExclTax": "8.00"
      },
      "relationships": {
        "productType": {
          "data": {
            "id": "c53372e2-9aa1-452a-8965-2ea3fa514fb2",
            "type": "productTypes"
          }
        },
        "taxes": {
          "data": [
            {
              "id": "5efa8b3c-b930-4b31-918d-95ab0e212e64",
              "type": "taxes"
            }
          ]
        },
        "modifierSets": {
          "data": [
            {
              "id": "06382148-c76a-489d-b382-72fb7d7ab37b",
              "type": "modifierSets"
            },
            {
              "id": "e727124a-d2bb-4002-98bd-81af6d788666",
              "type": "modifierSets"
            }
          ]
        },
        "modifiers": {
          "data": [
            {
              "id": "0907e6d2-62c1-44cd-a886-f403ce9c7145",
              "type": "modifiers"
            },
            {
              "id": "0d4e4ec6-118f-47a6-9040-b68abbec0575",
              "type": "modifiers"
            }
          ]
        },
        "productVariants": {
          "data": [
            {
              "id": "0907e6d2-62c1-44cd-a886-f403ce9c7145",
              "type": "productVariants"
            },
            {
              "id": "0d4e4ec6-118f-47a6-9040-b68abbec0575",
              "type": "productVariants"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "prev": "https://api.mews-demo.com/pos/v1/products?page%5Bbefore%5D=NA&page%5Bsize%5D=1",
    "next": "https://api.mews-demo.com/pos/v1/products?page%5Bafter%5D=NA&page%5Bsize%5D=1"
  }
}

Get product

get

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

/v1/products/{id}

This operation returns a single product by its unique identifier.

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

• Relationships - productType, modifierSets, modifiers, productVariants, taxes, dietaryRestrictions, allergens using include query parameter.

• Sparse fieldsets - supports all fields of product 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

Responses

200

Successful response with product data in JSON:API format.

application/vnd.api+json

400

Bad request.

application/vnd.api+json

401

Unauthorized.

application/vnd.api+json

404

Product not found.

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/products/{id}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "id": "286ef74f-e37f-477f-bcda-77f8fbfd13ea",
    "type": "products",
    "attributes": {
      "name": "Product Number One",
      "description": "Description of product number one.",
      "sku": "ABC-123-HR-K",
      "status": "active",
      "barcode": "1234567890",
      "isAvailable": true,
      "createdAt": "2022-10-16T11:29:00Z",
      "updatedAt": "2022-10-19T11:29:00Z",
      "tax": "2.00",
      "retailPriceInclTax": "10.00",
      "retailPriceExclTax": "8.00"
    },
    "relationships": {
      "productType": {
        "data": {
          "id": "c53372e2-9aa1-452a-8965-2ea3fa514fb2",
          "type": "productTypes"
        }
      },
      "taxes": {
        "data": [
          {
            "id": "5efa8b3c-b930-4b31-918d-95ab0e212e64",
            "type": "taxes"
          }
        ]
      },
      "modifierSets": {
        "data": [
          {
            "id": "06382148-c76a-489d-b382-72fb7d7ab37b",
            "type": "modifierSets"
          },
          {
            "id": "e727124a-d2bb-4002-98bd-81af6d788666",
            "type": "modifierSets"
          }
        ]
      },
      "modifiers": {
        "data": [
          {
            "id": "0907e6d2-62c1-44cd-a886-f403ce9c7145",
            "type": "modifiers"
          },
          {
            "id": "0d4e4ec6-118f-47a6-9040-b68abbec0575",
            "type": "modifiers"
          }
        ]
      },
      "productVariants": {
        "data": [
          {
            "id": "0907e6d2-62c1-44cd-a886-f403ce9c7145",
            "type": "productVariants"
          },
          {
            "id": "0d4e4ec6-118f-47a6-9040-b68abbec0575",
            "type": "productVariants"
          }
        ]
      }
    },
    "links": {
      "self": "https://api.mews-demo.com/pos/v1/products/286ef74f-e37f-477f-bcda-77f8fbfd13ea"
    }
  }
}