/v23.1/StoreProductLocations
  • 05 Jun 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/StoreProductLocations

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/StoreProductLocations
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
StoreId
integer (int32)
ProductId
integer (int32)
LocationLevel1Id
integer (int32)
LocationLevel2Id
integer (int32)
LocationLevel3Id
integer (int32)
LocationLevel4Id
integer (int32)
LocationLevel5Id
integer (int32)
NoInventoryDays
integer (int32)
NoOrderPickingDays
integer (int32)
NoReceivedArticleDays
integer (int32)
NoStockMovementDays
integer (int32)
NoStockAdjustmentDays
integer (int32)
IsIncludeStats
boolean
StatsStockAdjustmentType
string
Valid values[ "NotSpecified", "ManualStockAdjustment", "ProcessInventories", "BulkUpdateToZero", "StockDelta" ]
LocationPurpose
string
Valid values[ "NotSpecified", "PickLocation", "BulkLocation", "StorageLocation" ]
ProductsFilter.IsHeadOfficeRequest
boolean
ProductsFilter.ExternalProductId
integer (int32)
ProductsFilter.ParentProductId
integer (int32)
ProductsFilter.StoreId
integer (int32)
ProductsFilter.AlternateStockStoreId
integer (int32)
ProductsFilter.StoreTypeId
integer (int32)
ProductsFilter.ProductNumber
integer (int64)
ProductsFilter.ExternalCode
string
ProductsFilter.ProductType
string
Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
ProductsFilter.Plu
integer (int32)
ProductsFilter.SearchText
string
ProductsFilter.Description
string
ProductsFilter.Note1
string
ProductsFilter.ClassificationLevel1Id
integer (int32)
ProductsFilter.ClassificationLevel2Id
integer (int32)
ProductsFilter.ClassificationLevel3Id
integer (int32)
ProductsFilter.ClassificationLevel4Id
integer (int32)
ProductsFilter.ClassificationLevel5Id
integer (int32)
ProductsFilter.ClassificationGroupId
integer (int32)
ProductsFilter.ProductCategoryId
integer (int32)
ProductsFilter.BrandId
integer (int32)
ProductsFilter.SubBrandId
integer (int32)
ProductsFilter.BasketGroupId
integer (int32)
ProductsFilter.DisposalFeeId
integer (int32)
ProductsFilter.ReplacementProductId
integer (int32)
ProductsFilter.OrderMethod
string
Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
ProductsFilter.FashionProduct
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.SaleArticle
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.PriceBlocked
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.ReplacedProducts
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.AreReplacedProducts
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.CollectionProducts
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.AtLeast1NotCancelledPurchase
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.AtLeast1AvailableForOrderingPurchase
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.PreferredSupplierId
integer (int32)
ProductsFilter.AssortmentIds
string
ProductsFilter.ArticleGroupId
integer (int32)
ProductsFilter.SizeTypeId
integer (int32)
ProductsFilter.SizeId
integer (int32)
ProductsFilter.ColorId
integer (int32)
ProductsFilter.Barcode
integer (int64)
ProductsFilter.BarcodeText
string
ProductsFilter.PassiveBarcodeOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.CountryId
integer (int32)
ProductsFilter.LanguageId
integer (int32)
ProductsFilter.SupplierId
integer (int32)
ProductsFilter.IsIgnoreSupplierIdForProductsWithNoSupplier
boolean
ProductsFilter.OrderCode
string
ProductsFilter.OrderCodeIgnoreSpecialCharacters
boolean
ProductsFilter.PurchaseUnitBarcode
integer (int64)
ProductsFilter.CollectionIdentifier
integer (int64)
ProductsFilter.CollectionBarcode
integer (int64)
ProductsFilter.StandbyProductExternalCode
string
ProductsFilter.CashRegisterGroupId
integer (int32)
ProductsFilter.VatId
integer (int32)
ProductsFilter.DiscountFilter
string
Valid values[ "All", "AllDiscounts", "NoDiscounts", "QuantityPriceBreaks", "MixedMatches" ]
ProductsFilter.LastModifiedSinceDateTime
string (date-time)
ProductsFilter.LastModifiedUntilDateTime
string (date-time)
ProductsFilter.IsStockModification
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.StockModificationDateFrom
string (date-time)
ProductsFilter.StockModificationDateTo
string (date-time)
ProductsFilter.IsIncludeInStockValue
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsAllowMultiplePricing
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsProductGroup
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsConsignmentProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.ProductState
string
Valid values[ "NotSpecified", "OrganizationOnly", "DerivedOnly", "LocalOnly", "LocalAndDerivedOnly" ]
ProductsFilter.IsParentProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsIncludeParentProducts
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsColorProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsSmartSearch
boolean
ProductsFilter.IsWebshopProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsIgnoreCancelledProducts
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsHasNote1Only
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.WithImageOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.Stock
number (double)
ProductsFilter.StockFilter
string
Valid values[ "NotSpecified", "Unequal", "Greater", "GreaterEqual", "Equal", "LowerEqual", "Lower" ]
ProductsFilter.FreeStock
number (double)
ProductsFilter.FreeStockFilter
string
Valid values[ "NotSpecified", "Unequal", "Greater", "GreaterEqual", "Equal", "LowerEqual", "Lower" ]
ProductsFilter.IsAutoOrderOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsGiftCardOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.GiftCardTypeId
integer (int32)
ProductsFilter.PurchaseIsActiveOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.PurchaseSeasonProfileId
integer (int32)
ProductsFilter.PurchaseStoreTypeDifferentationId
integer (int32)
ProductsFilter.PurchaseAssortmentId
integer (int32)
ProductsFilter.GetArticlesOfCancelledSuppliers
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.ShelfProductsAndLocalOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IncludedInActiveShelfDisplay
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.ShelfDisplayId
integer (int32)
ProductsFilter.RelatedProductsType
string
Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
ProductsFilter.EslProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.EslBarcode
string
ProductsFilter.StandbyProductsOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.IsActiveOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.DeletedOnly
string
Valid values[ "All", "Yes", "No" ]
ProductsFilter.FieldsToReturn
string
ProductsFilter.Offset
integer (int32)
ProductsFilter.RecordCount
integer (int32)
ProductsFilter.ItemId
integer (int32)
ProductsFilter.IncludeItemId
integer (int32)
ProductsFilter.ExcludeItemId
integer (int32)
ProductsFilter.ModifiedSinceDateTime
string (date-time)
Offset
integer (int32)
RecordCount
integer (int32)
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)
locationLevel5Id
integer (int32)
stock
number (double)
productNumber
integer (int64)
productDescription
string
productMainBarcode
integer (int64)
locationCode
string
locationPurpose
string
Valid values[ "NotSpecified", "PickLocation", "BulkLocation", "StorageLocation" ]
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)
locationLevel5Id
integer (int32)
stock
number (double)
productNumber
integer (int64)
productDescription
string
productMainBarcode
integer (int64)
locationCode
string
locationPurpose
string
Valid values[ "NotSpecified", "PickLocation", "BulkLocation", "StorageLocation" ]
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)
locationLevel5Id
integer (int32)
stock
number (double)
productNumber
integer (int64)
productDescription
string
productMainBarcode
integer (int64)
locationCode
string
locationPurpose
string
Valid values[ "NotSpecified", "PickLocation", "BulkLocation", "StorageLocation" ]
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?

Changing your password will log you out immediately. Use the new password to log back in.
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.