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

          /v23.1/StoreProducts

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

          Post
          /v23.1/StoreProducts
          Security
          HTTP
          Type Bearer

          Please enter a valid token

          Body parameters
          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)
          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)
          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)
          Responses
          200

          Success

          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)
          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)
          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)
          400

          Bad Request

          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          Collapse all
          object
          type
          string
          message
          string
          stackTrace
          string
          validationExceptions
          Array of object (ValidationExceptionRow)
          object
          errorCode
          string
          errorMessage
          string
          severity
          string
          propertyName
          string
          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
          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