Product Master

Get all Product Masters

get/product-masters

Request

Base URL
https://openapi.flowaccount.com/v1
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/flowaccount/apis/flowaccount-open-api/docs/product-masters/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

currentPageinteger

Query current page products item. Example Pattern: <ex>/products?currentPage=1 </ex> <ex>/products?currentPage=1&pageSize=20</ex>

pageSizeinteger

Query products list amount per page. Example Pattern: <ex> /products?pageSize=20 </ex>

sortBystring

Product Sort By (Encode) name: name = Product master name type = Product master type productCode = Product master Code / SKU categoryId = Product master category sortOrder: asc = Ascending desc = Descending Example Pattern: <ex> /products?sortBy=[{'name':'productCode','sortOrder':'asc'}]</ex>

filterstring

Product Filter (Encode) columnName: name = Product master name type = Product master type productCode = Product master Code / SKU categoryId = Product master category Example Pattern: <ex> /products?filter=[{'columnName':'categoryId','columnValue':'517727','columnPredicateOperator':'And'}]</ex>

searchStringstring

Query products name or code. Example Pattern: <ex> /products?searchString=001 product </ex>

Headers

Authorizationstring required

Response

200 response

statusboolean

action success

messagestring

error message

codeinteger

error code

Example response

{
  "status": true,
  "data": {
    "total": 10,
    "currentPage": 1,
    "list": [
      {
        "id": 12345,
        "type": 1,
        "name": "Product Master Service",
        "categoryId": 10,
        "categoryName": "Description Product Master Service",
        "sellSettings": {
          "vatType": 1,
          "description": "Sell vat type settings description"
        },
        "buySettings": {
          "vatType": 7
        },
        "mainProductId": 456,
        "mainUnitId": 789,
        "mainUnitName": "ครั้ง",
        "productLists": [
          {
            "id": 456,
            "unitId": 789,
            "unitName": "ครั้ง",
            "isMainProduct": true,
            "sellPrice": 9345.794393,
            "sellPriceWithVat": 10000,
            "barcode": "SERVICE",
            "convertRatio": 1
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.