GET products/{productid}/productinventorylogs?From={From}&To={To}

This allows you to return a date filtered list of product inventorylogs

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productid Product ID of the product the logs relate to integer Required
From Optional UTC Date. Will return a list of logs created after this date date None.
To Optional UTC Date. Will return a list of logs created before this date date None.

Body Parameters

None.

Response Information

Resource Description

This allows you to return a date filtered list of product inventorylogs

Collection of ProductInventoryLogModel
NameDescriptionTypeAdditional information
ProductID The ID of the product the log relates to integer None.
UserID The ID of the user who initiated the amendment, this can be null for system operations integer None.
Date The date the log was added date None.
AdjustmentAmount The amount the inventory of the product has been adjusted by integer None.
LogReason The specified reason for the log. ReasonTypes None.
AdditionalInformationType This shows the type of reason for example a value of orders here shoes that the reason additional information will be populated with an order number Domain None.
ReasonAdditionalInformation If the log relates to stock taken by an order or added from a delivery then this will be the relevant identifier string None.
LogReasonDescription Human readable adjustment reason string None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ProductID": 1234,
    "UserID": 123,
    "Date": "2024-11-21T08:00:52.5213604Z",
    "AdjustmentAmount": 1,
    "LogReason": "ManualRelativeAdjustment",
    "AdditionalInformationType": "System",
    "ReasonAdditionalInformation": "Manual Inventory Adjustment",
    "LogReasonDescription": "Deallocated from an order"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProductInventoryLogModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductInventoryLogModel>
    <ProductID>1234</ProductID>
    <UserID>123</UserID>
    <Date>2024-11-21T08:00:52.5213604Z</Date>
    <AdjustmentAmount>1</AdjustmentAmount>
    <LogReason>ManualRelativeAdjustment</LogReason>
    <AdditionalInformationType>System</AdditionalInformationType>
    <ReasonAdditionalInformation>Manual Inventory Adjustment</ReasonAdditionalInformation>
    <LogReasonDescription>Deallocated from an order</LogReasonDescription>
  </ProductInventoryLogModel>
</ArrayOfProductInventoryLogModel>