Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProcessStockMutationFile

Processes a (delta)stock mutation file.

Expected format of the file is JSON with the following markup:

[
  {
    "ProductID": [Optional, int],
    "ProductBackendID": [Optional, string],
    "QuantityOnHand": [Required, int, value >= 0]
  },
  ...
]

Mutation will only be processed for valid ProductIDs or ProductBackendIDs. In case ProductID and ProductBackendID are provided, ProductBackendID will be selected as the search parameter.

Hierarchy

  • ProcessStockMutationFile

Index

Properties

Optional BackendSystemID

BackendSystemID: undefined | string

The BackendSystemID that belongs to the ProductBackendIDs

Optional EmailAddress

EmailAddress: undefined | string

An email address to mail the processing result to. When left empty, the logged in user context will be used

FileBlobID

FileBlobID: string

Optional IsFullStockMutationFile

IsFullStockMutationFile: undefined | false | true

If set to false (default), only the stock for the products that are present in the file will be updated (delta).

If set to true, all the products will be updated - products not present in the file will be updated to quantity 0.

default

false

Optional OrganizationUnitID

OrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional StockLabelID

StockLabelID: undefined | number

Entity type: StockLabel

Optional StockMutationReasonID

StockMutationReasonID: undefined | number

Entity type: StockMutationReasons