# Store Product Logs ## Retrieves a paginated list of store product log entries. **get** `/api/v2/public/products/stock/storeproductlogs` Retrieves a paginated list of store product log entries. ### Query Parameters - `article_number: optional string` - `customer_order_number: optional string` - `from_id: optional number` - `is_historic: optional boolean` - `is_reviewed: optional boolean` - `last_modified_date: optional string` - `page_size: optional number` - `page_start: optional number` - `reason_code: optional number` - `reference: optional string` - `reference_id: optional number` - `review_status: optional number` - `store_number: optional string` - `to_id: optional number` - `to_modified_date: optional string` ### Returns - `page_size: number` Maximum number of items returned per page. - `page_start: number` Current page number (1-based). - `total_count: number` Total number of records matching the query across all pages. - `list: optional array of object { id, created_on, price, 47 more }` Collection of items for the current page. - `id: number` - `created_on: string` - `price: number` - `purchase_unit_quantity: number` - `purged_to_most_likely: boolean` - `quantity: number` - `updated_on: string` - `app_user_name: optional string` - `barcode: optional string` - `cost_center: optional string` - `counted_quantity: optional number` - `counting_assignment_id: optional number` - `counting_lines_remaining: optional number` - `counting_lines_remaining_stockpool: optional object { stock_pool_1, stock_pool_10, stock_pool_2, 7 more }` Breakdown of remaining counting lines per stock pool. - `stock_pool_1: number` - `stock_pool_10: number` - `stock_pool_2: number` - `stock_pool_3: number` - `stock_pool_4: number` - `stock_pool_5: number` - `stock_pool_6: number` - `stock_pool_7: number` - `stock_pool_8: number` - `stock_pool_9: number` - `customer_order_line_number: optional number` - `customer_order_number: optional string` - `customer_order_shipment_number: optional string` - `customer_order_shipment_number_line_number: optional number` - `exception_image: optional string` - `expected_quantity: optional number` - `general_ledger_credit: optional string` - `general_ledger_debit: optional string` - `location: optional number` - `location_code: optional string` - `location_tag: optional string` - `moved_on: optional string` - `orderno: optional string` - `product_number: optional string` - `purchase_price: optional number` - `reason_code: optional number` - `reason_code_description: optional string` - `reference: optional string` - `reference_id: optional number` - `remarks: optional string` - `review_status: optional string` - `source: optional string` - `stock_pool: optional string` - `stock_pool_1: optional number` - `stock_pool_10: optional number` - `stock_pool_2: optional number` - `stock_pool_3: optional number` - `stock_pool_4: optional number` - `stock_pool_5: optional number` - `stock_pool_6: optional number` - `stock_pool_7: optional number` - `stock_pool_8: optional number` - `stock_pool_9: optional number` - `store_number: optional string` - `store_products_price: optional number` - `updated_by: optional string` - `list_body: optional map[unknown]` Additional body-level metadata for the list. - `list_filters: optional map[array of string]` Active filter criteria applied to the result set, keyed by field name. - `next_page: optional number` Next page number, or null when on the last page. - `previous_page: optional number` Previous page number, or null when on the first page. - `project_last_modified_date: optional string` Last modified date/time of the project. - `scroll_id: optional string` Opaque scroll identifier for deep-pagination scenarios. - `server_time: optional string` Server UTC date/time when the response was generated. - `sort_column: optional string` Column name the results are sorted by. - `sort_order: optional string` Sort direction (asc or desc). - `task_last_modified_date: optional string` Last modified date/time of the task. ### Example ```http curl https://api.colleqtive.net/api/v2/public/products/stock/storeproductlogs \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "page_size": 0, "page_start": 0, "total_count": 0, "list": [ { "id": 0, "created_on": "2019-12-27T18:11:19.117Z", "price": 0, "purchase_unit_quantity": 0, "purged_to_most_likely": true, "quantity": 0, "updated_on": "2019-12-27T18:11:19.117Z", "app_user_name": "app_user_name", "barcode": "barcode", "cost_center": "cost_center", "counted_quantity": 0, "counting_assignment_id": 0, "counting_lines_remaining": 0, "counting_lines_remaining_stockpool": { "stock_pool_1": 0, "stock_pool_10": 0, "stock_pool_2": 0, "stock_pool_3": 0, "stock_pool_4": 0, "stock_pool_5": 0, "stock_pool_6": 0, "stock_pool_7": 0, "stock_pool_8": 0, "stock_pool_9": 0 }, "customer_order_line_number": 0, "customer_order_number": "customer_order_number", "customer_order_shipment_number": "customer_order_shipment_number", "customer_order_shipment_number_line_number": 0, "exception_image": "exception_image", "expected_quantity": 0, "general_ledger_credit": "general_ledger_credit", "general_ledger_debit": "general_ledger_debit", "location": 0, "location_code": "location_code", "location_tag": "location_tag", "moved_on": "2019-12-27T18:11:19.117Z", "orderno": "orderno", "product_number": "product_number", "purchase_price": 0, "reason_code": 0, "reason_code_description": "reason_code_description", "reference": "reference", "reference_id": 0, "remarks": "remarks", "review_status": "review_status", "source": "source", "stock_pool": "stock_pool", "stock_pool_1": 0, "stock_pool_10": 0, "stock_pool_2": 0, "stock_pool_3": 0, "stock_pool_4": 0, "stock_pool_5": 0, "stock_pool_6": 0, "stock_pool_7": 0, "stock_pool_8": 0, "stock_pool_9": 0, "store_number": "store_number", "store_products_price": 0, "updated_by": "updated_by" } ], "list_body": { "foo": "bar" }, "list_filters": { "foo": [ "string" ] }, "next_page": 0, "previous_page": 0, "project_last_modified_date": "project_last_modified_date", "scroll_id": "scroll_id", "server_time": "server_time", "sort_column": "sort_column", "sort_order": "sort_order", "task_last_modified_date": "task_last_modified_date" } ``` ## Creates store product log entries for a specific store. **post** `/api/v2/public/stores/{store_number}/products/stock/storeproductlogs` Creates store product log entries for a specific store. ### Path Parameters - `store_number: string` ### Query Parameters - `appUserName: optional string` The name of the app user performing the action. - `is_counted_quantity: optional boolean` Whether the quantities represent counted values. - `is_from_receipt: optional boolean` Whether the log entries originate from a receipt. ### Body Parameters - `storeproductlog: optional array of object { customer_order_line_number, modification_datetime, quantity, 25 more }` The list of store product log entries. - `customer_order_line_number: number` - `modification_datetime: string` - `quantity: number` - `app_user_name: optional string` - `counted_quantity: optional number` - `customer_order_number: optional string` - `expected_quantity: optional number` - `location_code: optional string` - `loss_comment: optional string` - `loss_image: optional string` - `loss_order_number: optional string` - `order_after_date: optional string` - `pool_location: optional number` - `product_number: optional string` The product number. - `reason_code: optional number` - `reference: optional string` - `scanned_datetime: optional string` - `source: optional string` - `stock_pool_1: optional number` - `stock_pool_10: optional number` - `stock_pool_2: optional number` - `stock_pool_3: optional number` - `stock_pool_4: optional number` - `stock_pool_5: optional number` - `stock_pool_6: optional number` - `stock_pool_7: optional number` - `stock_pool_8: optional number` - `stock_pool_9: optional number` ### Returns - `success: boolean` Indicates whether the operation completed successfully. - `data: optional array of number` Array of items returned by the operation. - `message: optional string` Human-readable message describing the result. ### Example ```http curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/products/stock/storeproductlogs \ -X POST \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "success": true, "data": [ 0 ], "message": "message" } ``` ## Domain Types ### Store Product Log List Store Product Logs Response - `StoreProductLogListStoreProductLogsResponse object { id, created_on, price, 47 more }` Represents a store product log entry returned by the API. - `id: number` - `created_on: string` - `price: number` - `purchase_unit_quantity: number` - `purged_to_most_likely: boolean` - `quantity: number` - `updated_on: string` - `app_user_name: optional string` - `barcode: optional string` - `cost_center: optional string` - `counted_quantity: optional number` - `counting_assignment_id: optional number` - `counting_lines_remaining: optional number` - `counting_lines_remaining_stockpool: optional object { stock_pool_1, stock_pool_10, stock_pool_2, 7 more }` Breakdown of remaining counting lines per stock pool. - `stock_pool_1: number` - `stock_pool_10: number` - `stock_pool_2: number` - `stock_pool_3: number` - `stock_pool_4: number` - `stock_pool_5: number` - `stock_pool_6: number` - `stock_pool_7: number` - `stock_pool_8: number` - `stock_pool_9: number` - `customer_order_line_number: optional number` - `customer_order_number: optional string` - `customer_order_shipment_number: optional string` - `customer_order_shipment_number_line_number: optional number` - `exception_image: optional string` - `expected_quantity: optional number` - `general_ledger_credit: optional string` - `general_ledger_debit: optional string` - `location: optional number` - `location_code: optional string` - `location_tag: optional string` - `moved_on: optional string` - `orderno: optional string` - `product_number: optional string` - `purchase_price: optional number` - `reason_code: optional number` - `reason_code_description: optional string` - `reference: optional string` - `reference_id: optional number` - `remarks: optional string` - `review_status: optional string` - `source: optional string` - `stock_pool: optional string` - `stock_pool_1: optional number` - `stock_pool_10: optional number` - `stock_pool_2: optional number` - `stock_pool_3: optional number` - `stock_pool_4: optional number` - `stock_pool_5: optional number` - `stock_pool_6: optional number` - `stock_pool_7: optional number` - `stock_pool_8: optional number` - `stock_pool_9: optional number` - `store_number: optional string` - `store_products_price: optional number` - `updated_by: optional string` ### Store Product Log Create Store Product Logs Response - `StoreProductLogCreateStoreProductLogsResponse object { success, data, message }` Standard success response containing an array of items. - `success: boolean` Indicates whether the operation completed successfully. - `data: optional array of number` Array of items returned by the operation. - `message: optional string` Human-readable message describing the result.