List supplier products

POST /PIM/Vendor/Products — PIM API · Supplier Products

Returns filtered and paginated supplier products. The fields to return are determined by SelectedColumns and filtering by FilteredColumns.

  • isPre=true: candidate products sent by the supplier (pre-approval and approved supplier records). Used by supplier and ERP users.
  • isPre=false (default): main products in PIM. Only admin users can call; others receive 500.
  • PageSize can be at most 1000; Page starts from 1.
  • TotalPage and TotalProduct are filled only in Page: 1 requests.

Common columns: merchantSku, merchantBarcode, vendorCode, supplierId, isApproved, isRejected, externalBarcode, externalCode, listPrice, salePrice, stock, assetid and PIM attribute keys. To find approved products without ERP barcode, use filter isApproved = true and hasExternalBarcode = false.

Parametreler

  • isPre (query, boolean): true: supplier candidate product tables; false: PIM main products (admin only).
  • includeParents (query, boolean): If true, values from parent records of SKUs (model/option) are also included in columns.
  • Tenant (header, string): Company code for users accessing multiple companies via Basic Auth. Not needed if using Bearer token.

İstek gövdesi

  • Page (integer): Page number (starting from 1).
  • PageSize (integer): Number of products per page (maximum 1000).
  • SortedColumn (object): Sorting; default sorting is used if not sent.
    • SortedColumn.Type (string): Sort direction (asc or desc).
    • SortedColumn.Column (string): Column name to sort by.
  • FilteredColumns (object[]): Filters; all applied together (AND).
    • FilteredColumns.Type (integer): Match type: 0 exact match, 1 contains.
    • FilteredColumns.Value (any, zorunlu): Value to search for (text, number, or boolean).
    • FilteredColumns.Column (string, zorunlu): Column name to filter on (e.g. isApproved, hasExternalBarcode, merchantSku).
  • SelectedColumns (string[], zorunlu): Column names to return in Columns in the response.

Yanıtlar

  • 200: Paginated product list.
  • 400: Request body is not valid JSON or field types are incompatible.
  • 401: Authentication failed (missing header, incorrect Basic info, or invalid token). Body is empty.
  • 500: invalid page, pagesize exceeded. max: 1000 or unauthorized isPre=false call.

200 yanıt alanları

  • Products (object[]): Products on this page.
    • Products.Id (integer): Product ID.
    • Products.Sku (string): SKU code.
    • Products.Type (integer): Product type (1 Model, 2 Option, 3 SKU, 4 Single, 5 Bundle).
    • Products.Model (string): Model code.
    • Products.Option (string): Option code.
    • Products.Barcode (string): Barcode.
    • Products.Columns (object[]): Values of selected columns.
      • Products.Columns.Value (string): Value (as text).
      • Products.Columns.Column (string): Column name.
      • Products.Columns.Culture (string): Language of the value.
    • Products.CreatedOn (string): Creation time (yyyy-MM-dd HH:mm:ss).
    • Products.CreateDate (string<date-time>): Not used; returns fixed default value. Use CreatedOn field.
    • Products.ModifiedOn (string): Last update time (yyyy-MM-dd HH:mm:ss).
    • Products.LastBarcode (string): Most recently added barcode to the product.
  • TotalPage (integer): Total number of pages; filled only in Page: 1 request.
  • TotalProduct (integer): Total products matching the filter; filled only in Page: 1 request.