Login
      Contents x
      /v23.1/ProductListRows
      • 05 Jun 2024
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/ProductListRows

      • Updated on 05 Jun 2024
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/ProductListRows
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      ProductListId
      integer (int32)
      ProductListTypeId
      integer (int32)
      StoreProductLocationId
      integer (int32)
      ProductId
      integer (int32)
      BrandId
      integer (int32)
      SupplierId
      integer (int32)
      ReferenceNumber
      integer (int32)
      Description
      string
      LabelClassId
      integer (int32)
      ConversionId
      integer (int64)
      ItemIds
      array of integer
      ExcludeProvidedItemIds
      boolean
      DeviantPricesOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      productListId
      integer (int32)
      parentProductListRowId
      integer (int32)
      amount
      number (double)
      productId
      integer (int32)
      storeProductLocationId
      integer (int32)
      description
      string
      note1
      string
      note2
      string
      brandId
      integer (int32)
      supplierId
      integer (int32)
      referenceNumber
      integer (int32)
      pceGrossPrice
      number (double)
      totalGrossPrice
      number (double)
      totalNetPrice
      number (double)
      discountPrice
      number (double)
      discountPercentage
      number (double)
      priceType
      string
      Valid values[ "NotSpecified", "PcePrice", "TotalPrice" ]
      weightedTotalNetPrice
      number (double)
      barcode
      integer (int64)
      barcodeText
      string
      conversionId
      integer (int64)
      productNote1
      string
      productNote2
      string
      productNote3
      string
      productNote4
      string
      productExternalCode
      string
      productNumber
      integer (int64)
      orderCode
      string
      mainBarcode
      integer (int64)
      purchasePcePrice
      number (double)
      preferredSupplierName
      string
      preferredSupplierNumber
      integer (int64)
      productDescription
      string
      brandDescription
      string
      productAdvicePrice
      number (double)
      productGrossPrice
      number (double)
      isMultiplePricing
      boolean
      Default"False"
      grossPriceDifference
      number (double)
      productPreferredSupplierId
      integer (int32)
      isSale
      boolean
      Default"False"
      storeId
      integer (int32)
      size
      string
      sizeTypeCode
      string
      sizeTypeDescription
      string
      cashRegisterGroupCode
      string
      cashRegisterGroupDescription
      string
      vatId
      integer (int32)
      vatPercentage
      number (double)
      vatCode
      string
      labelClassDescription
      string
      createdByUserFullName
      string
      lastModifiedByUserFullName
      string
      stock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openSaleOrders
      number (double)
      openPurchaseOrders
      number (double)
      openReservations
      number (double)
      allocatedStock
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      purchaseStatusCode
      string
      purchaseStatusDescription
      string
      locationLevel5Description
      string
      productCategoryDepartmentId
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      productListId
      integer (int32)
      parentProductListRowId
      integer (int32)
      amount
      number (double)
      productId
      integer (int32)
      storeProductLocationId
      integer (int32)
      description
      string
      note1
      string
      note2
      string
      brandId
      integer (int32)
      supplierId
      integer (int32)
      referenceNumber
      integer (int32)
      pceGrossPrice
      number (double)
      totalGrossPrice
      number (double)
      totalNetPrice
      number (double)
      discountPrice
      number (double)
      discountPercentage
      number (double)
      priceType
      string
      Valid values[ "NotSpecified", "PcePrice", "TotalPrice" ]
      weightedTotalNetPrice
      number (double)
      barcode
      integer (int64)
      barcodeText
      string
      conversionId
      integer (int64)
      productNote1
      string
      productNote2
      string
      productNote3
      string
      productNote4
      string
      productExternalCode
      string
      productNumber
      integer (int64)
      orderCode
      string
      mainBarcode
      integer (int64)
      purchasePcePrice
      number (double)
      preferredSupplierName
      string
      preferredSupplierNumber
      integer (int64)
      productDescription
      string
      brandDescription
      string
      productAdvicePrice
      number (double)
      productGrossPrice
      number (double)
      isMultiplePricing
      boolean
      Default"False"
      grossPriceDifference
      number (double)
      productPreferredSupplierId
      integer (int32)
      isSale
      boolean
      Default"False"
      storeId
      integer (int32)
      size
      string
      sizeTypeCode
      string
      sizeTypeDescription
      string
      cashRegisterGroupCode
      string
      cashRegisterGroupDescription
      string
      vatId
      integer (int32)
      vatPercentage
      number (double)
      vatCode
      string
      labelClassDescription
      string
      createdByUserFullName
      string
      lastModifiedByUserFullName
      string
      stock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openSaleOrders
      number (double)
      openPurchaseOrders
      number (double)
      openReservations
      number (double)
      allocatedStock
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      purchaseStatusCode
      string
      purchaseStatusDescription
      string
      locationLevel5Description
      string
      productCategoryDepartmentId
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      productListId
      integer (int32)
      parentProductListRowId
      integer (int32)
      amount
      number (double)
      productId
      integer (int32)
      storeProductLocationId
      integer (int32)
      description
      string
      note1
      string
      note2
      string
      brandId
      integer (int32)
      supplierId
      integer (int32)
      referenceNumber
      integer (int32)
      pceGrossPrice
      number (double)
      totalGrossPrice
      number (double)
      totalNetPrice
      number (double)
      discountPrice
      number (double)
      discountPercentage
      number (double)
      priceType
      string
      Valid values[ "NotSpecified", "PcePrice", "TotalPrice" ]
      weightedTotalNetPrice
      number (double)
      barcode
      integer (int64)
      barcodeText
      string
      conversionId
      integer (int64)
      productNote1
      string
      productNote2
      string
      productNote3
      string
      productNote4
      string
      productExternalCode
      string
      productNumber
      integer (int64)
      orderCode
      string
      mainBarcode
      integer (int64)
      purchasePcePrice
      number (double)
      preferredSupplierName
      string
      preferredSupplierNumber
      integer (int64)
      productDescription
      string
      brandDescription
      string
      productAdvicePrice
      number (double)
      productGrossPrice
      number (double)
      isMultiplePricing
      boolean
      Default"False"
      grossPriceDifference
      number (double)
      productPreferredSupplierId
      integer (int32)
      isSale
      boolean
      Default"False"
      storeId
      integer (int32)
      size
      string
      sizeTypeCode
      string
      sizeTypeDescription
      string
      cashRegisterGroupCode
      string
      cashRegisterGroupDescription
      string
      vatId
      integer (int32)
      vatPercentage
      number (double)
      vatCode
      string
      labelClassDescription
      string
      createdByUserFullName
      string
      lastModifiedByUserFullName
      string
      stock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openSaleOrders
      number (double)
      openPurchaseOrders
      number (double)
      openReservations
      number (double)
      allocatedStock
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      purchaseStatusCode
      string
      purchaseStatusDescription
      string
      locationLevel5Description
      string
      productCategoryDepartmentId
      integer (int32)
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout