API Services
API Services

Products

This API allows you to retrieve detailed product information including code, name, unit, category, group, and more. It supports advanced filtering and is language-aware.

Base URL

The base URL is environment-dependent: 

https://{host}/pls/{app}/products

Not: Replace {host} ve {app} with your actual server and application identifiers.

Note: Replace {host} and {app} with your actual server and application identifiers.

Request Method

GET

Query Parameters

ParameterTypeUsageDescriptionExample
apikey string Required API Key assigned to you xxxxxxxxxxxxxxxxxxxxxxxxxxxx
lang string Optional Language code. Options: TR, EN, DE. Default: TR EN
productcode string Optional Product code or expression to filter products A1000, A1000~GT, A1000~RNG~A3000
addbeg date Optional Start of product creation date range (YYYY-MM-DD) 2024-01-01
addend date Optional End of product creation date range 2025-01-01
updbeg date Optional Start of product last update date range 2025-01-01
updend date Optional End of product last update date range 2025-12-31
maxrec integer Optional Maximum number of records to return. Default: 1000 100

Filtering Syntax for productcode

The productcode parameter supports rich filtering syntax:

NotationMeaningExample
ABC123Exact matchproductcode=ABC123
ABC~LKStarts with ABCproductcode=ABC~LK
ABC~NLKDoes not start with ABCproductcode=ABC~NLK
ABC~GTGreater than start with ABCproductcode=ABC~GT
ABC~GTEGreater than or equal start with productcode=ABC~GTE
ABC~LTLess than start with productcode=ABC~LT
ABC~LTELess than or equal start with productcode=ABC~LTE
ABC~RNG~XYZBetween ABC and XYZproductcode=ABC~RNG~XYZ
A1000,B2000,C3000In listproductcode=A1000,B2000

Example Request

GET https://sys.nixla.com/pls/web/products?apikey=xxxxxxxxxxxxxxxxxxxxxxxxx&lang=EN&productcode=A1000~LK

Sample Response

[
  {
    "productID": "VM944019",
    "productCode": "AIR_01",
    "productName": "Air Pods 3rd Gen",
    "productName2": null,
    "uomCode": "EACH",
    "uomName": "Piece",
    "objTypeCode": "TRG",
    "objTypeName": "Trade Good",
    "productTypeCode": "GNL",
    "productTypeName": "General",
    "productGroupCode": "ADV",
    "productGroupName": "Promotional Material",
    "productCatCode": null,
    "productCatName": null,
    "addDate": "2015-01-01",
    "updDate": "2025-07-23"
  }
]

Notes

  • All text comparisons are case-insensitive and use Oracle NLS sort options.
  • If no parameters are provided, up to 1000 products will be returned.
  • Response is in JSON array format; each object represents a product.

Error Handling

  • 401 Unauthorized - Invalid or missing API key.
  • 400 Bad Request - Invalid date or filter format.
  • 500 Server Error - Internal system issue.

Contact

For API access or technical support, contact support@nixla.com
Contact Us