Products

Get list all products.

get/products

Request

Base URL
https://openapi.flowaccount.com/v1
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/flowaccount/apis/flowaccount-open-api/docs/products/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 Example (Encode) Pattern: <ex> /products?sortBy=[{'name':'productCode','sortOrder':'asc'}]</ex>

filterstring

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

searchStringinteger

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

{
  "data": {
    "list": [
      {
        "code": "P001",
        "name": "Product",
        "inventoryPublishedOn": "2021-01-01"
      }
    ]
  }
}

Changes

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