GET products/productsinventorylogs?From={From}&To={To}&PageSize={PageSize}&Page={Page}
This allows you to return a date filtered list of products inventorylogs
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
From | Will return a list of logs created after this date Field is required and cannot be after the To date DateRange between From and To cannot be more than 31 days | date | Required |
To | Will return a list of logs created before this date Field is required and cannot be before the From date DateRange between From and To cannot be more than 31 days | date | Required |
PageSize | This is an optional parameter. This will default to 1 000. The max page size is 10 000. | integer | Range: inclusive between 1 and 10000 |
Page | This is an optional parameter. It will default to page 1. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
Body Parameters
None.
Response Information
Resource Description
This allows you to return a date filtered list of products inventorylogs
ProductsInventoryLogModelCollectionName | Description | Type | Additional information |
---|---|---|---|
TotalItems | The total amount of items. | integer | None. |
PageSize | The paging setting used on this request. | integer | None. |
Page | The paging setting used on this request. | integer | None. |
TotalPages | The total amount of pages to be returned | integer | None. |
Data | The results of the call. | Collection of ProductInventoryLogModel | None. |
Response Formats
application/json, text/json
Sample:
{ "TotalItems": 3, "PageSize": 3, "Page": 1, "TotalPages": 1, "Data": [ { "ProductID": 1234, "UserID": 123, "Date": "2024-10-30T06:00:50.322594Z", "AdjustmentAmount": 1, "LogReason": "ManualRelativeAdjustment", "AdditionalInformationType": "Orders", "ReasonAdditionalInformation": "1234567", "LogReasonDescription": "Deallocated from an order" }, { "ProductID": 1234, "UserID": 123, "Date": "2024-10-30T06:00:50.322594Z", "AdjustmentAmount": 1, "LogReason": "ManualRelativeAdjustment", "AdditionalInformationType": "Orders", "ReasonAdditionalInformation": "1234567", "LogReasonDescription": "Deallocated from an order" }, { "ProductID": 1234, "UserID": 123, "Date": "2024-10-30T06:00:50.322594Z", "AdjustmentAmount": 1, "LogReason": "ManualRelativeAdjustment", "AdditionalInformationType": "Orders", "ReasonAdditionalInformation": "1234567", "LogReasonDescription": "Deallocated from an order" } ] }
application/xml, text/xml
Sample:
<ProductsInventoryLogModelCollection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TotalItems>3</TotalItems> <PageSize>3</PageSize> <Page>1</Page> <TotalPages>1</TotalPages> <Data> <ProductInventoryLogModel> <ProductID>1234</ProductID> <UserID>123</UserID> <Date>2024-10-30T06:00:50.322594Z</Date> <AdjustmentAmount>1</AdjustmentAmount> <LogReason>ManualRelativeAdjustment</LogReason> <AdditionalInformationType>Orders</AdditionalInformationType> <ReasonAdditionalInformation>1234567</ReasonAdditionalInformation> <LogReasonDescription>Deallocated from an order</LogReasonDescription> </ProductInventoryLogModel> <ProductInventoryLogModel> <ProductID>1234</ProductID> <UserID>123</UserID> <Date>2024-10-30T06:00:50.322594Z</Date> <AdjustmentAmount>1</AdjustmentAmount> <LogReason>ManualRelativeAdjustment</LogReason> <AdditionalInformationType>Orders</AdditionalInformationType> <ReasonAdditionalInformation>1234567</ReasonAdditionalInformation> <LogReasonDescription>Deallocated from an order</LogReasonDescription> </ProductInventoryLogModel> <ProductInventoryLogModel> <ProductID>1234</ProductID> <UserID>123</UserID> <Date>2024-10-30T06:00:50.322594Z</Date> <AdjustmentAmount>1</AdjustmentAmount> <LogReason>ManualRelativeAdjustment</LogReason> <AdditionalInformationType>Orders</AdditionalInformationType> <ReasonAdditionalInformation>1234567</ReasonAdditionalInformation> <LogReasonDescription>Deallocated from an order</LogReasonDescription> </ProductInventoryLogModel> </Data> </ProductsInventoryLogModelCollection>