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

      /v23.1/StoreProducts

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

      Get
      /v23.1/StoreProducts
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      BarcodeId
      integer (int32)
      ProductId
      integer (int32)
      ReplacementProductId
      integer (int32)
      SupplierId
      integer (int32)
      PreferredSupplierId
      integer (int32)
      Classification1Id
      integer (int32)
      ProductCategoryId
      integer (int32)
      CashRegisterGroupId
      integer (int32)
      BrandId
      integer (int32)
      SubBrandId
      integer (int32)
      DefaultStoreLocationId
      integer (int32)
      ModifiedStockSinceDateTime
      string (date-time)
      LastModifiedDateFrom
      string (date-time)
      LastModifiedDateTo
      string (date-time)
      PriceBlockedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsMaintainStockOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsIgnoreCancelledProducts
      string
      Valid values[ "All", "Yes", "No" ]
      IsParentShopServerStockOnly
      boolean
      IsIncludeCalculatedFields
      boolean
      Replenishable
      boolean
      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)
      storeId
      integer (int32)
      productId
      integer (int32)
      alternatePreferredSupplierId
      integer (int32)
      defaultStoreLocationId
      integer (int32)
      pickupLocationId
      integer (int32)
      grossPrice
      number (double)
      isPriceBlocked
      boolean
      Default"False"
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      locationsStock
      number (double)
      allocatedStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      openReservations
      number (double)
      openReturns
      number (double)
      openDropshipments
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      lastCashSaleRowId
      integer (int32)
      lastInvoiceSaleRowId
      integer (int32)
      lastStockChangeDateTime
      string (date-time)
      avgFifoPcePurchasePrice
      number (double)
      lastCalculatedAutoStockTotalSaleAmount
      number (double)
      lastCalculatedAutoStockSaleDays
      integer (int32)
      lastCalculatedAutoStockOldestSaleDateTime
      string (date-time)
      replenishmentUnit
      string
      Valid values[ "NotSpecified", "StockKeepingUnit", "SupplierPurchaseUnit" ]
      minReplenishmentStock
      number (double)
      maxReplenishmentStock
      number (double)
      pickupLocationDescription
      string
      preferredSupplierGeneralName
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierId
      integer (int32)
      storeNumber
      integer (int32)
      storeDescription
      string
      externalCode
      string
      productNumber
      integer (int64)
      productDescription
      string
      mainBarcode
      integer (int64)
      productCategoryId
      integer (int32)
      assortmentId
      integer (int32)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      stockedItem
      integer (int32)
      appliedGrossPrice
      number (double)
      doesMaintainStock
      boolean
      Default"False"
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      orderMultiplier
      number (double)
      orderCode
      string
      purchaseStatusRowId
      integer (int32)
      defaultDeliveryDays
      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)
      storeId
      integer (int32)
      productId
      integer (int32)
      alternatePreferredSupplierId
      integer (int32)
      defaultStoreLocationId
      integer (int32)
      pickupLocationId
      integer (int32)
      grossPrice
      number (double)
      isPriceBlocked
      boolean
      Default"False"
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      locationsStock
      number (double)
      allocatedStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      openReservations
      number (double)
      openReturns
      number (double)
      openDropshipments
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      lastCashSaleRowId
      integer (int32)
      lastInvoiceSaleRowId
      integer (int32)
      lastStockChangeDateTime
      string (date-time)
      avgFifoPcePurchasePrice
      number (double)
      lastCalculatedAutoStockTotalSaleAmount
      number (double)
      lastCalculatedAutoStockSaleDays
      integer (int32)
      lastCalculatedAutoStockOldestSaleDateTime
      string (date-time)
      replenishmentUnit
      string
      Valid values[ "NotSpecified", "StockKeepingUnit", "SupplierPurchaseUnit" ]
      minReplenishmentStock
      number (double)
      maxReplenishmentStock
      number (double)
      pickupLocationDescription
      string
      preferredSupplierGeneralName
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierId
      integer (int32)
      storeNumber
      integer (int32)
      storeDescription
      string
      externalCode
      string
      productNumber
      integer (int64)
      productDescription
      string
      mainBarcode
      integer (int64)
      productCategoryId
      integer (int32)
      assortmentId
      integer (int32)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      stockedItem
      integer (int32)
      appliedGrossPrice
      number (double)
      doesMaintainStock
      boolean
      Default"False"
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      orderMultiplier
      number (double)
      orderCode
      string
      purchaseStatusRowId
      integer (int32)
      defaultDeliveryDays
      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)
      storeId
      integer (int32)
      productId
      integer (int32)
      alternatePreferredSupplierId
      integer (int32)
      defaultStoreLocationId
      integer (int32)
      pickupLocationId
      integer (int32)
      grossPrice
      number (double)
      isPriceBlocked
      boolean
      Default"False"
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      locationsStock
      number (double)
      allocatedStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      openReservations
      number (double)
      openReturns
      number (double)
      openDropshipments
      number (double)
      manualMinMaxStock
      boolean
      Default"False"
      minimumStock
      number (double)
      maximumStock
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      limitCalculatedMinStock
      number (double)
      limitCalculatedMaxStock
      number (double)
      ignoreAutoStockValues
      boolean
      Default"False"
      autoStockMinStockPercentage
      integer (int32)
      autoStockMaxStockPercentage
      integer (int32)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      lastCashSaleRowId
      integer (int32)
      lastInvoiceSaleRowId
      integer (int32)
      lastStockChangeDateTime
      string (date-time)
      avgFifoPcePurchasePrice
      number (double)
      lastCalculatedAutoStockTotalSaleAmount
      number (double)
      lastCalculatedAutoStockSaleDays
      integer (int32)
      lastCalculatedAutoStockOldestSaleDateTime
      string (date-time)
      replenishmentUnit
      string
      Valid values[ "NotSpecified", "StockKeepingUnit", "SupplierPurchaseUnit" ]
      minReplenishmentStock
      number (double)
      maxReplenishmentStock
      number (double)
      pickupLocationDescription
      string
      preferredSupplierGeneralName
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierId
      integer (int32)
      storeNumber
      integer (int32)
      storeDescription
      string
      externalCode
      string
      productNumber
      integer (int64)
      productDescription
      string
      mainBarcode
      integer (int64)
      productCategoryId
      integer (int32)
      assortmentId
      integer (int32)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      stockedItem
      integer (int32)
      appliedGrossPrice
      number (double)
      doesMaintainStock
      boolean
      Default"False"
      purchasePricePerAmount
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      orderMultiplier
      number (double)
      orderCode
      string
      purchaseStatusRowId
      integer (int32)
      defaultDeliveryDays
      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