{ "openapi": "3.0.1", "info": { "title": "StockIQ Public API", "description": "StockIQ's public REST API. Authenticate with POST /api/authenticate using an API token (siq_... secret) to obtain a bearer JWT, then send it as 'Authorization: Bearer ' on every request. Responses honor the caller's data-level security scope; fields may be redacted per permission. Filter endpoints accept business keys (*Codes) alongside numeric ids; unknown codes fail with a 400 listing them.", "version": "v1" }, "paths": { "/api/AlertCounts/fetchby/itemSiteFilters": { "post": { "tags": [ "AlertCounts" ], "summary": "Returns one row per alert type with its high, medium, and low priority alert counts,\r\nsuspended count, and total value, respecting the posted filters. Narrow by items,\r\nsites, suppliers, or categories - by numeric ids or by business codes (ItemCodes,\r\nSiteCodes, ...).", "requestBody": { "description": "Filter set; omit or post an empty body for counts across all alerts.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IAlertCounts" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/AlertDetail/fetchby/alertDetailFilters": { "post": { "tags": [ "AlertDetail" ], "summary": "Returns individual alert rows - item-site, supplier, hierarchy, and customer alerts -\r\nmatching the posted filters, including each alert's message, priority, and state. Narrow\r\nby alert type/priority/state, items, sites, suppliers, customers, or categories - by\r\nnumeric ids or by business codes (ItemCodes, SiteCodes, ...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all alerts.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AlertDetailFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetailFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertDetailFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertDetailFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/IAlertDetail" } }, { "$ref": "#/components/schemas/IAlertDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/Authenticate": { "post": { "tags": [ "Authenticate" ], "summary": "Exchanges an API token secret (the `siq_...` value, in the body or an\r\n`X-Api-Key` header) for a 1-hour bearer JWT used on all other API calls.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthenticateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthenticateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/AverageLeadTime/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "AverageLeadTime" ], "summary": "Returns the average observed lead times (admin, vendor, shipping, planning, and\r\nputaway) for supplier receipts, computed from receipt history and bucketed into the\r\nrequested time interval - one row per period with a sample count. Post filters in\r\nthe body to narrow by items, sites, suppliers, categories, or a date range - by\r\nnumeric ids or by business codes (ItemCodes, SiteCodes, SupplierCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Time bucket grain to return (e.g. Weekly, Monthly).", "schema": { "$ref": "#/components/schemas/TimeInterval" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AverageLeadTime" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BottomLevelForecastDetail/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "BottomLevelForecastDetail" ], "summary": "Returns forecast detail at the bottom level of the forecast hierarchy (the finest grain\r\navailable, e.g. item-site-customer), one row per node per period, including forecast\r\nquantities, actuals, and forecast error measures. Post filters in the body to narrow by\r\nitems, sites, customers, categories, or a date range - by numeric ids or by business\r\ncodes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Forecast period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to read, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "bomPositions", "in": "query", "description": "Restricts to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/CurrentExcessDetail/fetchby/itemSiteFilters": { "post": { "tags": [ "CurrentExcessDetail" ], "summary": "Returns the current excess-inventory rows for the item-sites matching the posted\r\nfilters - one row per item-site holding more inventory than its target, with the\r\nexcess quantity and value. Narrow by items, sites, suppliers, or categories - by\r\nnumeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "includeOverStock", "in": "query", "description": "Also include item-sites that are currently over-stocked; these are excluded by default.", "schema": { "type": "boolean", "default": false } }, { "name": "includePlannedOverStock", "in": "query", "description": "Also include item-sites projected to become over-stocked from planned receipts; these are excluded by default.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExcessDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/CustomerItemDueToBuyDetail/fetchby/customerItemDueToBuyFilters": { "post": { "tags": [ "CustomerItemDueToBuyDetail" ], "summary": "Returns the customer/item combinations that are due or overdue to reorder based on each\r\ncombination's observed buying cadence, with the expected next purchase dates, purchase\r\nprobability, and sales history facts. Narrow by items, customers, usage patterns,\r\ndue-to-buy statuses, or item categories - by numeric ids or by business codes\r\n(ItemCodes, CustomerCodes, ...).", "requestBody": { "description": "Filter set; omit or post an empty body for all customer/item combinations.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerItemDueToBuyFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerItemDueToBuyFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerItemDueToBuyFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerItemDueToBuyFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerItemDueToBuyDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/CustomField": { "get": { "tags": [ "CustomField" ], "summary": "Returns this instance's custom field definitions - the extra fields an administrator\r\nhas added to items, item-sites, item-site-suppliers, suppliers, sales orders and\r\nsupply order lines beyond the ones StockIQ ships with.\r\n \r\nRead this first to interpret the rest of the API. Wherever a record carries custom\r\nfields, their values arrive as additional properties named CF_ followed by the field's\r\ncode, so a field whose code is Brand arrives as CF_Brand. Those properties appear only\r\non records whose type has definitions, and only where a value has been recorded, so\r\ntake the codes and types from here rather than assuming a fixed payload. EntityType\r\nsays which records a field appears on; DataType says how to read its value; inactive\r\ndefinitions are returned but their values are not sent.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/CustomReportProducer": { "get": { "tags": [ "CustomReportProducer" ], "summary": "Runs a custom report, identified by id or by name, and returns its rows (the shape is\r\ndefined by the report itself). Report parameter values are supplied as ordinary\r\nquery-string keys alongside the identifier, e.g.\r\napi/CustomReportProducer?customReportId=5&itemCode=ABC&asOfDate=2026-07-13.\r\nSupplied keys are validated against the report's declared parameters (discoverable via\r\nGET /api/CustomReportProducer/parameters); omitted optional parameters use the report's\r\ndefaults. Returns JSON by default, or CSV with an Accept: text/csv header.", "parameters": [ { "name": "customReportId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "customReportName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { } } }, "text/csv": { "schema": { "type": "array", "items": { } } } } } } } }, "/api/CustomReportProducer/parameters": { "get": { "tags": [ "CustomReportProducer" ], "summary": "Lists the input parameters a custom report accepts (name, SQL type, whether required) -\r\nuse this to discover what query-string keys to supply when running the report.", "parameters": [ { "name": "customReportId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } } } }, "/api/DemandForecastSnapshotExportDetail/fetchby/demandForecastSnapshotFilters": { "post": { "tags": [ "DemandForecastSnapshotExportDetail" ], "summary": "Returns one page of demand forecast snapshot history as flat rows - one row per forecast\r\nseries, hierarchy node, snapshot date, and forecast period date - ready to load into a\r\ndatabase or spreadsheet for your own forecast accuracy analysis. Each row carries the\r\nsnapshot header (name, date, error statistics), the hierarchy node identity with its\r\nbusiness codes (HierarchyNodeId, NodeValue, ItemCode, SiteCode, ...), and one period's\r\nforecast values. Narrow with the posted filters: forecast series (by id or code),\r\nsnapshot date range, forecast period date range, and the standard hierarchy dimensions -\r\nby numeric ids or by business codes (ItemCodes, SiteCodes, ...). Node filters match the\r\nnode's own attributes; a dimension that does not appear on a node's hierarchy path does\r\nnot exclude it. This endpoint is always paged: the row space is too large to return in\r\none response, so an omitted page returns the first page, never the full set.", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "Restrict to nodes in this forecast hierarchy. Omit for all hierarchies.", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyLevel", "in": "query", "description": "Restrict to nodes at this hierarchy level (1 = top). Omit for all levels; each row carries its NodeLevel.", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all snapshots.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DemandForecastSnapshotFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemandForecastSnapshotFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DemandForecastSnapshotFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DemandForecastSnapshotFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandForecastSnapshotExportDetailPagedResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/DiscontinuedItemDetail/fetchby/itemSiteFilters": { "post": { "tags": [ "DiscontinuedItemDetail" ], "summary": "Returns discontinued and obsolescing item-sites (remaining on-hand quantities and\r\nbalances, projected depletion dates, and days until depleted) for the item-sites\r\nmatching the posted filters. Narrow by items, sites, suppliers, or categories - by\r\nnumeric ids or by business codes (ItemCodes, SiteCodes, ...).", "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscontinuedItemDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FirmAndPlannedOrderDetail/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "FirmAndPlannedOrderDetail" ], "summary": "Returns time-bucketed firm and planned order (release) quantities per\r\nitem-site-supplier - one row per item-site, supplier, and period, with quantities,\r\ndollars, cubes, and weight split into firm (orders already placed) and planned\r\n(suggested) buckets. Narrow by items, sites, suppliers, or categories - by numeric ids\r\nor by business codes (ItemCodes, SiteCodes, ...) - and by a date range applied to the\r\norder release date.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "interval", "in": "query", "description": "Period size for the buckets: Monthly or Weekly. No other interval is supported.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "showLoadBalancedPlan", "in": "query", "description": "When true, planned quantities for load-balanced item-sites reflect the load-balanced\r\nplan (split across the balanced suppliers); when false, the unbalanced plan is shown.", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all rows.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedOrderDetail" } }, { "$ref": "#/components/schemas/FirmAndPlannedOrderDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/FirmAndPlannedReceiptDetail/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "FirmAndPlannedReceiptDetail" ], "summary": "Returns time-bucketed firm and planned receipt quantities per item-site-supplier - one\r\nrow per item-site, supplier, and period, with quantities, dollars, cubes, and weight\r\nsplit into firm (orders already placed) and planned (suggested) buckets. Narrow by\r\nitems, sites, suppliers, or categories - by numeric ids or by business codes\r\n(ItemCodes, SiteCodes, ...) - and by a date range applied to the expected receipt\r\ndate.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "interval", "in": "query", "description": "Period size for the buckets: Monthly or Weekly. No other interval is supported.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "showLoadBalancedPlan", "in": "query", "description": "When true, planned quantities for load-balanced item-sites reflect the load-balanced\r\nplan (split across the balanced suppliers); when false, the unbalanced plan is shown.", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all rows.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedReceiptDetail" } }, { "$ref": "#/components/schemas/FirmAndPlannedReceiptDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/FirmAndPlannedShipmentDetail/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "FirmAndPlannedShipmentDetail" ], "summary": "Returns time-bucketed firm and planned shipment quantities per item-site-supplier -\r\none row per item-site, supplier, and period, with quantities, dollars, cubes, and\r\nweight split into firm (orders already placed) and planned (suggested) buckets. Narrow\r\nby items, sites, suppliers, or categories - by numeric ids or by business codes\r\n(ItemCodes, SiteCodes, ...) - and by a date range applied to the expected ship date.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "interval", "in": "query", "description": "Period size for the buckets: Monthly or Weekly. No other interval is supported.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "showLoadBalancedPlan", "in": "query", "description": "When true, planned quantities for load-balanced item-sites reflect the load-balanced\r\nplan (split across the balanced suppliers); when false, the unbalanced plan is shown.", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all rows.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedShipmentDetail" } }, { "$ref": "#/components/schemas/FirmAndPlannedShipmentDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ForecastErrorsSummary": { "get": { "tags": [ "ForecastErrorsSummary" ], "summary": "Returns the forecast error summary for a single forecast hierarchy node and forecast\r\nseries - error percent, mean absolute error, error value, and bias for the saved\r\nforecast, the statistical forecast, and a naive forecast, plus lead-time-ago\r\ncomparison values when a matching forecast snapshot exists.", "parameters": [ { "name": "hierarchyNodeId", "in": "query", "description": "The hierarchy node whose error summary is returned.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series whose error measures are returned.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastErrorsSummary" } } } } } } }, "/api/ForecastErrorsSummary/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "ForecastErrorsSummary" ], "summary": "Returns forecast error summaries across a forecast hierarchy, one row per hierarchy\r\nnode, comparing the saved forecast, the statistical forecast, and a naive forecast\r\nagainst actual demand - error percent, mean absolute error, error value, and bias -\r\nplus lead-time-ago comparison values where forecast snapshots exist. Post filters in\r\nthe body to narrow by items, sites, customers, categories, or tags - by numeric ids\r\nor by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to read.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series whose error measures are returned.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "Restricts the result to nodes at this hierarchy level (1 = top); omit for all levels.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ForecastErrorsSummary" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ForecastVsModelDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "ForecastVsModelDetail" ], "summary": "Returns forecast-vs-model variance rows, one per hierarchy node per period, highlighting\r\nwhere the working forecast deviates from the statistical model, with unit and dollar\r\nvariance measures. Post filters in the body to narrow by items, sites, customers,\r\ncategories, or tags - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to read.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to compare against the statistical model, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "Restricts the result to nodes at one hierarchy level (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Earliest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Latest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "yearNumbers", "in": "query", "description": "Restricts to periods in the given years.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "quarterNumbers", "in": "query", "description": "Restricts to periods in the given quarters (1-4).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "monthNumbers", "in": "query", "description": "Restricts to periods in the given months (1-12).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ForecastVsModelDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FullRefresh": { "put": { "tags": [ "FullRefresh" ], "summary": "Starts a data refresh batch run (the same operation as the Full Refresh button in the\r\napp). WARNING: this launches instance-wide batch processing that recalculates planning\r\ndata and can run for an extended period; while it runs, most data endpoints reflect\r\nin-progress state. Typically used by integrations to trigger a refresh after pushing\r\nnew data to the staging tables. Monitor progress via GET /api/SystemStatus.", "parameters": [ { "name": "refreshType", "in": "query", "description": "Scope of the refresh: Full = 1, Partial = 2, OnHand = 4, Demand = 8, Supply = 16.", "schema": { "$ref": "#/components/schemas/RefreshType" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "FullRefresh" ], "summary": "Cancels a running data refresh. The refresh stops at the next safe point; check\r\nGET /api/SystemStatus for the resulting state.", "responses": { "200": { "description": "OK" } } } }, "/api/HierarchyLevelActualsExportDetail/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "HierarchyLevelActualsExportDetail" ], "summary": "Returns one page of demand history (actuals) aggregated to the nodes of one forecast\r\nhierarchy level - one row per node per period - ready to load into a database or\r\nspreadsheet, for example to compare against extracted forecast snapshots for your own\r\nforecast accuracy analysis. Each row carries the node identity with its business codes\r\n(HierarchyNodeId, NodeValue, ItemCode, SiteCode, ...) plus quantity sold, cost of goods,\r\nrevenue, margin, hit counts, and the on-hand balance at standard cost where inventory\r\nhistory exists. Narrow with the posted filters - by numeric ids or by business codes\r\n(ItemCodes, SiteCodes, ...) - and a period date range. Most filters restrict which\r\nitem-sites contribute to the aggregates; the ship-to-category and supplier-item-code\r\nfilters match the node's own attributes, and the on-hand balance always reflects the\r\nnode's full inventory history. This endpoint is always paged: the row space is too large\r\nto return in one response, so an omitted page returns the first page, never the full set.", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain to aggregate to: Daily, Weekly, Monthly, Quarterly, or Yearly.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to read.", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyLevel", "in": "query", "description": "The hierarchy level whose nodes are returned (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandSeriesId", "in": "query", "description": "The demand series to read. Supply this or demandSeriesCode, not both.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandSeriesCode", "in": "query", "description": "Code of the demand series to read. Supply this or demandSeriesId, not both.", "schema": { "type": "string" } }, { "name": "hierarchyNodeId", "in": "query", "description": "Restrict to one node at the level. Omit for all nodes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "bomPositions", "in": "query", "description": "Restricts contribution to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "customerShipToStateIds", "in": "query", "description": "Restricts contribution to demand shipped to these state ids.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyLevelActualsExportDetailPagedResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/HierarchyLevelForecastDetail/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "HierarchyLevelForecastDetail" ], "summary": "Returns forecast detail aggregated to one level of a forecast hierarchy, one row per\r\nhierarchy node per period, including forecast quantities, actuals, and forecast error\r\nmeasures. Post filters in the body to narrow by items, sites, customers, categories, or\r\na date range - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Forecast period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to read, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to aggregate over.", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyLevel", "in": "query", "description": "The level of the hierarchy to aggregate to (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyNodeId", "in": "query", "description": "Restricts the result to a single hierarchy node.", "schema": { "type": "integer", "format": "int32" } }, { "name": "bomPositions", "in": "query", "description": "Restricts to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/HierarchyLevelServiceLevelDetail/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "HierarchyLevelServiceLevelDetail" ], "summary": "Returns the achieved service level aggregated to one level of a forecast hierarchy,\r\none row per hierarchy node per period - quantities ordered, filled, and filled on\r\ntime, plus complete and on-time order-line counts (fill rates measured against\r\ndemand) - alongside the average target service level of the contributing item-sites.\r\nNarrow by items, sites, suppliers, categories, or a date range - by numeric ids or by\r\nbusiness codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to aggregate over.", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyLevel", "in": "query", "description": "The level of the hierarchy to aggregate to (1 = top).", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyLevelServiceLevelDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/HierarchyLevelTurnsDetailOverTime/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "HierarchyLevelTurnsDetailOverTime" ], "summary": "Returns inventory turns aggregated to one level of a forecast hierarchy, one row per\r\nhierarchy node per period, combining historical inventory snapshots, average on-hand\r\nbalances, and demand actuals (turns = cost of goods sold / average inventory value).\r\nPost filters in the body to narrow by items, sites, categories, or a date range - by\r\nnumeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to aggregate over.", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyLevel", "in": "query", "description": "The level of the hierarchy to aggregate to (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "hierarchyNodeId", "in": "query", "description": "Restricts the result to a single hierarchy node.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyLevelTurnsDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/HierarchyNodeDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "HierarchyNodeDetail" ], "summary": "Returns forecast hierarchy nodes at the requested level, with forecast and actuals\r\nsummary values per node. Narrow by items, sites, suppliers, customers, categories, or\r\ntags - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to read; omit for the default hierarchy.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "The hierarchy level whose nodes are returned (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeFilterOption", "in": "query", "description": "Whether to include nodes without forecasts.", "schema": { "$ref": "#/components/schemas/ForecastSummaryNodeFilterOption" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyNodeDetail" } }, { "$ref": "#/components/schemas/HierarchyNodeDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ItemSiteActualsDetail/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "ItemSiteActualsDetail" ], "summary": "Returns item-site level demand history (actuals), one row per item-site per period,\r\nincluding quantity sold, cost of goods, revenue, margin, and hit counts. Post filters in\r\nthe body to narrow by items, sites, suppliers, customers, categories, or a date range -\r\nby numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "History period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "demandSeriesId", "in": "query", "description": "The demand series to read.", "schema": { "type": "integer", "format": "int32" } }, { "name": "bomPositions", "in": "query", "description": "Restricts to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteAttributes/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "ItemSiteAttributes" ], "summary": "Returns item-site attributes (item, site, supplier, category, and planning attribute\r\nvalues) for the item-sites under one forecast hierarchy node, optionally narrowed by the\r\nposted filters - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "hierarchyNodeId", "in": "query", "description": "The forecast hierarchy node whose item-sites are returned.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites under the node.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteAttributes" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteAttributes" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteDaysOfSupply/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "ItemSiteDaysOfSupply" ], "summary": "Returns the days, weeks, and months of supply for each item-site matching the posted\r\nfilters, together with a one-year burn-down projection (projected on-hand quantity and\r\nvalue after twelve months of expected usage). Supply is measured against the inventory\r\nquantity chosen via referenceQuantity. Narrow by items, sites, suppliers, categories, or\r\na date range - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "referenceQuantity", "in": "query", "description": "The inventory quantity the supply measures are calculated against:\r\n1 = on-hand quantity, 2 = available quantity, 3 = firm supply and demand\r\n(on-hand plus on-order minus on-demand).", "schema": { "$ref": "#/components/schemas/InventoryPositionQuantity" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteDaysOfSupply" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "ItemSiteDetail" ], "summary": "Returns item-site master detail (item, site, buyer, category, status, and planning\r\nattributes) for the item-sites matching the posted filters. Narrow by items, sites,\r\nsuppliers, categories, or tags - by numeric ids or by business codes (ItemCodes,\r\nSiteCodes, ...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; post an empty object for all active item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteDetail" } }, { "$ref": "#/components/schemas/ItemSiteDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ItemSiteForecastDetail/fetchby/dateRangeHierarchyNodeFilters": { "post": { "tags": [ "ItemSiteForecastDetail" ], "summary": "Returns item-site level forecast detail (one row per item-site per period), including\r\nforecast quantities, actuals, and forecast error measures. Post filters in the body to\r\nnarrow by items, sites, suppliers, categories, or a date range - by numeric ids or by\r\nbusiness codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Forecast period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to read, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "bomPositions", "in": "query", "description": "Restricts to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeHierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteHistoryDetail/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "ItemSiteHistoryDetail" ], "summary": "Returns the daily inventory history for each item-site matching the posted filters -\r\none row per item-site per captured day, carrying that day's on-hand and available\r\nquantities, the safety stock, target stock, and max stock levels in force, the costs\r\nand price, and the ABC/XYZ classes, usage pattern, and inventory position as they\r\nstood on that day. Narrow by items, sites, suppliers, categories, or a capture-date\r\nrange - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all captured history.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteHistoryDetail" } }, { "$ref": "#/components/schemas/ItemSiteHistoryDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ItemSiteInventorySnapshot/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "ItemSiteInventorySnapshot" ], "summary": "Returns the inventory snapshot series for each item-site matching the posted filters -\r\none row per item-site per period, carrying the on-hand and available quantities, the\r\nsafety stock, target stock, and max stock levels, their standard-cost balances, and\r\ncube/pallet measures. The showCurrentValues, showHistoricalValues, and\r\nshowProjectedValues switches choose which of today's values, captured history, and\r\nprojected future inventory are included; any combination may be requested. Narrow by\r\nitems, sites, suppliers, categories, or a date range - by numeric ids or by business\r\ncodes (ItemCodes, SiteCodes, ...).", "description": "The response is an envelope: `Snapshots` holds the snapshot rows (CaptureDate is\r\nthe period date, or the current date for current-value rows), and `ConstantLines`\r\nholds chart constant-line markers (for example the line separating history from\r\nprojection) for callers rendering the series as a chart.", "parameters": [ { "name": "timeInterval", "in": "query", "description": "Period grain for historical and projected rows: 1 = Daily, 2 = Weekly, 4 = Monthly,\r\n8 = Quarterly, 32 = Yearly. Projected values support Weekly and coarser (no Daily).", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "showCurrentValues", "in": "query", "description": "Include one row per item-site holding today's values.", "schema": { "type": "boolean" } }, { "name": "showHistoricalValues", "in": "query", "description": "Include captured history rows at the chosen interval.", "schema": { "type": "boolean" } }, { "name": "showProjectedValues", "in": "query", "description": "Include projected future rows at the chosen interval.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteInventorySnapshots" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteServiceLevelDetail/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "ItemSiteServiceLevelDetail" ], "summary": "Returns the achieved service level for each item-site per period - quantities ordered,\r\nfilled, and filled on time, plus complete and on-time order-line counts (fill rates\r\nmeasured against demand) - alongside the item-site's target service level. Narrow by\r\nitems, sites, suppliers, categories, or a date range - by numeric ids or by business\r\ncodes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain to return.", "schema": { "$ref": "#/components/schemas/TimeInterval" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteServiceLevelDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ItemSiteSupplierDetail/fetchby/itemSiteSupplierFilters": { "post": { "tags": [ "ItemSiteSupplierDetail" ], "summary": "Returns one row per item-site-supplier relationship matching the posted filters,\r\ncarrying that relationship's lead times (ERP, calculated, and active), minimum order\r\nquantity and order multiples, costs, and sourcing settings - the Lead Time Viewer\r\ndata. Narrow by items, sites, suppliers (any relationship via SupplierIds/\r\nSupplierCodes, or the primary one via PrimarySupplierIds/PrimarySupplierCodes),\r\nsupplier levels, supplier item categories, or item-site categories - by numeric ids\r\nor by business codes (ItemCodes, SiteCodes, SupplierCodes, ...).", "description": "The MultiHubFilter field is not applied by this endpoint: SupplierLevels always matches exactly, which is the ShowPrimaryHubOnly behavior. Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-site-supplier relationships.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteSupplierDetail" } }, { "$ref": "#/components/schemas/ItemSiteSupplierDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ItemSiteTurnsDetailOverTime/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "ItemSiteTurnsDetailOverTime" ], "summary": "Returns the inventory turns detail for each item-site matching the posted filters -\r\none row per item-site per period, combining that period's on-hand inventory history,\r\naverage on-hand quantities and balances, and demand actuals (quantity sold and cost\r\nof goods sold, direct and dependent) into turns measures. Narrow by items, sites,\r\nsuppliers, categories, or a date range - by numeric ids or by business codes\r\n(ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain: 2 = Weekly, 4 = Monthly, 8 = Quarterly, 32 = Yearly.", "schema": { "$ref": "#/components/schemas/TimeInterval" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteTurnsDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/LostSalesDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "LostSalesDetail" ], "summary": "Returns lost sales per hierarchy node per period - the demand StockIQ estimates was\r\nmissed while an item was out of stock, in units, cost, and revenue. Post filters in\r\nthe body to narrow by items, sites, customers, categories, and more - by numeric ids\r\nor by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Period grain to return; only Weekly and Monthly are supported.", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "fillInMissingPeriods", "in": "query", "description": "When true, periods with no lost sales are synthesized as zero rows so each node has a\r\ncontinuous series.", "schema": { "type": "boolean" } }, { "name": "hierarchyNodeId", "in": "query", "description": "Restricts the result to a single hierarchy node.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "The hierarchy level to report at (1 = top).", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LostSalesDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ManualForecastDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "ManualForecastDetail" ], "summary": "Returns the manual forecast override settings per forecast hierarchy node - which\r\nnodes have their forecast under manual control, who last updated them and when, any\r\nauto-forecast reactivation date, and notes. Set showInheritedSettings to also include\r\nnodes that inherit manual control from a level above them. Post filters in the body\r\nto narrow by items, sites, customers, categories, or tags - by numeric ids or by\r\nbusiness codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to read.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "Restricts the result to nodes at this hierarchy level (1 = top); omit for all levels.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series whose manual override settings are returned.", "schema": { "type": "integer", "format": "int32" } }, { "name": "showInheritedSettings", "in": "query", "description": "True to also include rows inherited from a parent node; false (default) returns only nodes where the setting is applied directly.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManualForecastDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/NewItemDetail/fetchby/itemSiteFilters": { "post": { "tags": [ "NewItemDetail" ], "summary": "Returns recently added item-sites (item age, early-life demand, on-hand and usage\r\nfacts, and related alert status) for the item-sites matching the posted filters.\r\nNarrow by items, sites, suppliers, or categories - by numeric ids or by business\r\ncodes (ItemCodes, SiteCodes, ...).", "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewItemDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/OnTimePerformanceSummary/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "OnTimePerformanceSummary" ], "summary": "Returns a per-period on-time delivery summary for each supplier relationship matching the\r\nposted filters - counts of receipts that arrived within the configured on-time tolerance,\r\nearly, or late. Narrow by items, sites, suppliers, categories, or a date range - by\r\nnumeric ids or by business codes (ItemCodes, SupplierCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Time period grain to summarize by (e.g. monthly).", "schema": { "$ref": "#/components/schemas/TimeInterval" } }, { "name": "leadTimeType", "in": "query", "description": "Which lead-time measure to judge on-time performance against.", "schema": { "$ref": "#/components/schemas/LeadTimeType" } }, { "name": "dateFilterOption", "in": "query", "description": "Which date the date-range filters apply to: order creation date or receipt date.", "schema": { "$ref": "#/components/schemas/ReceiptDetailDateFilter" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnTimePerformanceSummary" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/OpenSupplyOrderLineDetail/fetchby/dateRangeItemSiteFilters": { "post": { "tags": [ "OpenSupplyOrderLineDetail" ], "summary": "Returns open supply order lines (purchase order, transfer, and work order lines not yet\r\nfully received) matching the posted filters. Narrow by items, sites, suppliers,\r\ncategories, or a date range - by numeric ids or by business codes (ItemCodes, SiteCodes,\r\n...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "orderDateType", "in": "query", "description": "Which order date the date-range and period filters apply to.", "schema": { "$ref": "#/components/schemas/FirmAndPlannedType" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all open lines.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OpenSupplyOrderLineDetail" } }, { "$ref": "#/components/schemas/OpenSupplyOrderLineDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/OrderScheduleHeader/fetchby/itemSiteSupplierFilters": { "post": { "tags": [ "OrderScheduleHeader" ], "summary": "Returns the order schedule headers - one row per item-site-supplier relationship on a\r\nscheduled ordering cadence, with its order cycle, next expected ship and dock dates,\r\ninventory position, and schedule lock status. Narrow by items, sites, suppliers (any\r\nrelationship via SupplierIds/SupplierCodes, or the primary one via PrimarySupplierIds/\r\nPrimarySupplierCodes), supplier levels, supplier item categories, or item-site\r\ncategories - by numeric ids or by business codes (ItemCodes, SiteCodes, SupplierCodes, ...).", "description": "The MultiHubFilter field is not applied by this endpoint: SupplierLevels always matches exactly, which is the ShowPrimaryHubOnly behavior.", "requestBody": { "description": "Filter set; omit or post an empty body for all order schedule headers.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderScheduleHeader" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/OverforecastedPeriodDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "OverforecastedPeriodDetail" ], "summary": "Returns periods where the forecast materially exceeded actual demand, one row per\r\nhierarchy node per period, including forecast quantities, actuals, and forecast error\r\nmeasures. Post filters in the body to narrow by items, sites, customers, categories, or\r\ntags - by numeric ids or by business codes (ItemCodes, SiteCodes, ...). Period\r\nrestrictions (startDate, endDate, yearNumbers, quarterNumbers, monthNumbers) ride the\r\nquery string.", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to evaluate.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to read, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "Restricts the result to nodes at one level of the hierarchy (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Earliest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Latest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "yearNumbers", "in": "query", "description": "Restricts to periods in the given years.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "quarterNumbers", "in": "query", "description": "Restricts to periods in the given quarters (1-4).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "monthNumbers", "in": "query", "description": "Restricts to periods in the given months (1-12).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OverforecastedPeriodDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ReceiptCompletenessPerformanceSummary/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "ReceiptCompletenessPerformanceSummary" ], "summary": "Returns receipt completeness performance computed from receipt history and bucketed\r\ninto the requested time interval - one row per period with counts of complete,\r\nunder-shipped, and over-shipped receipts plus a total. Post filters in the body to\r\nnarrow by items, sites, suppliers, categories, or a date range - by numeric ids or\r\nby business codes (ItemCodes, SiteCodes, SupplierCodes, ...).", "parameters": [ { "name": "interval", "in": "query", "description": "Time bucket grain to return (e.g. Weekly, Monthly).", "schema": { "$ref": "#/components/schemas/TimeInterval" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptCompletenessPerformanceSummary" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ReceiptDetail/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "ReceiptDetail" ], "summary": "Returns historical receipt lines (received incoming shipments), one row per supply\r\norder line per shipment, with the expected ship, dock, and receipt dates alongside the\r\nactual ones and an on-time/early/late classification. Narrow by items, sites,\r\nsuppliers, or categories - by numeric ids or by business codes (ItemCodes, SiteCodes,\r\n...) - and by a date range applied to the basis chosen with dateFilterOption.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "dateFilterOption", "in": "query", "description": "Which date the StartDate/EndDate and year/quarter/month filters apply to:\r\nOrderCreationDate or ReceiptDate.", "schema": { "$ref": "#/components/schemas/ReceiptDetailDateFilter" } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all receipts.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptDetail" } }, { "$ref": "#/components/schemas/ReceiptDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/ReceiptPerformanceFrequency/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "ReceiptPerformanceFrequency" ], "summary": "Returns a histogram of receipts by the number of days they arrived early or late,\r\nmeasured against the chosen lead-time measure, for the receipts matching the posted\r\nfilters. One row per days-early-or-late value with the count of receipts; gaps in the\r\nrange are filled with zero-count rows. Narrow by items, sites, suppliers, categories,\r\nor a date range - by numeric ids or by business codes (ItemCodes, SupplierCodes, ...).\r\nReturns an empty list when nothing matches.", "parameters": [ { "name": "leadTimeType", "in": "query", "description": "Which lead-time measure to compute the early/late days against.", "schema": { "$ref": "#/components/schemas/LeadTimeType" } }, { "name": "dateFilterOption", "in": "query", "description": "Which date the date-range filters apply to: order creation date or receipt date.", "schema": { "$ref": "#/components/schemas/ReceiptDetailDateFilter" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptPerformanceFrequency" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/SafetyStockSummary/fetchby/itemSiteFilters": { "post": { "tags": [ "SafetyStockSummary" ], "summary": "Returns the safety stock summary (current safety stock levels, targets, and related alert\r\nstatus) for the item-sites matching the posted filters. Narrow by items, sites, suppliers,\r\nor categories - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SafetyStockSummary" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/SalesOrderDetail/fetchby/salesOrderDetailFilters": { "post": { "tags": [ "SalesOrderDetail" ], "summary": "Returns sales order lines matching the posted filters. Narrow by items, sites, suppliers,\r\ncustomers, categories, order numbers, or a demand-date range - by numeric ids or by\r\nbusiness codes (ItemCodes, SiteCodes, ...). When includeClosed is true, an unpaged request\r\nmust be bounded by at least one filter or a date range; request paging to pull full closed\r\nhistory page by page.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "demandSeriesId", "in": "query", "description": "Restricts results to one demand series; omit for all.", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeClosed", "in": "query", "description": "Include closed and fulfilled lines (default: open and on-hold lines only).", "schema": { "type": "boolean", "default": false } }, { "name": "bomPositions", "in": "query", "description": "Restricts to items at the given bill-of-material positions.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for open orders only.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SalesOrderDetailFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDetailFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDetailFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SalesOrderDetailFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDetail" } }, { "$ref": "#/components/schemas/SalesOrderDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/StagingTableImportSettings": { "get": { "tags": [ "StagingTableImportSettings" ], "summary": "Lists the import settings for every staging table: whether the table is active for\r\nimport, how many days of history are kept, and which date column drives incremental\r\nloads. Integrations that push data into the staging tables use these settings to\r\nagree with StockIQ on what gets imported.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StagingTableImportSettings" } } } } } } }, "post": { "tags": [ "StagingTableImportSettings" ], "summary": "Creates or updates a staging table's import settings. WARNING: this changes how the\r\nnightly import treats that staging table (e.g. deactivating a table stops its data\r\nfrom being imported). Post the full settings object; include the id to update an\r\nexisting row.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } } } } } } }, "/api/StagingTableImportSettings/{id}": { "get": { "tags": [ "StagingTableImportSettings" ], "summary": "Returns the import settings row with the given id.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StagingTableImportSettings" } } } } } }, "delete": { "tags": [ "StagingTableImportSettings" ], "summary": "Deletes a staging table's import settings row. WARNING: the affected table reverts\r\nto default import behavior on the next refresh.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/StockOutsDetail/fetchby/itemSiteFilters": { "post": { "tags": [ "StockOutsDetail" ], "summary": "Returns the current and recent stockout rows for the item-sites matching the posted\r\nfilters - one row per stocked-out item-site with how many days it has been out, how many\r\ntimes it has stocked out recently, and projected back-in-stock information from the next\r\nexpected supply order. Narrow by items, sites, suppliers, or categories - by numeric ids\r\nor by business codes (ItemCodes, SiteCodes, ...).", "parameters": [ { "name": "includeNonStockPolicies", "in": "query", "description": "Include item-sites with a non-stocking order policy; these are excluded by default.", "schema": { "type": "boolean", "default": false } }, { "name": "includeItemsWithZeroSafetyStock", "in": "query", "description": "Include item-sites whose safety stock is zero; these are excluded by default since carrying no stock is intentional.", "schema": { "type": "boolean", "default": false } }, { "name": "includeReplacedItems", "in": "query", "description": "Include item-sites that have been replaced by another item; these are excluded by default.", "schema": { "type": "boolean", "default": false } }, { "name": "numberOfDaysToCheckForRecentStockouts", "in": "query", "description": "Look-back window, in days, used to count each item-site's recent stockouts. Defaults to 90.", "schema": { "type": "integer", "format": "int32", "default": 90 } } ], "requestBody": { "description": "Filter set; omit or post an empty body for all item-sites.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StockOutsDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/SupplierReceiptPerformanceOverview/fetchby/dateRangeItemSiteSupplierFilters": { "post": { "tags": [ "SupplierReceiptPerformanceOverview" ], "summary": "Returns one scorecard row per supplier for the receipts matching the posted filters -\r\norder, line, and receipt counts, on-time/early/late counts, complete/under/over receipt\r\ncounts, service levels, and average lead times and delays. Narrow by items, sites,\r\nsuppliers, categories, or a date range - by numeric ids or by business codes\r\n(ItemCodes, SupplierCodes, ...).", "parameters": [ { "name": "leadTimeType", "in": "query", "description": "Which lead-time measure to judge on-time performance against.", "schema": { "$ref": "#/components/schemas/LeadTimeType" } }, { "name": "dateFilterOption", "in": "query", "description": "Which date the date-range filters apply to: order creation date or receipt date.", "schema": { "$ref": "#/components/schemas/ReceiptDetailDateFilter" } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateRangeItemSiteSupplierFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierReceiptPerformanceOverview" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/SupplyOrderDetail/fetchby/supplyOrderDateRangeItemSiteFilters": { "post": { "tags": [ "SupplyOrderDetail" ], "summary": "Returns supply order headers (purchase orders, transfers, and work orders) matching\r\nthe posted filters, with per-order line counts, costs, weights, and cubes. Narrow by\r\nitems, sites, suppliers, categories, order numbers, statuses, or an order-creation\r\ndate range - by numeric ids or by business codes (ItemCodes, SiteCodes, ...).", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "hasBuyerEditedQuantity", "in": "query", "description": "Restricts to orders with at least one line whose quantity a buyer edited.", "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SupplyOrderDetail" } }, { "$ref": "#/components/schemas/SupplyOrderDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/SupplyOrderLineDetail/fetchby/supplyOrderDateRangeItemSiteFilters": { "post": { "tags": [ "SupplyOrderLineDetail" ], "summary": "Returns historical supply order lines (purchase orders, transfers, and work orders),\r\none row per order line, including the planning snapshot captured when the order was\r\ncreated (on-hand, lead times, safety stock, suggested vs actual quantities, ...).\r\nNarrow by items, sites, suppliers, categories, order numbers, statuses, or supply\r\ntypes - by numeric ids or by business codes (ItemCodes, SiteCodes, ...) - and by an\r\norder-creation date range.", "description": "Omit page/pageSize to receive the complete result set as a plain JSON array; supply either to receive one page in a PagedResult envelope.", "parameters": [ { "name": "hasBuyerEditedQuantity", "in": "query", "description": "Restricts to lines whose quantity a buyer edited.", "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "description": "1-based page to return. Supplying page or pageSize opts in to paging; an omitted page defaults to 1.", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." }, { "name": "pageSize", "in": "query", "description": "Rows per page. Defaults to the configured page size (1000) when omitted; bounds are configuration-enforced (1-10000 by default).", "schema": { "type": "integer", "format": "int32" }, "x-note": "This changes the return type to a paged envelope, see the description for more information." } ], "requestBody": { "description": "Filter set; omit or post an empty body for all order lines.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupplyOrderDateRangeItemSiteFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SupplyOrderLineDetail" } }, { "$ref": "#/components/schemas/SupplyOrderLineDetailPagedResult" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "x-paged": true } }, "/api/SystemStatus": { "get": { "tags": [ "SystemStatus" ], "summary": "Returns the instance's current system status: the status flag (e.g. ready, running\r\nextracts, calculating), the current calculate step, and when it last changed. Poll this\r\nto know when a data refresh has finished before pulling data.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemStatus" } } } } } } } }, "/api/UnderforecastedPeriodDetail/fetchby/hierarchyNodeFilters": { "post": { "tags": [ "UnderforecastedPeriodDetail" ], "summary": "Returns periods where actual demand materially exceeded the forecast, one row per\r\nhierarchy node per period, including forecast quantities, actuals, and forecast error\r\nmeasures. Post filters in the body to narrow by items, sites, customers, categories, or\r\ntags - by numeric ids or by business codes (ItemCodes, SiteCodes, ...). Period\r\nrestrictions (startDate, endDate, yearNumbers, quarterNumbers, monthNumbers) ride the\r\nquery string.", "parameters": [ { "name": "itemHierarchyId", "in": "query", "description": "The forecast hierarchy to evaluate.", "schema": { "type": "integer", "format": "int32" } }, { "name": "demandForecastSeriesId", "in": "query", "description": "The forecast series to read, e.g. the operational forecast.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeLevel", "in": "query", "description": "Restricts the result to nodes at one level of the hierarchy (1 = top).", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Earliest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Latest period date to include.", "schema": { "type": "string", "format": "date-time" } }, { "name": "yearNumbers", "in": "query", "description": "Restricts to periods in the given years.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "quarterNumbers", "in": "query", "description": "Restricts to periods in the given quarters (1-4).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "monthNumbers", "in": "query", "description": "Restricts to periods in the given months (1-12).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "requestBody": { "description": "Filter set; omit or post an empty body for no filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HierarchyNodeFilters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnderforecastedPeriodDetail" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AlertDetailFilters": { "type": "object", "properties": { "AlertTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AlertType" }, "description": "Restrict to these alert types.", "nullable": true }, "AlertPriorities": { "type": "array", "items": { "$ref": "#/components/schemas/AlertPriority" }, "description": "Restrict to these alert priorities.", "nullable": true }, "AlertStates": { "type": "array", "items": { "$ref": "#/components/schemas/AlertState" }, "description": "Restrict to alerts in these states (e.g. active, suspended).", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items whose supplier item code contains one of these values (substring match).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "CustomerShipToCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 1 ids.", "nullable": true }, "CustomerShipToCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 2 ids.", "nullable": true }, "CustomerShipToCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 3 ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "CustomerShipToIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerShipToCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customer ship-tos with these ship-to codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false, "description": "Filters for alert detail queries: the full hierarchy-node filter set plus the\r\nalert-specific dimensions (type, priority, state)." }, "AlertPrimaryIdProperty": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Values: 1 = ItemSiteId; 2 = ItemSiteSupplierId; 3 = HierarchyNodeId; 4 = ItemId.", "format": "int32" }, "AlertPriority": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = None; 1 = Low; 2 = Medium; 4 = High.", "format": "int32" }, "AlertState": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = None; 1 = Active; 2 = Suspended; 4 = Ignored.", "format": "int32" }, "AlertType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25 ], "type": "integer", "description": "Values: 1 = StockOut; 2 = SlowMover; 3 = DeadStock; 4 = ItemSiteServiceLevel; 5 = Backorders; 6 = LateSupplyOrder; 7 = InventoryExpiration; 8 = UnderForecast; 9 = OverForecast; 10 = ForecastError; 11 = ForecastVsModel; 12 = CurrentExcess; 13 = NewItem; 14 = UnusualSales; 15 = PlanAtRisk; 16 = SafetyStock; 17 = CriticalOrder; 18 = PromotionFrequency; 19 = PromotionDepth; 20 = PromotionLength; 21 = OrderStatus; 22 = ProjectedStockOut; 23 = ProjectedExcess; 24 = LargeMinMult; 25 = OverdueToBuy.", "format": "int32" }, "AlternateOrderTargetQuantity": { "enum": [ 0, 1, 2, 4, 6, 7, 8, 128 ], "type": "integer", "description": "Values: 0 = Any; 1 = OnHand; 2 = CurrentAvailable; 4 = ProjectedAvailable; 6 = PlannedOverstock; 7 = Overstock; 8 = Excess; 128 = Disabled.", "format": "int32" }, "AuthenticateRequest": { "type": "object", "properties": { "token": { "type": "string", "description": "The API token secret issued at creation (the `siq_...` value).", "nullable": true } }, "additionalProperties": false }, "AuthenticateResponse": { "required": [ "access_token", "token_type" ], "type": "object", "properties": { "access_token": { "type": "string", "nullable": true }, "token_type": { "type": "string", "nullable": true }, "expires_in": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AverageLeadTime": { "type": "object", "properties": { "PeriodDate": { "type": "string", "format": "date-time" }, "AdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "VendorLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "SampleCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BlanketPurchaseOrderLineDetail": { "type": "object", "properties": { "ErrorMessages": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineErrorMessage" }, "nullable": true }, "Guid": { "type": "string", "nullable": true }, "ItemSiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "ItemSiteSupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "IsInOrder": { "type": "boolean" }, "IsEditingAllowed": { "type": "boolean" }, "IsUnderMinOrderQuantity": { "type": "boolean" }, "IsOverMaxOrderQuantity": { "type": "boolean", "readOnly": true }, "ViolatesOrderMultipleQuantity": { "type": "boolean", "readOnly": true }, "IsUnderSupplierMinimum": { "type": "boolean" }, "IsUnderSupplierItemMinimum": { "type": "boolean", "nullable": true }, "HasExpectedShipDateProblem": { "type": "boolean", "readOnly": true }, "UserEditedPurchaseCost": { "type": "boolean" }, "HasPlannedFirstShipDateProblem": { "type": "boolean" }, "SiteId": { "type": "integer", "format": "int32", "readOnly": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "SiteCode": { "type": "string", "nullable": true, "readOnly": true }, "ReleaseNumber": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "PlannedReceiptDate": { "type": "string", "format": "date-time" }, "CurrentExcessThreshold": { "type": "number", "format": "double", "readOnly": true }, "RawReleaseQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "AbcClass": { "type": "string", "nullable": true, "readOnly": true }, "XyzClass": { "type": "string", "nullable": true, "readOnly": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "ActiveSupplierLevel": { "type": "integer", "format": "int32", "readOnly": true }, "HubCount": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ItemSiteId": { "type": "integer", "format": "int32", "readOnly": true }, "ItemSiteSupplierId": { "type": "integer", "format": "int32", "readOnly": true }, "RemainingBlanketPoQuantity": { "type": "number", "format": "double", "readOnly": true }, "LinePurchaseCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "EstimatedReceivingCost": { "type": "number", "format": "double", "nullable": true }, "EstimatedCostOfOrdering": { "type": "number", "format": "double", "nullable": true }, "LineSupplierCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StockIqSuggestedReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "ReleaseQuantity": { "type": "number", "description": "Release/Order quantity, expressed in StockingUoM", "format": "double" }, "PurchaseQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ReleaseQuantityBeforePricebreakModifications": { "type": "number", "format": "double", "nullable": true }, "PurchaseQuantityCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnitCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "HistoricalMonthlyUsage": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ForecastedMonthlyUsage": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "MonthlyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineWeight": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LinePallets": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineEquivalencyUnits": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "OrderDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedActualAvailableAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ProjectedAvailableAtLeadTimeWithoutOrderSuggestion": { "type": "number", "format": "double", "nullable": true }, "DaysUntilNextCostChange": { "type": "integer", "format": "int32", "nullable": true }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "InventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "StandardPrice": { "type": "number", "format": "double", "readOnly": true }, "StandardPriceCurrency": { "type": "string", "nullable": true, "readOnly": true }, "DateCreated": { "type": "string", "format": "date-time", "readOnly": true }, "DateUpdated": { "type": "string", "format": "date-time", "readOnly": true }, "ProjectedDaysOfSupplyOnArrival": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedOnHandQuantity": { "type": "number", "description": "how many will we have when this arrives a lead time from today?", "format": "double", "nullable": true, "readOnly": true }, "ProjectedDaysCycleStockOnArrival": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "OnBlanketOrderQty": { "type": "number", "format": "double", "nullable": true }, "BlanketPurchaseOrderId": { "type": "integer", "format": "int32" }, "BlanketPurchaseOrderLineId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ErpBlanketOrderNumber": { "type": "string", "nullable": true }, "StockIqBlanketOrderNumber": { "type": "string", "nullable": true }, "ReleasesSkipManufacturingLeadTime": { "type": "boolean" }, "OrderCreationDate": { "type": "string", "format": "date-time", "nullable": true }, "InternalNote": { "type": "string", "nullable": true }, "ExternalNote": { "type": "string", "nullable": true }, "CreatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierItemCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "SupplierLocationId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierLocationName": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "Upc": { "type": "string", "nullable": true }, "UnitHeight": { "type": "number", "format": "double", "nullable": true }, "UnitLength": { "type": "number", "format": "double", "nullable": true }, "UnitWidth": { "type": "number", "format": "double", "nullable": true }, "UnitWeight": { "type": "number", "format": "double", "nullable": true }, "EquivalencyUnits": { "type": "number", "format": "double", "nullable": true }, "SizeUnits": { "$ref": "#/components/schemas/SizeUnits" }, "UnitsPerPallet": { "type": "number", "format": "double", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "SyncStatus": { "$ref": "#/components/schemas/BlanketPurchaseOrderSyncStatus" }, "ErpBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "StockIqBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "ContainerNumber": { "type": "string", "nullable": true }, "BlanketPoLineStatus": { "$ref": "#/components/schemas/BlanketPurchaseOrderLineStatus" }, "BlanketPoQuantity": { "type": "number", "format": "double" }, "OriginalBlanketPoQuantity": { "type": "number", "format": "double", "nullable": true }, "PurchaseCost": { "type": "number", "format": "double" }, "PurchaseCostCurrency": { "type": "string", "nullable": true }, "ExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "InternalLineComment": { "type": "string", "nullable": true }, "ExternalLineComment": { "type": "string", "nullable": true }, "UserEditedReleaseQuantity": { "type": "boolean" }, "UserEditedShipDate": { "type": "boolean" }, "PurchaseCostStatus": { "$ref": "#/components/schemas/PurchaseCostStatus" }, "StockIqSuggestedBlanketPoQuantity": { "type": "number", "format": "double", "nullable": true }, "SupplierCost": { "type": "number", "format": "double" }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "OrderMultipleQuantity": { "type": "integer", "format": "int32", "nullable": true }, "MaxOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "YieldPercentage": { "type": "number", "format": "double", "nullable": true }, "UnitOfMeasure": { "type": "string", "nullable": true }, "PurchaseUnitOfMeasure": { "type": "string", "nullable": true }, "StockingUnitsPerPurchaseUnits": { "type": "number", "format": "double", "nullable": true }, "SupplierOnHand": { "type": "number", "format": "double", "nullable": true }, "ActiveAdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "TotalOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalOnDemandOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalInTransitQuantity": { "type": "number", "format": "double", "nullable": true }, "HistoricalDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "DailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ActivePanicPoint": { "type": "number", "format": "double", "nullable": true }, "ActiveSafetyStock": { "type": "number", "format": "double", "nullable": true }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActiveMaxStock": { "type": "number", "format": "double", "nullable": true }, "NextSupplierCost": { "type": "number", "format": "double", "nullable": true }, "NextSupplierCostDate": { "type": "string", "format": "date-time", "nullable": true }, "OriginalExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "ApprovedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "ReleasedQuantity": { "type": "number", "format": "double", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlanketPurchaseOrderLineStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 128 ], "type": "integer", "description": "Values: 0 = NotSet; 1 = Created; 2 = Review; 3 = Open; 4 = Canceled; 5 = Closed; 128 = Error.", "format": "int32" }, "BlanketPurchaseOrderSyncStatus": { "enum": [ 1, 2, 4, 8, 16 ], "type": "integer", "description": "Values: 1 = NeedsInitialSync; 2 = Sent; 4 = Synced; 8 = NeedsReSync; 16 = NotApplicable.", "format": "int32" }, "BoMPosition": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = None; 1 = Bottom; 2 = Middle; 4 = Top.", "format": "int32" }, "ChartConstantLine": { "type": "object", "properties": { "PeriodDate": { "type": "string", "format": "date-time" }, "Label": { "type": "string", "nullable": true }, "LineType": { "$ref": "#/components/schemas/ChartConstantLineType" } }, "additionalProperties": false }, "ChartConstantLineType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Values: 1 = YearMarker; 2 = CurrentPeriod; 3 = LeadTimePeriod; 4 = SawtoothUnlockDate.", "format": "int32" }, "CurrentExcessDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "MarginPercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ExcessDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "SiteGroupExcessDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrentDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PreferredExcessThreshold": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PreferredExcessQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "DateCreated": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstStocked": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteGroupName": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "InventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "CurrentCost": { "type": "number", "format": "double" }, "StandardCost": { "type": "number", "format": "double" }, "TotalOnHandQuantity": { "type": "number", "format": "double" }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "StandardPrice": { "type": "number", "format": "double" }, "OnHandBalance": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "CurrentExcessThreshold": { "type": "number", "format": "double", "nullable": true }, "ExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "ExcessBalance": { "type": "number", "format": "double", "nullable": true }, "TotalForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "TotalDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32" }, "OrderMultipleQuantity": { "type": "integer", "format": "int32" }, "OnHandCubes": { "type": "number", "format": "double", "nullable": true }, "ExcessCubes": { "type": "number", "format": "double", "nullable": true }, "CustomerShipToCount": { "type": "integer", "format": "int32", "nullable": true }, "CustomerCount": { "type": "integer", "format": "int32", "nullable": true }, "FirstSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "LastSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "NumberOfOpenSupplies": { "type": "integer", "format": "int32", "nullable": true }, "NextOrderRemainingReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextErpOrderNumber": { "type": "string", "nullable": true }, "NextPlannedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "LastOrderedDate": { "type": "string", "format": "date-time", "nullable": true }, "LastReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "InventoryPositionAtLeadTime": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "SiteGroupInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "SiteGroupUsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "SiteGroupCurrentExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "SiteGroupCurrentExcessThreshold": { "type": "number", "format": "double", "nullable": true }, "SiteGroupTotalForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ActivePreferredMaxStock": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveMaxStock": { "type": "number", "format": "double", "readOnly": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "TotalOnDemandOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "LastErpOrderNumber": { "type": "string", "nullable": true }, "LastStockIqOrderNumber": { "type": "string", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "CustomField": { "type": "object", "properties": { "CustomFieldId": { "type": "integer", "format": "int32" }, "CustomFieldCode": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "EntityType": { "type": "string", "nullable": true }, "DataType": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "Source": { "$ref": "#/components/schemas/SettingSource" }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "CreatedByUserId": { "type": "integer", "format": "int32" }, "UpdatedByUserId": { "type": "integer", "format": "int32" }, "Note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomReportParameter": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "SqlTypeName": { "type": "string", "nullable": true }, "Type": { "type": "string", "description": "Client-facing type discriminator derived from SqlTypeName — one of StockIQ.Entities.Cnfg.CustomReportParameterTypes.", "nullable": true }, "IsRequired": { "type": "boolean", "description": "True when the parameter declares no default in the procedure header, so SQL Server\r\nwill fail if it is not supplied." } }, "additionalProperties": false, "description": "A single input parameter of a custom report's cust-schema stored procedure, discovered by\r\nintrospecting sys.parameters (cnfg.CustomReportParameterSelectByStoredProcedureName) rather\r\nthan stored configuration — so the definition can never drift from the sproc itself." }, "CustomerItemDueToBuyDetail": { "type": "object", "properties": { "DaysSinceLastPurchase": { "type": "integer", "format": "int32", "nullable": true }, "OverdueByDays": { "type": "integer", "format": "int32", "nullable": true }, "ProbabilityOfPurchase": { "type": "number", "format": "double", "nullable": true }, "LostCustomerItemRecordExists": { "type": "boolean", "readOnly": true }, "Last6MonthsHits": { "type": "number", "format": "double" }, "Last6MonthsQuantitySold": { "type": "number", "format": "double" }, "Last6MonthsCogs": { "type": "number", "format": "double" }, "Last6MonthsRevenue": { "type": "number", "format": "double" }, "Last6MonthsMargin": { "type": "number", "format": "double" }, "AverageSaleQuantity": { "type": "number", "format": "double", "nullable": true }, "AllWarehousesOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "AllWarehousesOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true, "readOnly": true }, "AbcClass": { "type": "string", "nullable": true, "readOnly": true }, "XyzClass": { "type": "string", "nullable": true, "readOnly": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "BuyerName": { "type": "string", "nullable": true, "readOnly": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerCode": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32" }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32" }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "MeanInterarrivalDays": { "type": "integer", "format": "int32" }, "MaxOnTimeInterarrivalDays": { "type": "integer", "format": "int32" }, "GeometricParameter": { "type": "number", "format": "double" }, "CustomerItemStatus": { "$ref": "#/components/schemas/CustomerItemStatus" }, "CustomerItemUsagePattern": { "type": "integer", "format": "int32" }, "ExpectedNextPurchaseDate": { "type": "string", "format": "date-time", "nullable": true }, "LatestExpectedNextPurchaseDate": { "type": "string", "format": "date-time", "nullable": true }, "FirstPurchaseDate": { "type": "string", "format": "date-time", "nullable": true }, "LastPurchaseDate": { "type": "string", "format": "date-time", "nullable": true }, "LastOrderNumber": { "type": "string", "nullable": true }, "LifetimeQuantitySold": { "type": "number", "format": "double" }, "LifetimeHits": { "type": "number", "format": "double" }, "LifetimeCogs": { "type": "number", "format": "double" }, "LifetimeRevenue": { "type": "number", "format": "double" }, "LifetimeMargin": { "type": "number", "format": "double" }, "YTDQuantitySold": { "type": "number", "format": "double" }, "YTDHits": { "type": "number", "format": "double" }, "YTDCogs": { "type": "number", "format": "double" }, "YTDRevenue": { "type": "number", "format": "double" }, "YTDMargin": { "type": "number", "format": "double" }, "LostItemCustomerId": { "type": "integer", "format": "int32" }, "TypicalOrderQuantity": { "type": "number", "format": "double" }, "TypicalOrderValue": { "type": "number", "format": "double" }, "ItemLastInStockDate": { "type": "string", "format": "date-time", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerItemDueToBuyFilters": { "type": "object", "properties": { "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "UsagePatterns": { "type": "array", "items": { "$ref": "#/components/schemas/UsagePattern" }, "description": "Restrict to these usage patterns.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerItemStatus" }, "description": "Restrict to customer/item combinations in these due-to-buy statuses (e.g. DueToBuy, Overdue).", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false, "description": "Filters for the customer/item \"due to buy\" query. This data is customer-and-item grain\r\n(no site or supplier dimension), so it has its own slim filter set." }, "CustomerItemStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = SingleBuy; 2 = OK; 3 = DueToBuy; 4 = Overdue.", "format": "int32" }, "DateRangeHierarchyNodeFilters": { "type": "object", "properties": { "StartDate": { "type": "string", "description": "Earliest date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "Latest date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "YearNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these calendar year numbers (e.g. 2026).", "nullable": true }, "QuarterNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these quarter numbers (1-4).", "nullable": true }, "MonthNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these month numbers (1-12).", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items whose supplier item code contains one of these values (substring match).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "CustomerShipToCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 1 ids.", "nullable": true }, "CustomerShipToCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 2 ids.", "nullable": true }, "CustomerShipToCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 3 ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "CustomerShipToIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerShipToCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customer ship-tos with these ship-to codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "DateRangeItemSiteFilters": { "type": "object", "properties": { "StartDate": { "type": "string", "description": "Earliest date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "Latest date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "YearNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these calendar year numbers (e.g. 2026).", "nullable": true }, "QuarterNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these quarter numbers (1-4).", "nullable": true }, "MonthNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these month numbers (1-12).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatus" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "BoMPositions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items at these bill-of-material positions.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict by supplier item code (exact match). On item-site level endpoints this matches\r\nthe primary supplier's item code; on supplier-relationship level endpoints (receipts,\r\nlead times) it matches the code on the returned relationship.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "DateRangeItemSiteSupplierFilters": { "type": "object", "properties": { "StartDate": { "type": "string", "description": "Earliest date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "Latest date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "YearNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these calendar year numbers (e.g. 2026).", "nullable": true }, "QuarterNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these quarter numbers (1-4).", "nullable": true }, "MonthNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these month numbers (1-12).", "nullable": true }, "SupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-site-supplier relationships with these supplier ids (any supplier\r\nrelationship, not just the primary one - contrast with the inherited PrimarySupplierIds).", "nullable": true }, "SupplierLevels": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these supplier levels (1 = the item-site's primary supplier).", "nullable": true }, "SupplierItemCategories": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these supplier item category ids.", "nullable": true }, "MultiHubFilter": { "$ref": "#/components/schemas/MultiHubFilter" }, "SupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to suppliers with these supplier codes (any supplier relationship). Unknown codes fail the request with a 400.", "nullable": true }, "AreEmptyOtherThanSupplierLevel": { "type": "boolean", "readOnly": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatus" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "BoMPositions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items at these bill-of-material positions.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict by supplier item code (exact match). On item-site level endpoints this matches\r\nthe primary supplier's item code; on supplier-relationship level endpoints (receipts,\r\nlead times) it matches the code on the returned relationship.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "DaysCoverageMode": { "enum": [ 1, 2 ], "type": "integer", "description": "Values: 1 = ReleaseDate; 2 = ShipDate.", "format": "int32" }, "DemandForecastControl": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Values: 0 = NotForecasted; 1 = Auto; 2 = Manual.", "format": "int32" }, "DemandForecastSnapshotExportDetail": { "type": "object", "properties": { "DemandForecastSnapshotId": { "type": "integer", "description": "Identifier of the snapshot this period row belongs to.", "format": "int32" }, "DemandForecastSeriesId": { "type": "integer", "description": "Identifier of the demand forecast series the snapshot was taken from.", "format": "int32" }, "DemandForecastSeriesCode": { "type": "string", "description": "Code of the demand forecast series.", "nullable": true }, "DemandForecastSeriesName": { "type": "string", "description": "Display name of the demand forecast series.", "nullable": true }, "SnapshotDate": { "type": "string", "description": "Date the snapshot was taken.", "format": "date-time" }, "SnapshotName": { "type": "string", "description": "Name assigned to the snapshot when it was taken.", "nullable": true }, "Interval": { "$ref": "#/components/schemas/TimeInterval" }, "UnitOfMeasure": { "$ref": "#/components/schemas/TimeSeriesUnitOfMeasure" }, "IsSystemGenerated": { "type": "boolean", "description": "True when the snapshot was taken automatically; false when a user saved it." }, "MeanAbsoluteError": { "type": "number", "description": "Mean absolute error of the forecast at the time the snapshot was taken.", "format": "double", "nullable": true }, "RootMeanSquaredError": { "type": "number", "description": "Root mean squared error of the forecast at the time the snapshot was taken.", "format": "double", "nullable": true }, "AverageUsage": { "type": "number", "description": "Average per-period usage observed at the time the snapshot was taken.", "format": "double", "nullable": true }, "AverageForecast": { "type": "number", "description": "Average per-period forecast quantity at the time the snapshot was taken.", "format": "double", "nullable": true }, "NumErrorSamples": { "type": "integer", "description": "Number of periods sampled for the snapshot's error statistics.", "format": "int32", "nullable": true }, "HierarchyNodeId": { "type": "integer", "description": "Identifier of the forecast hierarchy node the snapshot was taken on. Stable join key across API calls.", "format": "int32" }, "NodeLevel": { "type": "integer", "description": "Hierarchy level of the node (1 = top; larger numbers are deeper).", "format": "int32" }, "NodeValue": { "type": "string", "description": "The node's own value at its level (for example the item code on an item-level node).", "nullable": true }, "NodeTitle": { "type": "string", "description": "Full display path of the node within the hierarchy.", "nullable": true }, "HierarchyProperty": { "$ref": "#/components/schemas/HierarchyProperty" }, "LevelName": { "type": "string", "description": "Display name of the node's hierarchy level, using your configured category names.", "nullable": true }, "ItemCode": { "type": "string", "description": "Item code, when an item is on the node's hierarchy path.", "nullable": true }, "ItemDescription": { "type": "string", "description": "Item description, when an item is on the node's hierarchy path.", "nullable": true }, "SiteCode": { "type": "string", "description": "Site code, when a site is on the node's hierarchy path.", "nullable": true }, "ShipperCode": { "type": "string", "description": "Shipper code, when a shipper is on the node's hierarchy path.", "nullable": true }, "CustomerCode": { "type": "string", "description": "Customer code, when a customer is on the node's hierarchy path.", "nullable": true }, "CustomerShipToCode": { "type": "string", "description": "Customer ship-to code, when a ship-to is on the node's hierarchy path.", "nullable": true }, "PrimarySupplierCode": { "type": "string", "description": "Primary supplier code, when the node resolves to a single item-site.", "nullable": true }, "ItemSiteCategory1Code": { "type": "string", "description": "Item-site category 1 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory2Code": { "type": "string", "description": "Item-site category 2 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory3Code": { "type": "string", "description": "Item-site category 3 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory4Code": { "type": "string", "description": "Item-site category 4 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory5Code": { "type": "string", "description": "Item-site category 5 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory6Code": { "type": "string", "description": "Item-site category 6 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory7Code": { "type": "string", "description": "Item-site category 7 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory8Code": { "type": "string", "description": "Item-site category 8 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory1Code": { "type": "string", "description": "Customer ship-to category 1 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory2Code": { "type": "string", "description": "Customer ship-to category 2 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory3Code": { "type": "string", "description": "Customer ship-to category 3 code, when on the node's hierarchy path.", "nullable": true }, "PeriodDate": { "type": "string", "description": "Forecast period this row's values apply to (a week or month sentinel date, per Interval).", "format": "date-time" }, "Quantity": { "type": "number", "description": "Forecast quantity for the period, excluding replaced-item demand.", "format": "double" }, "Cogs": { "type": "number", "description": "Forecast cost of goods for the period, excluding replaced-item demand.", "format": "double" }, "Revenue": { "type": "number", "description": "Forecast revenue for the period, excluding replaced-item demand.", "format": "double" }, "Margin": { "type": "number", "description": "Forecast margin for the period, excluding replaced-item demand.", "format": "double" }, "AverageCost": { "type": "number", "description": "Average unit cost used to value the period.", "format": "double" }, "AveragePrice": { "type": "number", "description": "Average unit price used to value the period.", "format": "double" }, "ReplacedQuantity": { "type": "number", "description": "Forecast quantity carried over from replaced items, when replacements exist.", "format": "double", "nullable": true }, "ReplacedCogs": { "type": "number", "description": "Forecast cost of goods carried over from replaced items, when replacements exist.", "format": "double", "nullable": true }, "ReplacedRevenue": { "type": "number", "description": "Forecast revenue carried over from replaced items, when replacements exist.", "format": "double", "nullable": true }, "ReplacedMargin": { "type": "number", "description": "Forecast margin carried over from replaced items, when replacements exist.", "format": "double", "nullable": true }, "TotalQuantity": { "type": "number", "description": "Total forecast quantity for the period: Quantity plus ReplacedQuantity.", "format": "double", "readOnly": true }, "TotalCogs": { "type": "number", "description": "Total forecast cost of goods for the period: Cogs plus ReplacedCogs.", "format": "double", "readOnly": true }, "TotalRevenue": { "type": "number", "description": "Total forecast revenue for the period: Revenue plus ReplacedRevenue.", "format": "double", "readOnly": true }, "TotalMargin": { "type": "number", "description": "Total forecast margin for the period: Margin plus ReplacedMargin.", "format": "double", "readOnly": true } }, "additionalProperties": false, "description": "One flattened demand forecast snapshot period row for bulk extraction: the snapshot header,\r\nthe forecast hierarchy node it was taken on (with business codes for easy joining), and one\r\nforecast period's values. Grain: series x node x snapshot date x period date." }, "DemandForecastSnapshotExportDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/DemandForecastSnapshotExportDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "DemandForecastSnapshotFilters": { "type": "object", "properties": { "SnapshotStartDate": { "type": "string", "description": "Earliest snapshot date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "SnapshotEndDate": { "type": "string", "description": "Latest snapshot date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "PeriodStartDate": { "type": "string", "description": "Earliest forecast period date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "PeriodEndDate": { "type": "string", "description": "Latest forecast period date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "DemandForecastSeriesIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these demand forecast series ids. Empty = all series.", "nullable": true }, "DemandForecastSeriesCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these demand forecast series codes. Empty = all series.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items whose supplier item code contains one of these values (substring match).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "CustomerShipToCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 1 ids.", "nullable": true }, "CustomerShipToCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 2 ids.", "nullable": true }, "CustomerShipToCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 3 ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "CustomerShipToIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerShipToCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customer ship-tos with these ship-to codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false, "description": "Body for POST api/DemandForecastSnapshotExportDetail/fetchby/demandForecastSnapshotFilters.\r\nExtends the hierarchy filter set with the snapshot dimensions: which forecast series, the\r\nsnapshot-date range, and the forecast-period-date range. The two date ranges are deliberately\r\nnamed (Snapshot* / Period*) because a snapshot row has both a taken-on date and forecast\r\nperiod dates." }, "DemandType": { "enum": [ 1, 2, 4, 8, 16, 32 ], "type": "integer", "description": "Values: 1 = SalesOrder; 2 = TransferOrder; 4 = WorkOrder; 8 = Unbuild; 16 = ActualAdjustment; 32 = Estimate.", "format": "int32" }, "DiscontinuedItemDetail": { "type": "object", "properties": { "DaysUntilDepleted": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ResolvedItemStatus": { "type": "integer", "format": "int32" }, "DiscontinuedReason": { "type": "integer", "format": "int32", "nullable": true }, "ActiveOrderPolicy": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "CurrentCost": { "type": "number", "format": "double" }, "StandardCost": { "type": "number", "format": "double" }, "OnHandQuantity": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "EffectiveDateObsolete": { "type": "string", "format": "date-time", "nullable": true }, "FinalDepletionDate": { "type": "string", "format": "date-time", "nullable": true }, "UsagePattern": { "type": "integer", "format": "int32" }, "InventoryPosition": { "type": "integer", "format": "int32" }, "StandardCostCurrency": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstStocked": { "type": "string", "format": "date-time", "nullable": true }, "FirstSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "LastSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "OnHandBalance": { "type": "number", "format": "double" }, "ExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "ExcessBalance": { "type": "number", "format": "double", "nullable": true }, "TotalHistoricalDailyUsage": { "type": "number", "format": "double" }, "TotalForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "TotalDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "CustomerShipToCount": { "type": "integer", "format": "int32", "nullable": true }, "CustomerCount": { "type": "integer", "format": "int32", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextOrderRemainingReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "NumberOfOpenSupplies": { "type": "integer", "format": "int32", "nullable": true }, "TotalHits": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "FirmAndPlannedOrderDetail": { "type": "object", "properties": { "TotalQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalDollars": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalWeight": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "SupplierId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "MonthId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "PeriodStartDate": { "type": "string", "format": "date-time" }, "PeriodEndDate": { "type": "string", "format": "date-time" }, "FirmQuantity": { "type": "number", "format": "double", "nullable": true }, "FirmDollars": { "type": "number", "format": "double", "nullable": true }, "FirmCubes": { "type": "number", "format": "double", "nullable": true }, "FirmQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "FirmWeight": { "type": "number", "format": "double", "nullable": true }, "FirmImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantity": { "type": "number", "format": "double", "nullable": true }, "PlannedDollars": { "type": "number", "format": "double", "nullable": true }, "PlannedCubes": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "PlannedWeight": { "type": "number", "format": "double", "nullable": true }, "PlannedImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "ImportTaxPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FirmAndPlannedOrderDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedOrderDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "FirmAndPlannedReceiptDetail": { "type": "object", "properties": { "TotalQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalDollars": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalWeight": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "SupplierId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "WeekId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "PeriodStartDate": { "type": "string", "format": "date-time" }, "PeriodEndDate": { "type": "string", "format": "date-time" }, "FirmQuantity": { "type": "number", "format": "double", "nullable": true }, "FirmDollars": { "type": "number", "format": "double", "nullable": true }, "FirmCubes": { "type": "number", "format": "double", "nullable": true }, "FirmQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "FirmWeight": { "type": "number", "format": "double", "nullable": true }, "FirmImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantity": { "type": "number", "format": "double", "nullable": true }, "PlannedDollars": { "type": "number", "format": "double", "nullable": true }, "PlannedCubes": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "PlannedWeight": { "type": "number", "format": "double", "nullable": true }, "PlannedImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "ImportTaxPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FirmAndPlannedReceiptDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedReceiptDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "FirmAndPlannedShipmentDetail": { "type": "object", "properties": { "TotalQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalDollars": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalWeight": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "SupplierId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "MonthId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "PeriodStartDate": { "type": "string", "format": "date-time" }, "PeriodEndDate": { "type": "string", "format": "date-time" }, "FirmQuantity": { "type": "number", "format": "double", "nullable": true }, "FirmDollars": { "type": "number", "format": "double", "nullable": true }, "FirmCubes": { "type": "number", "format": "double", "nullable": true }, "FirmQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "FirmWeight": { "type": "number", "format": "double", "nullable": true }, "FirmImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantity": { "type": "number", "format": "double", "nullable": true }, "PlannedDollars": { "type": "number", "format": "double", "nullable": true }, "PlannedCubes": { "type": "number", "format": "double", "nullable": true }, "PlannedQuantityInPurchaseUoM": { "type": "number", "format": "double", "nullable": true }, "PlannedWeight": { "type": "number", "format": "double", "nullable": true }, "PlannedImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "ImportTaxPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FirmAndPlannedShipmentDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/FirmAndPlannedShipmentDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "FirmAndPlannedType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Values: 1 = OrderDate; 2 = ShipDate; 3 = ReceiptDate.", "format": "int32" }, "ForecastErrorsSummary": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "ForecastSeriesName": { "type": "string", "nullable": true }, "LeadTimeAgoLagPeriodCount": { "type": "integer", "format": "int32", "nullable": true }, "SnapshotDate": { "type": "string", "format": "date-time", "nullable": true }, "LeadTimeAgoAverageForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoAverageForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "StatisticalVsNaiveForecastValueAdded": { "type": "number", "description": "Current-day stat versus naive FVA", "format": "double", "nullable": true, "readOnly": true }, "OperationalVsStatisticalForecastValueAdded": { "type": "number", "description": "Current-day stat versus naive FVA", "format": "double", "nullable": true, "readOnly": true }, "LeadTimeAgoAverageForecastErrorPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoMeanAbsoluteErrorVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoAverageForecastErrorValueVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoForecastBiasPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastErrorPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastMeanAbsoluteErrorVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastErrorValueVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoNaiveForecastBiasPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastErrorPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastMeanAbsoluteErrorVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastErrorValueVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatForecastBiasPercentVsCurrent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoStatisticalVsNaiveForecastValueAdded": { "type": "number", "description": "Lead-Time-Ago Stat vs Benchmark FVA", "format": "double", "nullable": true, "readOnly": true }, "LeadTimeAgoOperationalVsStatisticalForecastValueAdded": { "type": "number", "description": "Current-day stat versus naive FVA", "format": "double", "nullable": true, "readOnly": true }, "LagPeriodAverageForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LagPeriodAverageForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LagPeriodForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodNaiveForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodNaiveForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LagPeriodNaiveForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LagPeriodNaiveForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodStatForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodStatForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "LagPeriodStatForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "LagPeriodStatForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LagPeriodStatisticalVsNaiveForecastValueAdded": { "type": "number", "description": "Lead-Time-Ago Stat vs Benchmark FVA", "format": "double", "nullable": true, "readOnly": true }, "LagPeriodOperationalVsStatisticalForecastValueAdded": { "type": "number", "description": "Current-day stat versus naive FVA", "format": "double", "nullable": true, "readOnly": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerShipToId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "NodeTitle": { "type": "string", "nullable": true }, "DemandForecastSeriesId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesName": { "type": "string", "nullable": true }, "NodeValue": { "type": "string", "nullable": true }, "ShipperName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteName": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "NaiveForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "NaiveForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "NaiveForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "NaiveForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "StatForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "StatForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "StatForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "StatForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "LeadTimeAgoDemandForecastSnapshotId": { "type": "integer", "format": "int32", "nullable": true }, "Interval": { "$ref": "#/components/schemas/TimeInterval" }, "DemandForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "DemandForecastMeanAbsoluteError": { "type": "number", "format": "double", "nullable": true }, "DemandForecastErrorValue": { "type": "number", "format": "double", "nullable": true }, "DemandForecastBiasPercent": { "type": "number", "format": "double", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ForecastSummaryNodeFilterOption": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Values: 0 = ShowAll; 1 = WithForecast; 2 = WithoutForecast.", "format": "int32" }, "ForecastVsModelDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "ToleranceUpperBound": { "type": "number", "format": "double", "nullable": true }, "ToleranceLowerBound": { "type": "number", "format": "double", "nullable": true }, "LevelName": { "type": "string", "nullable": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "NodeLevel": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToId": { "type": "integer", "format": "int32", "nullable": true }, "DemandForecastSeriesName": { "type": "string", "nullable": true }, "NodeValue": { "type": "string", "nullable": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesId": { "type": "integer", "format": "int32" }, "PeriodDate": { "type": "string", "format": "date-time" }, "Interval": { "type": "integer", "format": "int32" }, "ForecastQuantity": { "type": "number", "format": "double" }, "StatisticalForecastQuantity": { "type": "number", "format": "double" }, "ForecastAverageQuantity": { "type": "number", "format": "double" }, "StatisticalAverageQuantity": { "type": "number", "format": "double" }, "ForecastRevenue": { "type": "number", "format": "double" }, "StatisticalForecastRevenue": { "type": "number", "format": "double" }, "AverageForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "AverageStatisticalErrorPercent": { "type": "number", "format": "double", "nullable": true }, "ForecastVsStatisticalUnitVariance": { "type": "number", "format": "double" }, "ForecastVsStatisticalDollarVariance": { "type": "number", "format": "double" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "ForecastControl": { "$ref": "#/components/schemas/DemandForecastControl" }, "AutoForecastReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "IsPeriodLocked": { "type": "boolean" }, "ShipperName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "HierarchyLevelActualsExportDetail": { "type": "object", "properties": { "NodeLevel": { "type": "integer", "description": "Hierarchy level of the node (1 = top; larger numbers are deeper).", "format": "int32" }, "NodeValue": { "type": "string", "description": "The node's own value at its level (for example the item code on an item-level node).", "nullable": true }, "LevelName": { "type": "string", "description": "Display name of the node's hierarchy level, using your configured category names.", "nullable": true }, "ItemCode": { "type": "string", "description": "Item code, when an item is on the node's hierarchy path.", "nullable": true }, "ItemDescription": { "type": "string", "description": "Item description, when an item is on the node's hierarchy path.", "nullable": true }, "SiteCode": { "type": "string", "description": "Site code, when a site is on the node's hierarchy path.", "nullable": true }, "ShipperCode": { "type": "string", "description": "Shipper code, when a shipper is on the node's hierarchy path.", "nullable": true }, "CustomerCode": { "type": "string", "description": "Customer code, when a customer is on the node's hierarchy path.", "nullable": true }, "CustomerShipToCode": { "type": "string", "description": "Customer ship-to code, when a ship-to is on the node's hierarchy path.", "nullable": true }, "PrimarySupplierCode": { "type": "string", "description": "Primary supplier code, when the node resolves to a single item-site.", "nullable": true }, "ItemSiteCategory1Code": { "type": "string", "description": "Item-site category 1 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory2Code": { "type": "string", "description": "Item-site category 2 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory3Code": { "type": "string", "description": "Item-site category 3 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory4Code": { "type": "string", "description": "Item-site category 4 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory5Code": { "type": "string", "description": "Item-site category 5 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory6Code": { "type": "string", "description": "Item-site category 6 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory7Code": { "type": "string", "description": "Item-site category 7 code, when on the node's hierarchy path.", "nullable": true }, "ItemSiteCategory8Code": { "type": "string", "description": "Item-site category 8 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory1Code": { "type": "string", "description": "Customer ship-to category 1 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory2Code": { "type": "string", "description": "Customer ship-to category 2 code, when on the node's hierarchy path.", "nullable": true }, "CustomerShipToCategory3Code": { "type": "string", "description": "Customer ship-to category 3 code, when on the node's hierarchy path.", "nullable": true }, "MarginPercent": { "type": "number", "description": "Margin as a fraction of revenue for the period.", "format": "double", "nullable": true, "readOnly": true }, "Gmroi": { "type": "number", "description": "Gross margin return on inventory investment for the period.", "format": "double", "nullable": true, "readOnly": true }, "StandardCostOnHandBalance": { "type": "number", "description": "On-hand inventory balance at standard cost captured for the period, when history exists.", "format": "double", "nullable": true }, "PeriodDate": { "type": "string", "description": "Period this row's values apply to (a day, week, month, quarter, or year sentinel date, per the requested interval).", "format": "date-time" }, "StartDate": { "type": "string", "description": "First calendar day of the period.", "format": "date-time" }, "EndDate": { "type": "string", "description": "Last calendar day of the period.", "format": "date-time" }, "HierarchyNodeId": { "type": "integer", "description": "Identifier of the forecast hierarchy node the row aggregates. Stable join key across API calls.", "format": "int32" }, "NodeTitle": { "type": "string", "description": "Full display path of the node within the hierarchy.", "nullable": true }, "ValueId": { "type": "integer", "description": "Internal identifier of the node's value within its dimension.", "format": "int32" }, "HierarchyProperty": { "type": "integer", "description": "Which dimension the node's level represents (item, site, category, customer, ...), as the numeric HierarchyProperty value.", "format": "int32" }, "QuantitySold": { "type": "number", "description": "Quantity sold in the period, summed across the node's contributing item-sites.", "format": "double", "nullable": true }, "Cogs": { "type": "number", "description": "Cost of goods sold in the period.", "format": "double", "nullable": true }, "Revenue": { "type": "number", "description": "Revenue in the period.", "format": "double", "nullable": true }, "Margin": { "type": "number", "description": "Margin (revenue minus cost of goods) in the period.", "format": "double", "nullable": true }, "Hits": { "type": "integer", "description": "Number of demand hits (order lines) in the period.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "One hierarchy-node actuals row for bulk extraction: the aggregated period values from\r\nStockIQ.Entities.Calc.HierarchyLevelActualsDetail plus the node's identity decorated with business\r\ncodes for easy downstream joining. Codes for dimensions above the node's own level come from\r\nits ancestry; dimensions not on the node's hierarchy path are null." }, "HierarchyLevelActualsExportDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyLevelActualsExportDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "HierarchyLevelServiceLevelDetail": { "type": "object", "properties": { "FillRate": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "OnTimeFillRate": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ServiceLevel": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ServiceLevelVariance": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ValueId": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "type": "integer", "format": "int32" }, "NodeTitle": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "TargetServiceLevel": { "type": "number", "format": "double" }, "NumberOfOrderLines": { "type": "integer", "format": "int32", "nullable": true }, "QuantityOrdered": { "type": "integer", "format": "int32", "nullable": true }, "QuantityFilled": { "type": "integer", "format": "int32", "nullable": true }, "QuantityFilledOnTime": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfCompleteOrderLines": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfOnTimeCompleteOrderLines": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "HierarchyLevelTurnsDetail": { "type": "object", "properties": { "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ValueId": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "type": "integer", "format": "int32" }, "NodeTitle": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "QuantitySold": { "type": "number", "format": "double" }, "Cogs": { "type": "number", "format": "double" }, "OnHandQuantity": { "type": "number", "format": "double" }, "AverageOnHandQuantity": { "type": "number", "format": "double" }, "TargetOnHandQuantity": { "type": "number", "format": "double" }, "OnHandBalance": { "type": "number", "format": "double" }, "AverageOnHandBalance": { "type": "number", "format": "double" }, "TargetOnHandBalance": { "type": "number", "format": "double" }, "MeasurementPeriodLength": { "type": "integer", "format": "int32", "readOnly": true }, "CurrentTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AverageTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrVsTargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AvgVsTargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrentUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AverageUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrVsTargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AvgVsTargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "HierarchyNodeDetail": { "type": "object", "properties": { "HL": { "type": "string", "nullable": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ReasonExists": { "$ref": "#/components/schemas/HierarchyNodeReasonExists" }, "HP": { "$ref": "#/components/schemas/HierarchyProperty" }, "NT": { "type": "string", "nullable": true }, "DisplayMode": { "$ref": "#/components/schemas/HierarchyNodeDisplayMode" }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "type": "integer", "format": "int32", "nullable": true }, "ResolvedItemStatus": { "type": "integer", "format": "int32", "nullable": true }, "Abc": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32", "nullable": true }, "CC": { "type": "string", "nullable": true }, "CN": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "Shp": { "type": "string", "nullable": true }, "ItemId": { "type": "integer", "format": "int32", "nullable": true }, "I": { "type": "string", "nullable": true }, "D": { "type": "string", "nullable": true }, "SiteId": { "type": "integer", "format": "int32", "nullable": true }, "S": { "type": "string", "nullable": true }, "SN": { "type": "string", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteIsActive": { "type": "boolean", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "CustomerShipToId": { "type": "integer", "format": "int32", "nullable": true }, "CstC": { "type": "string", "nullable": true }, "CstN": { "type": "string", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CSC1": { "type": "string", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CSC2": { "type": "string", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CSC3": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time", "nullable": true }, "DateUpdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "HierarchyNodeDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyNodeDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "HierarchyNodeDisplayMode": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = ItemSite; 2 = Item; 4 = Aggregate.", "format": "int32" }, "HierarchyNodeFilters": { "type": "object", "properties": { "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items whose supplier item code contains one of these values (substring match).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "CustomerShipToCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 1 ids.", "nullable": true }, "CustomerShipToCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 2 ids.", "nullable": true }, "CustomerShipToCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 3 ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "CustomerShipToIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerShipToCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customer ship-tos with these ship-to codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "HierarchyNodeReasonExists": { "enum": [ 1, 2, 4, 8, 16, 32, 33 ], "type": "integer", "description": "Values: 1 = Settings; 2 = Collaboration; 4 = Replacement; 8 = Historical; 16 = Structure; 32 = UserAdded; 33 = UserAddedNowSettings.", "format": "int32" }, "HierarchyProperty": { "enum": [ 0, 1, 2, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536 ], "type": "integer", "description": "Values: 0 = Root; 1 = Item; 2 = Site; 8 = ItemSiteCategory1; 16 = ItemSiteCategory2; 32 = ItemSiteCategory3; 64 = ItemSiteCategory4; 128 = ItemSiteCategory5; 256 = Shipper; 512 = Customer; 1024 = CustomerShipTo; 2048 = CustomerShipToCategory1; 4096 = CustomerShipToCategory2; 8192 = CustomerShipToCategory3; 16384 = ItemSiteCategory6; 32768 = ItemSiteCategory7; 65536 = ItemSiteCategory8.", "format": "int32" }, "IAlertCounts": { "type": "object", "properties": { "AlertType": { "$ref": "#/components/schemas/AlertType" }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "NumHighPriority": { "type": "integer", "format": "int32", "nullable": true }, "NumMedPriority": { "type": "integer", "format": "int32", "nullable": true }, "NumLowPriority": { "type": "integer", "format": "int32", "nullable": true }, "NumSuspended": { "type": "integer", "format": "int32", "nullable": true }, "TotalValue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "IAlertDetail": { "type": "object", "properties": { "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true, "readOnly": true }, "ItemDescription": { "type": "string", "nullable": true, "readOnly": true }, "AbcClass": { "type": "string", "nullable": true, "readOnly": true }, "XyzClass": { "type": "string", "nullable": true, "readOnly": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "BuyerName": { "type": "string", "nullable": true, "readOnly": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true, "readOnly": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "Message": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "AlertState": { "$ref": "#/components/schemas/AlertState" }, "Priority": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Gives an interface for all of our concrete types to implement, e.g. we must make sure they return these things from their query\r\nso we can know all alerts are appropriately similar." }, "IAlertDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/IAlertDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "InventoryMeasure": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Values: 1 = Units; 2 = Days; 3 = Weight; 4 = Cubes; 5 = Pallets; 6 = EquivalencyUnits.", "format": "int32" }, "InventoryPosition": { "enum": [ 0, 1, 2, 4, 8, 16, 24, 32, 64, 128 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = OutOfStock; 2 = BelowPanicPoint; 4 = BelowSafetyStock; 8 = OK; 16 = PlannedOverstock; 24 = Overstocked; 32 = Excess; 64 = NeverStocked; 128 = NonStock.", "format": "int32" }, "InventoryPositionQuantity": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Values: 1 = OnHand; 2 = AvailableQuantity; 3 = FirmSupplyAndDemand.", "format": "int32" }, "InventorySnapshotTimeBasis": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Values: 1 = Historical; 2 = Current; 3 = Projected.", "format": "int32" }, "ItemSiteAttributes": { "type": "object", "properties": { "ActiveTargetStockBalance": { "type": "number", "format": "double", "readOnly": true }, "OpportunityDollars": { "type": "number", "format": "double", "readOnly": true }, "OpportunityDollarsByAvailable": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "OpportunityDollarsByFirmSupplyAndDemand": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PreferredTargetStock": { "type": "number", "format": "double", "readOnly": true }, "ActivePreferredTargetStockBalance": { "type": "number", "format": "double", "readOnly": true }, "PreferredOpportunityDollars": { "type": "number", "format": "double", "readOnly": true }, "PreferredOpportunityDollarsByAvailable": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PreferredOpportunityDollarsByFirmSupplyAndDemand": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveVsPreferredTargetStock": { "type": "number", "format": "double", "readOnly": true }, "ActiveVsPreferredTargetStockBalance": { "type": "number", "format": "double", "readOnly": true }, "ActiveVsPreferredOpportunityDollars": { "type": "number", "format": "double", "readOnly": true }, "ActiveVsPreferredOpportunityDollarsByAvailable": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveVsPreferredOpportunityDollarsByFirmSupplyAndDemand": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "SiteName": { "type": "string", "nullable": true }, "HubWarehouseId": { "type": "integer", "format": "int32", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "SafetyStockLeadTime": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "HubWarehouseCode": { "type": "string", "nullable": true }, "ShipperCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "BuyerCode": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PrimarySupplierCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32" }, "OrderMultipleQuantity": { "type": "integer", "format": "int32" }, "PurchaseUnitOfMeasure": { "type": "string", "nullable": true }, "StockingUnitsPerPurchaseUnits": { "type": "number", "format": "double", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "OnHandQuantity": { "type": "number", "format": "double" }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalOnHandBalance": { "type": "number", "format": "double" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "StockIQOrderPolicy": { "type": "integer", "format": "int32", "nullable": true }, "InventoryPosition": { "type": "integer", "format": "int32" }, "ReplacementFlags": { "type": "integer", "format": "int32" }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "IsOnHandCopied": { "type": "boolean" }, "TotalForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderCycle": { "type": "integer", "format": "int32" }, "InventoryPositionAtLeadTime": { "type": "integer", "format": "int32" }, "WorstProjectedInventoryPosition": { "type": "integer", "format": "int32" }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "UsagePattern": { "type": "integer", "format": "int32" }, "CurrentCost": { "type": "number", "format": "double" }, "CurrentCostCurrency": { "type": "string", "nullable": true }, "StandardCost": { "type": "number", "format": "double" }, "StandardCostCurrency": { "type": "string", "nullable": true }, "StandardPrice": { "type": "number", "format": "double" }, "StandardPriceCurrency": { "type": "string", "nullable": true }, "IsPhantom": { "type": "boolean" }, "DateCreated": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstStocked": { "type": "string", "format": "date-time", "nullable": true }, "DateObsolete": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstPoRelease": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstPoReceipt": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstCustomerOrder": { "type": "string", "format": "date-time", "nullable": true }, "DateProductLaunch": { "type": "string", "format": "date-time", "nullable": true }, "FinalDepletionDate": { "type": "string", "format": "date-time", "nullable": true }, "MaxCapacity": { "type": "integer", "format": "int32", "nullable": true }, "MaxCapacityUnitOfMeasure": { "type": "integer", "format": "int32", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActiveMaxStock": { "type": "number", "format": "double" }, "ActivePreferredMaxStock": { "type": "number", "format": "double", "nullable": true }, "TargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "ActiveReorderPoint": { "type": "number", "format": "double" }, "UnitOfMeasure": { "type": "string", "nullable": true }, "UnitWeight": { "type": "number", "format": "double", "nullable": true }, "WeightUnits": { "type": "integer", "format": "int32", "nullable": true }, "UnitLength": { "type": "number", "format": "double", "nullable": true }, "UnitWidth": { "type": "number", "format": "double", "nullable": true }, "UnitHeight": { "type": "number", "format": "double", "nullable": true }, "UnitCubes": { "type": "number", "format": "double", "nullable": true }, "SizeUnits": { "type": "integer", "format": "int32", "nullable": true }, "UnitsPerPallet": { "type": "number", "format": "double", "nullable": true }, "Eoq": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalInTransitQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalOnDemandOrderQuantity": { "type": "number", "format": "double" }, "IndependentOnDemandOrderQuantity": { "type": "number", "format": "double" }, "DependentOnDemandOrderQuantity": { "type": "number", "format": "double" }, "IndependentOnDemandOrderQuantityToLeadTime": { "type": "number", "format": "double" }, "DependentOnDemandOrderQuantityToLeadTime": { "type": "number", "format": "double" }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "NextReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfParents": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfChildren": { "type": "integer", "format": "int32", "nullable": true }, "ReplacedItemsCount": { "type": "integer", "format": "int32", "nullable": true }, "ReplacingItemsCount": { "type": "integer", "format": "int32", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "LastUsedDate": { "type": "string", "format": "date-time", "nullable": true }, "ImageUri": { "type": "string", "nullable": true }, "SupplierCost": { "type": "number", "format": "double" }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "OnHandCubes": { "type": "number", "format": "double", "nullable": true }, "YieldPercentage": { "type": "number", "format": "double", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ItemSiteDaysOfSupply": { "type": "object", "properties": { "EffectiveDaysOfSupply": { "type": "number", "format": "double", "nullable": true }, "WeeksOfSupply": { "type": "number", "format": "double", "nullable": true }, "MonthsOfSupply": { "type": "number", "format": "double", "nullable": true }, "OneYearBurndownOnHand": { "type": "number", "format": "double", "nullable": true }, "OneYearBurndownValue": { "type": "number", "format": "double", "nullable": true }, "ExpectedAnnualRevenue": { "type": "number", "format": "double", "nullable": true }, "AnnualizedUsage": { "type": "number", "format": "double", "nullable": true }, "EffectiveDailyUsage": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableBalance": { "type": "number", "format": "double", "readOnly": true }, "DaysOnOrder": { "type": "number", "format": "double" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteSupplierId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "StandardCost": { "type": "number", "format": "double" }, "StandardPrice": { "type": "number", "format": "double" }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "Hits": { "type": "string", "nullable": true }, "UsagePattern": { "type": "integer", "format": "int32" }, "InventoryPosition": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActiveMaxStock": { "type": "number", "format": "double" }, "TotalOnHandQuantity": { "type": "number", "format": "double" }, "TotalOnHandBalance": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double" }, "OnOrderValue": { "type": "number", "format": "double" }, "TotalAvailableQuantity": { "type": "number", "format": "double" }, "TotalOnDemandQuantity": { "type": "number", "format": "double" }, "CurrentExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "CurrentExcessThreshold": { "type": "number", "format": "double", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "MinimumOrderQuantity": { "type": "number", "format": "double" }, "OrderMultipleQuantity": { "type": "number", "format": "double" }, "LastTwelveMonthsActuals": { "type": "number", "format": "double", "nullable": true }, "LastTwelveMonthsDependentActuals": { "type": "number", "format": "double", "nullable": true }, "TwelveMonthForecast": { "type": "number", "format": "double", "nullable": true }, "TwelveMonthDependentForecast": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ItemSiteDetail": { "type": "object", "properties": { "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "Removed": { "type": "boolean" }, "ItemIsActive": { "type": "boolean" }, "ItemIsRemoved": { "type": "boolean" }, "SiteIsActive": { "type": "boolean" }, "SiteIsRemoved": { "type": "boolean" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Code": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Code": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Code": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Code": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Code": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Code": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Code": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ItemSiteDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "ItemSiteFilters": { "type": "object", "properties": { "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatus" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "BoMPositions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items at these bill-of-material positions.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict by supplier item code (exact match). On item-site level endpoints this matches\r\nthe primary supplier's item code; on supplier-relationship level endpoints (receipts,\r\nlead times) it matches the code on the returned relationship.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "ItemSiteHistoryDetail": { "type": "object", "properties": { "ItemId": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemSiteHistoryId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "CaptureDate": { "type": "string", "format": "date-time" }, "TotalOnHandQuantity": { "type": "number", "format": "double" }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderPolicy": { "type": "integer", "format": "int32", "nullable": true }, "Eoq": { "type": "number", "format": "double", "nullable": true }, "ActivePanicPoint": { "type": "number", "format": "double" }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActivePreferredMaxStock": { "type": "number", "format": "double", "nullable": true }, "ActiveMaxStock": { "type": "number", "format": "double" }, "CurrentDaySafetyStock": { "type": "number", "format": "double" }, "CurrentDayTargetStock": { "type": "number", "format": "double" }, "CurrentDayMaxStock": { "type": "number", "format": "double" }, "CurrentCost": { "type": "number", "format": "double" }, "CurrentCostCurrency": { "type": "string", "nullable": true }, "StandardCost": { "type": "number", "format": "double" }, "StandardCostCurrency": { "type": "string", "nullable": true }, "StandardPrice": { "type": "number", "format": "double" }, "StandardPriceCurrency": { "type": "string", "nullable": true }, "ImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "TargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "UsagePattern": { "type": "integer", "format": "int32" }, "InventoryPosition": { "type": "integer", "format": "int32" }, "CurrentExcessThreshold": { "type": "number", "format": "double", "nullable": true }, "OutOfStockQuantity": { "type": "number", "format": "double" }, "ReplacementFlags": { "type": "integer", "format": "int32" }, "IsOnHandCopied": { "type": "boolean" }, "DateUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ItemSiteHistoryDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteHistoryDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "ItemSiteInventorySnapshot": { "type": "object", "properties": { "SeriesKeyId": { "type": "integer", "format": "int32", "readOnly": true }, "SeriesKey": { "type": "string", "nullable": true, "readOnly": true }, "TimeBasis": { "$ref": "#/components/schemas/InventorySnapshotTimeBasis" }, "CaptureDate": { "type": "string", "format": "date-time" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteCategory1Code": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Code": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Code": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Code": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Code": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Code": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Code": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Code": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "CurrentCost": { "type": "number", "format": "double", "nullable": true }, "StandardCost": { "type": "number", "format": "double", "nullable": true }, "OnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "SafetyStockQuantity": { "type": "number", "format": "double", "nullable": true }, "TargetStockQuantity": { "type": "number", "format": "double", "nullable": true }, "MaxStockQuantity": { "type": "number", "format": "double", "nullable": true }, "StandardCostOnHandBalance": { "type": "number", "format": "double", "nullable": true }, "StandardCostSafetyStockBalance": { "type": "number", "format": "double", "nullable": true }, "StandardCostTargetStockBalance": { "type": "number", "format": "double", "nullable": true }, "StandardCostMaxStockBalance": { "type": "number", "format": "double", "nullable": true }, "OnHandCubes": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "Pallets": { "type": "number", "format": "double", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ImageUri": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "PrimarySupplierCode": { "type": "string", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ItemSiteInventorySnapshots": { "type": "object", "properties": { "Snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteInventorySnapshot" }, "nullable": true }, "ConstantLines": { "type": "array", "items": { "$ref": "#/components/schemas/ChartConstantLine" }, "nullable": true } }, "additionalProperties": false }, "ItemSiteServiceLevelDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "FillRate": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "OnTimeFillRate": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ServiceLevel": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ServiceLevelVariance": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "QuantityUnFilled": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "TargetServiceLevel": { "type": "number", "format": "double" }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "NumberOfOrderLines": { "type": "integer", "format": "int32", "nullable": true }, "QuantityOrdered": { "type": "integer", "format": "int32", "nullable": true }, "QuantityFilled": { "type": "integer", "format": "int32", "nullable": true }, "QuantityFilledOnTime": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfCompleteOrderLines": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfOnTimeCompleteOrderLines": { "type": "integer", "format": "int32", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ItemSiteSupplierDetail": { "type": "object", "properties": { "AdminLtSettingsDescription": { "type": "string", "nullable": true }, "ManufacturingLtSettingsDescription": { "type": "string", "nullable": true }, "ShippingLtSettingsDescription": { "type": "string", "nullable": true }, "PutawayLtSettingsDescription": { "type": "string", "nullable": true }, "SafetyStockLeadTimeSettingsDescription": { "type": "string", "nullable": true }, "ErpPlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "CalculatedPlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteIsActive": { "type": "boolean" }, "ItemSiteRemoved": { "type": "boolean" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierItemCategoryId": { "type": "integer", "format": "int32" }, "ItemSiteSupplierId": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Removed": { "type": "boolean" }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "SupplierItemCategoryCode": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32" }, "OrderMultipleQuantity": { "type": "integer", "format": "int32" }, "MaxOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "YieldPercentage": { "type": "number", "format": "double" }, "SupplierCost": { "type": "number", "format": "double" }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "UnitOfMeasure": { "type": "string", "nullable": true }, "PurchaseUnitOfMeasure": { "type": "string", "nullable": true }, "StockingUnitsPerPurchaseUnits": { "type": "number", "format": "double", "nullable": true }, "SupplierOnHand": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderCycle": { "type": "integer", "format": "int32" }, "ErpSupplierLevel": { "type": "integer", "format": "int32", "nullable": true }, "CalculatedSupplierLevel": { "type": "integer", "format": "int32" }, "ActiveSupplierLevel": { "type": "integer", "format": "int32" }, "ErpAdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ErpManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ErpShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ErpExpeditedShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ErpPutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalculatedAdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalculatedManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalculatedShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalculatedPutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveAdminLeadTime": { "type": "integer", "format": "int32" }, "ActiveManufacturingLeadTime": { "type": "integer", "format": "int32" }, "ActiveShippingLeadTime": { "type": "integer", "format": "int32" }, "ActiveExpeditedShippingLeadTime": { "type": "integer", "format": "int32" }, "ActivePutawayLeadTime": { "type": "integer", "format": "int32" }, "SafetyStockLeadTime": { "type": "integer", "format": "int32" }, "CumulativeSafetyStockLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "LeadTimeReceiptCount": { "type": "integer", "format": "int32", "nullable": true }, "TotalReceiptCount": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ItemSiteSupplierDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSiteSupplierDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "ItemSiteSupplierFilters": { "type": "object", "properties": { "SupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-site-supplier relationships with these supplier ids (any supplier\r\nrelationship, not just the primary one - contrast with the inherited PrimarySupplierIds).", "nullable": true }, "SupplierLevels": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these supplier levels (1 = the item-site's primary supplier).", "nullable": true }, "SupplierItemCategories": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these supplier item category ids.", "nullable": true }, "MultiHubFilter": { "$ref": "#/components/schemas/MultiHubFilter" }, "SupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to suppliers with these supplier codes (any supplier relationship). Unknown codes fail the request with a 400.", "nullable": true }, "AreEmptyOtherThanSupplierLevel": { "type": "boolean", "readOnly": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatus" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "BoMPositions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items at these bill-of-material positions.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict by supplier item code (exact match). On item-site level endpoints this matches\r\nthe primary supplier's item code; on supplier-relationship level endpoints (receipts,\r\nlead times) it matches the code on the returned relationship.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "ItemSiteTurnsDetail": { "type": "object", "properties": { "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "EndDate": { "type": "string", "format": "date-time" }, "QuantitySold": { "type": "number", "format": "double" }, "Cogs": { "type": "number", "format": "double" }, "OnHandQuantity": { "type": "number", "format": "double" }, "AverageOnHandQuantity": { "type": "number", "format": "double" }, "TargetOnHandQuantity": { "type": "number", "format": "double" }, "OnHandBalance": { "type": "number", "format": "double" }, "AverageOnHandBalance": { "type": "number", "format": "double" }, "TargetOnHandBalance": { "type": "number", "format": "double" }, "MeasurementPeriodLength": { "type": "integer", "format": "int32", "readOnly": true }, "CurrentTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AverageTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrVsTargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AvgVsTargetTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrentUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AverageUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CurrVsTargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AvgVsTargetUnitTurns": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": { } }, "ItemStatus": { "enum": [ 1, 2 ], "type": "integer", "description": "Values: 1 = Active; 2 = Discontinued.", "format": "int32" }, "ItemTagAssignmentDetail": { "type": "object", "properties": { "ItemTagId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "Tag": { "type": "string", "nullable": true }, "Type": { "type": "integer", "format": "int32" }, "FiltersJson": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LeadTimeType": { "enum": [ 1, 2, 4, 8, 16, 32 ], "type": "integer", "description": "Values: 1 = Administration; 2 = Manufacturing; 4 = Shipping; 8 = Vendor; 16 = Putaway; 32 = Planning.", "format": "int32" }, "LineStatus": { "enum": [ 0, 1, 2, 4, 8, 16, 1024 ], "type": "integer", "description": "Values: 0 = NotSet; 1 = Open; 2 = Closed; 4 = Canceled; 8 = OnHold; 16 = Released; 1024 = Error.", "format": "int32" }, "LostSalesDetail": { "type": "object", "properties": { "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "ItemId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToCode": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "NodeLevel": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Code": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Code": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Code": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Code": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Code": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Code": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Code": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Code": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "PeriodDate": { "type": "string", "format": "date-time" }, "LostQuantity": { "type": "number", "format": "double" }, "LostCogs": { "type": "number", "format": "double" }, "LostRevenue": { "type": "number", "format": "double" }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ItemDescription": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ManualForecastDetail": { "type": "object", "properties": { "LevelName": { "type": "string", "nullable": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "NodeLevel": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "type": "integer", "format": "int32" }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerShipToId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "UpdatedByUserId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesName": { "type": "string", "nullable": true }, "NodeValue": { "type": "string", "nullable": true }, "ShipperName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "Interval": { "type": "integer", "format": "int32" }, "ForecastControl": { "type": "integer", "format": "int32" }, "AutoForecastReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "DateUpdated": { "type": "string", "format": "date-time", "nullable": true }, "UpdatedByUserName": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true }, "IsInherited": { "type": "boolean" }, "ControlledAtLevelName": { "type": "string", "nullable": true }, "ManualPeriodCount": { "type": "integer", "format": "int32" }, "ForecastDateUpdated": { "type": "string", "format": "date-time" }, "ForecastUpdatedByUserName": { "type": "string", "nullable": true }, "ForecastNote": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultiHubFilter": { "enum": [ 1, 2 ], "type": "integer", "description": "Values: 1 = ShowAllHubs; 2 = ShowPrimaryHubOnly.", "format": "int32" }, "NewItemDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "ItemAge": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "PrimarySupplierCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "OnHandQuantity": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "StandardCostCurrency": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time", "nullable": true }, "DateFirstStocked": { "type": "string", "format": "date-time", "nullable": true }, "CurrentCost": { "type": "number", "format": "double" }, "StandardCost": { "type": "number", "format": "double" }, "FirstSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "LastSaleDate": { "type": "string", "format": "date-time", "nullable": true }, "OnHandBalance": { "type": "number", "format": "double" }, "ExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "ExcessBalance": { "type": "number", "format": "double", "nullable": true }, "TotalHistoricalDailyUsage": { "type": "number", "format": "double" }, "TotalForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "TotalDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "HasForecast": { "type": "boolean" }, "CustomerShipToCount": { "type": "integer", "format": "int32", "nullable": true }, "CustomerCount": { "type": "integer", "format": "int32", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextOrderRemainingReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "NumberOfOpenSupplies": { "type": "integer", "format": "int32", "nullable": true }, "TotalHits": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SiteGroupInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "SiteGroupUsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "SiteGroupOnHandQuantity": { "type": "number", "format": "double" }, "SiteGroupAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "SiteGroupCurrentExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "SiteGroupCurrentExcessThreshold": { "type": "number", "format": "double", "nullable": true }, "SiteGroupTotalForecastedDailyUsag": { "type": "number", "format": "double", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "OnTimePerformanceSummary": { "type": "object", "properties": { "PeriodDate": { "type": "string", "format": "date-time", "nullable": true }, "EarlyCount": { "type": "integer", "format": "int32" }, "OnTimeCount": { "type": "integer", "format": "int32" }, "UnknownCount": { "type": "integer", "format": "int32" }, "LateCount": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32", "readOnly": true }, "PercentEarly": { "type": "number", "format": "double", "readOnly": true }, "PercentOnTime": { "type": "number", "format": "double", "readOnly": true }, "PercentLate": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "OnTimeStatus": { "enum": [ 1, 2, 4 ], "type": "integer", "description": "Values: 1 = Early; 2 = OnTime; 4 = Late.", "format": "int32" }, "OpenSupplyOrderLineDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "PrimarySupplierName": { "type": "string", "nullable": true, "readOnly": true }, "DURD": { "type": "integer", "format": "int32" }, "DUSD": { "type": "integer", "format": "int32" }, "USQ": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ITQ": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ITD": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnitCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CO": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CR": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "CIT": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "WO": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "WR": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "WIT": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ErpON": { "type": "string", "nullable": true }, "SiqON": { "type": "string", "nullable": true }, "SupplyType": { "$ref": "#/components/schemas/SupplyType" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteSupplierId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierItemCategoryId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "I": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SC": { "type": "string", "nullable": true }, "BuyerCode": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "SN": { "type": "string", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "D": { "type": "string", "nullable": true }, "SIC": { "type": "string", "nullable": true }, "ActiveSupplierLevel": { "type": "integer", "format": "int32" }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "IP": { "$ref": "#/components/schemas/InventoryPosition" }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "WPIP": { "$ref": "#/components/schemas/InventoryPosition" }, "IPLT": { "$ref": "#/components/schemas/InventoryPosition" }, "SupplyOrderLineId": { "type": "integer", "format": "int32" }, "SupplyOrderId": { "type": "integer", "format": "int32" }, "SiqLN": { "type": "number", "format": "double", "nullable": true }, "ErpLN": { "type": "number", "format": "double", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "StockIqStatus": { "type": "integer", "format": "int32" }, "ErpLineStatus": { "type": "integer", "format": "int32", "nullable": true }, "ReleaseQuantity": { "type": "number", "format": "double" }, "RRQ": { "type": "number", "format": "double" }, "PurchaseCost": { "type": "number", "format": "double" }, "PurchaseCostCurrency": { "type": "string", "nullable": true }, "ExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "EDD": { "type": "string", "format": "date-time" }, "PlannedReceiptDate": { "type": "string", "format": "date-time" }, "ILC": { "type": "string", "nullable": true }, "ELC": { "type": "string", "nullable": true }, "RctQty": { "type": "number", "format": "double", "nullable": true }, "RRctQty": { "type": "number", "format": "double", "nullable": true }, "StandardPrice": { "type": "number", "format": "double" }, "StandardPriceCurrency": { "type": "string", "nullable": true }, "ConfirmedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "ApprovedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "OriginalReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "OriginalReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "OESD": { "type": "string", "format": "date-time", "nullable": true }, "OEDD": { "type": "string", "format": "date-time" }, "Abc": { "type": "string", "nullable": true }, "Xyz": { "type": "string", "nullable": true }, "OpenDollars": { "type": "number", "format": "double", "nullable": true }, "LinePurchaseCost": { "type": "number", "format": "double", "nullable": true }, "UnitOfMeasure": { "type": "string", "nullable": true }, "PurchaseUnitOfMeasure": { "type": "string", "nullable": true }, "OCD": { "type": "string", "format": "date-time", "nullable": true }, "RD": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "IHC": { "type": "string", "nullable": true }, "EHC": { "type": "string", "nullable": true }, "UnitWeight": { "type": "number", "format": "double", "nullable": true }, "UnitLength": { "type": "number", "format": "double", "nullable": true }, "UnitWidth": { "type": "number", "format": "double", "nullable": true }, "UnitHeight": { "type": "number", "format": "double", "nullable": true }, "UnitsPerPallet": { "type": "number", "format": "double", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "AQ": { "type": "number", "format": "double", "nullable": true }, "OH": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalInTransitQuantity": { "type": "number", "format": "double", "nullable": true }, "SS": { "type": "number", "format": "double" }, "ErpBlanketOrderNumber": { "type": "string", "nullable": true }, "StockIqBlanketOrderNumber": { "type": "string", "nullable": true }, "ErpBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "StockIqBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "POOSD": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "NextOrderTotalQuantityShipped": { "type": "number", "format": "double", "nullable": true }, "MRDS": { "type": "string", "format": "date-time", "nullable": true }, "QS": { "type": "number", "format": "double", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "ImportTaxPercent": { "type": "number", "format": "double", "nullable": true }, "ImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "OpenSupplyOrderLineDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenSupplyOrderLineDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "OrderLineErrorMessage": { "type": "object", "properties": { "MessageType": { "$ref": "#/components/schemas/OrderLineErrorMessageType" }, "Title": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Prompt": { "type": "string", "nullable": true }, "ProvidedValue": { "nullable": true }, "CorrectedValue": { "nullable": true }, "ShowAdjustmentDialog": { "type": "boolean" }, "WarningLevel": { "$ref": "#/components/schemas/ResultType" } }, "additionalProperties": false }, "OrderLineErrorMessageType": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768 ], "type": "integer", "description": "Values: 1 = Transfer; 2 = Minimum; 4 = Multiple; 8 = Maximum; 16 = PlanAtRisk; 32 = PlannedReceiptDate; 64 = ExpectedShipDate; 128 = SupplierItemMinimum; 256 = WarehouseCapacity; 512 = SupplierOnHand; 1024 = BlanketPurchaseOrderAllocation; 2048 = UnderMoqTarget; 4096 = EarlyBlanketOrder; 8192 = NegativeAdjustedMargin; 16384 = ExcessAndOverStock; 32768 = DaysOfSupplyLimit.", "format": "int32" }, "OrderLineStatus": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128 ], "type": "integer", "description": "Values: 0 = NotSet; 1 = Review; 2 = Confirmed; 4 = HoldForMerge; 8 = Merged; 16 = Approved; 32 = Accepted; 64 = Canceled; 128 = Error.", "format": "int32" }, "OrderScheduleHeader": { "type": "object", "properties": { "IsLocked": { "type": "boolean" }, "ItemSiteSupplierId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierItemCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "OutOfStockQuantity": { "type": "number", "format": "double" }, "InventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "ActiveOrderPolicy": { "type": "integer", "format": "int32", "nullable": true }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveSupplierLevel": { "type": "integer", "format": "int32" }, "InventoryPositionAtLeadTime": { "$ref": "#/components/schemas/InventoryPosition" }, "WorstProjectedInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "ActiveOrderCycle": { "type": "integer", "format": "int32" }, "TotalOnHandQuantity": { "type": "number", "format": "double" }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "Eoq": { "type": "number", "format": "double" }, "MinimumOrderQuantity": { "type": "integer", "format": "int32" }, "OrderMultipleQuantity": { "type": "integer", "format": "int32" }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActiveMaxStock": { "type": "number", "format": "double" }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfParents": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfChildren": { "type": "integer", "format": "int32", "nullable": true }, "NextExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "ProjectedBelowPanicPointDate": { "type": "string", "format": "date-time", "nullable": true }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextErpOrderNumber": { "type": "string", "nullable": true }, "NextOrderRemainingReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "YieldPercentage": { "type": "number", "format": "double", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "SupplierCost": { "type": "number", "format": "double", "nullable": true }, "SupplierCostCurrency": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "OverforecastedPeriodDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "ForecastErrorPercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StatisticalErrorPercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LevelName": { "type": "string", "nullable": true }, "OverforecastRevenueVariance": { "type": "number", "format": "double", "readOnly": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "NodeLevel": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "$ref": "#/components/schemas/HierarchyProperty" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerShipToId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesName": { "type": "string", "nullable": true }, "NodeValue": { "type": "string", "nullable": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesId": { "type": "integer", "format": "int32" }, "PeriodDate": { "type": "string", "format": "date-time" }, "Interval": { "$ref": "#/components/schemas/TimeInterval" }, "ForecastQuantity": { "type": "number", "format": "double" }, "ToleranceLowerBound": { "type": "number", "format": "double" }, "StatisticalForecastQuantity": { "type": "number", "format": "double" }, "ForecastAverageQuantity": { "type": "number", "format": "double" }, "StatisticalAverageQuantity": { "type": "number", "format": "double" }, "ForecastRevenue": { "type": "number", "format": "double" }, "ForecastCogs": { "type": "number", "format": "double" }, "StatisticalForecastRevenue": { "type": "number", "format": "double" }, "AverageForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "AverageStatisticalErrorPercent": { "type": "number", "format": "double", "nullable": true }, "AverageForecastErrorUnits": { "type": "number", "format": "double", "nullable": true }, "AverageStatisticalErrorUnits": { "type": "number", "format": "double", "nullable": true }, "PeriodTotalQuantitySold": { "type": "number", "format": "double" }, "PeriodTotalRevenue": { "type": "number", "format": "double" }, "PeriodTotalCogs": { "type": "number", "format": "double" }, "PercentThroughPeriod": { "type": "number", "format": "double" }, "PercentOfDemandExpected": { "type": "number", "format": "double" }, "ProjectedPeriodTotalQuantitySold": { "type": "number", "format": "double" }, "ProjectedPeriodTotalRevenue": { "type": "number", "format": "double" }, "ProjectedPeriodTotalCogs": { "type": "number", "format": "double" }, "ForecastErrorUnits": { "type": "number", "format": "double" }, "ForecastErrorDollars": { "type": "number", "format": "double" }, "StatisticalErrorUnits": { "type": "number", "format": "double" }, "StatisticalErrorDollars": { "type": "number", "format": "double" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "IsAutoForecasted": { "type": "boolean" }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextOrderDockDate": { "type": "string", "format": "date-time", "nullable": true }, "ProjectedInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "ShipperName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "PlanState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Values: 0 = None; 1 = OK; 2 = AtRisk; 3 = AtSharedRisk.", "format": "int32" }, "ProblemDetails": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Detail": { "type": "string", "nullable": true }, "Instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "PurchaseCostStatus": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = None; 1 = UserEdited; 2 = HasItemLevelPricebreak; 4 = ModifiedByPricebreaks.", "format": "int32" }, "ReceiptCompletenessPerformanceSummary": { "type": "object", "properties": { "PeriodDate": { "type": "string", "format": "date-time" }, "CompleteCount": { "type": "integer", "format": "int32", "nullable": true }, "UnderCount": { "type": "integer", "format": "int32", "nullable": true }, "OverCount": { "type": "integer", "format": "int32", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReceiptDetail": { "type": "object", "properties": { "CalendarDaysReceiptDelay": { "type": "integer", "format": "int32", "nullable": true }, "ChangedReleaseDate": { "type": "boolean" }, "OnTimeStatus": { "$ref": "#/components/schemas/OnTimeStatus" }, "IsIncludedInLeadTimeCalculations": { "type": "boolean" }, "SupplyOrderLineId": { "type": "integer", "format": "int32" }, "IncomingShipmentId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplyOrderId": { "type": "integer", "format": "int32" }, "ExcludedIncomingShipmentId": { "type": "integer", "format": "int32" }, "IsExcluded": { "type": "boolean", "nullable": true }, "IncomingShipmentCode": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "StockIqOrderNumber": { "type": "string", "nullable": true }, "StockIqLineNumber": { "type": "integer", "format": "int32", "nullable": true }, "ErpOrderNumber": { "type": "string", "nullable": true }, "ErpLineNumber": { "type": "integer", "format": "int32", "nullable": true }, "OrderCreationDate": { "type": "string", "format": "date-time", "nullable": true }, "ReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedDockDate": { "type": "string", "format": "date-time" }, "PlannedReceiptDate": { "type": "string", "format": "date-time" }, "OriginalExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "OriginalExpectedDockDate": { "type": "string", "format": "date-time" }, "OriginalExpectedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "OriginalPlannedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "RequestedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "ShipmentReadyDate": { "type": "string", "format": "date-time", "nullable": true }, "DateShipped": { "type": "string", "format": "date-time" }, "DateDelivered": { "type": "string", "format": "date-time", "nullable": true }, "DateReceived": { "type": "string", "format": "date-time", "nullable": true }, "ReleaseQuantity": { "type": "number", "format": "double" }, "ReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "QuantityShipped": { "type": "number", "format": "double" }, "QuantityDelivered": { "type": "number", "format": "double" }, "AdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "VendorLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysReleaseDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysShipDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysDeliveryDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysShipDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysDeliveryDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysReceiptDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true }, "PercentComplete": { "type": "number", "format": "double", "nullable": true }, "OrderedVsShippedQuantity": { "type": "number", "format": "double", "nullable": true }, "DeliveredVsReceivedQuantity": { "type": "number", "format": "double", "nullable": true }, "ContainerNumber": { "type": "string", "nullable": true }, "TrackingNumber": { "type": "string", "nullable": true }, "SupplyType": { "$ref": "#/components/schemas/SupplyType" }, "ActivePutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PlanningPadDays": { "type": "integer", "format": "int32", "nullable": true }, "SubtractPlanningPadFromErpDate": { "type": "boolean" }, "SubtractPutawayTimeFromErpDate": { "type": "boolean" }, "UserEditedReceiptDate": { "type": "boolean" }, "HasOrderSchedule": { "type": "boolean" }, "HasDeliverySchedule": { "type": "boolean" }, "ItemDescription": { "type": "string", "nullable": true }, "PurchaseCost": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ReceiptDetailDateFilter": { "enum": [ 0, 1 ], "type": "integer", "description": "Values: 0 = OrderCreationDate; 1 = ReceiptDate.", "format": "int32" }, "ReceiptDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "ReceiptPerformanceFrequency": { "type": "object", "properties": { "DaysEarlyOrLate": { "type": "integer", "format": "int32" }, "Count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RefreshType": { "enum": [ 1, 2, 4, 8, 16 ], "type": "integer", "description": "Values: 1 = Full; 2 = Partial; 4 = OnHand; 8 = Demand; 16 = Supply.", "format": "int32" }, "ReplenishmentOrderPolicy": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 4096, 8192, 16384 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = LotForLot; 2 = OrderPoint; 4 = MinMax; 8 = BuyToOrder; 16 = BuildToOrder; 32 = FixedQuantity; 64 = DoNotOrder; 4096 = LineItemBuyToOrder; 8192 = SporadicSales; 16384 = Kanban.", "format": "int32" }, "ResultType": { "enum": [ 0, 1, 2, 4, 8, 16 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = Ok; 2 = Info; 4 = Warning; 8 = Error; 16 = Unchanged.", "format": "int32" }, "SafetyStockSummary": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "SettingsDescription": { "type": "string", "nullable": true }, "StatisticalSettingsDescription": { "type": "string", "nullable": true }, "NetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "DaysOnHand": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveSafetyStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveTargetStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActivePreferredMaxStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveMaxStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ActiveReorderPointDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StatisticalSafetyStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PreferredStatisticalMaxStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StatisticalMaxStockDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StatisticalReorderPointDays": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnitsDelta": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ValueDelta": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UsageSource": { "$ref": "#/components/schemas/SafetyStockUsageSource" }, "SSHistoricalDailyUsage": { "type": "number", "format": "double", "nullable": true }, "SSForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "SSDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "SSHistoricalMonthlyUsage": { "type": "number", "format": "double", "nullable": true }, "SSForecastedMonthlyUsage": { "type": "number", "format": "double", "nullable": true }, "SSMonthlyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ItemSiteMonthlyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "StandardCostCurrency": { "type": "string", "nullable": true }, "ErpSafetyStock": { "type": "number", "format": "double", "nullable": true }, "ErpSafetyStockMeasure": { "$ref": "#/components/schemas/InventoryMeasure" }, "MaxCapacity": { "type": "integer", "format": "int32", "nullable": true }, "MaxCapacityUnitOfMeasure": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActivePreferredMaxStock": { "type": "number", "format": "double", "nullable": true }, "ActiveMaxStock": { "type": "number", "format": "double" }, "ActiveReorderPoint": { "type": "number", "format": "double" }, "ActiveSafetyStockExpectedServiceLevel": { "type": "number", "format": "double", "nullable": true }, "OnHandQuantity": { "type": "number", "format": "double" }, "StatisticalSafetyStock": { "type": "number", "format": "double" }, "PreferredStatisticalMaxStock": { "type": "number", "format": "double" }, "StatisticalMaxStock": { "type": "number", "format": "double" }, "StatisticalReorderPoint": { "type": "number", "format": "double" }, "ChosenSafetyStockMethod": { "$ref": "#/components/schemas/StatisticalSafetyStockSelectionMethod" }, "StandardSafetyStock": { "type": "number", "format": "double", "nullable": true }, "LargeRegularPullSafetyStock": { "type": "number", "format": "double", "nullable": true }, "DistributionBasedSafetyStock": { "type": "number", "format": "double", "nullable": true }, "RetrospectiveSafetyStock": { "type": "number", "format": "double", "nullable": true }, "CapacityConstrainedSafetyStock": { "type": "number", "format": "double", "nullable": true }, "MarginOptimizedSafetyStock": { "type": "number", "format": "double", "nullable": true }, "EffectiveErpSafetyStock": { "type": "number", "format": "double", "nullable": true }, "ErpSafetyStockBalance": { "type": "number", "format": "double", "nullable": true }, "ActiveSafetyStockBalance": { "type": "number", "format": "double", "nullable": true }, "ActiveTargetStockBalance": { "type": "number", "format": "double", "nullable": true }, "ActivePreferredMaxStockBalance": { "type": "number", "format": "double", "nullable": true }, "ActiveMaxStockBalance": { "type": "number", "format": "double", "nullable": true }, "ActiveReorderPointBalance": { "type": "number", "format": "double", "nullable": true }, "OnHandBalance": { "type": "number", "format": "double" }, "StatisticalSafetyStockBalance": { "type": "number", "format": "double", "nullable": true }, "PreferredStatisticalMaxStockBalance": { "type": "number", "format": "double", "nullable": true }, "StatisticalMaxStockBalance": { "type": "number", "format": "double", "nullable": true }, "StatisticalReorderPointBalance": { "type": "number", "format": "double", "nullable": true }, "HistoricalIndependentDailyUsage": { "type": "number", "format": "double" }, "HistoricalDependentDailyUsage": { "type": "number", "format": "double" }, "ForecastedIndependentDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ForecastedDependentDailyUsage": { "type": "number", "format": "double", "nullable": true }, "IndependentDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "DependentDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ItemSiteHistoricalDailyUsage": { "type": "number", "format": "double" }, "ItemSiteForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ItemSiteDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "TargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "ClassBasedTargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "MarginOptimizedTargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "SafetyStockLeadTime": { "type": "integer", "format": "int32" }, "CumulativeSafetyStockLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32" }, "OrderMultipleQuantity": { "type": "integer", "format": "int32" }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "UsagePattern": { "type": "integer", "format": "int32" }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "PriceTier": { "type": "integer", "format": "int32" }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "ResolvedMaxCapacityInUnits": { "type": "number", "format": "double", "nullable": true }, "TypicalOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SafetyStockUsageSource": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Values: 0 = None; 1 = Independent; 2 = Dependent; 3 = Both.", "format": "int32" }, "SalesOrderDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "OpenQuantity": { "type": "number", "format": "double", "readOnly": true }, "OpenBalance": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "DueDate": { "type": "string", "format": "date-time", "readOnly": true }, "DaysUntilDue": { "type": "integer", "format": "int32", "nullable": true }, "AVL": { "type": "number", "format": "double", "readOnly": true }, "DaysUntilNextFulfillment": { "type": "integer", "format": "int32", "nullable": true }, "DaysUntilFullyFulfilled": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "IsLinkedToEvent": { "type": "boolean" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "CustomerId": { "type": "integer", "format": "int32" }, "ShipperCode": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "CC": { "type": "string", "nullable": true }, "CN": { "type": "string", "nullable": true }, "CustomerShipToCode": { "type": "string", "nullable": true }, "CSTN": { "type": "string", "nullable": true }, "SalesOrderId": { "type": "integer", "format": "int32" }, "DemandSeriesId": { "type": "integer", "format": "int32" }, "OrderNumber": { "type": "string", "nullable": true }, "LineNumber": { "type": "number", "format": "double" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "CustomerShipToId": { "type": "integer", "format": "int32" }, "DemandType": { "$ref": "#/components/schemas/DemandType" }, "LS": { "$ref": "#/components/schemas/LineStatus" }, "DemandDate": { "type": "string", "format": "date-time" }, "RSD": { "type": "string", "format": "date-time", "nullable": true }, "RequiredDate": { "type": "string", "format": "date-time", "nullable": true }, "Quantity": { "type": "number", "format": "double" }, "Cogs": { "type": "number", "format": "double", "nullable": true }, "Revenue": { "type": "number", "format": "double", "nullable": true }, "Margin": { "type": "number", "format": "double", "nullable": true }, "InvoicePrice": { "type": "number", "format": "double", "nullable": true }, "InvoicePriceCurrency": { "type": "string", "nullable": true }, "InvoiceCost": { "type": "number", "format": "double", "nullable": true }, "InvoiceCostCurrency": { "type": "string", "nullable": true }, "IsExceptional": { "type": "boolean", "nullable": true }, "SupplyOrderLineId": { "type": "integer", "format": "int32", "nullable": true }, "Note": { "type": "string", "nullable": true }, "DateUpdated": { "type": "string", "format": "date-time" }, "DateOrdered": { "type": "string", "format": "date-time", "nullable": true }, "QuantityShipped": { "type": "number", "format": "double", "nullable": true }, "D": { "type": "string", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "BuyerCode": { "type": "string", "nullable": true }, "BN": { "type": "string", "nullable": true }, "ISC1": { "type": "string", "nullable": true }, "ISC2": { "type": "string", "nullable": true }, "ISC3": { "type": "string", "nullable": true }, "ISC4": { "type": "string", "nullable": true }, "ISC5": { "type": "string", "nullable": true }, "ISC6": { "type": "string", "nullable": true }, "ISC7": { "type": "string", "nullable": true }, "ISC8": { "type": "string", "nullable": true }, "IP": { "type": "integer", "format": "int32" }, "UP": { "type": "integer", "format": "int32" }, "OH": { "type": "number", "format": "double" }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "StateCode": { "type": "string", "nullable": true }, "Abc": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "TotalOnHandQuantityOnDemandDate": { "type": "number", "format": "double" }, "ErpN": { "type": "string", "nullable": true }, "SiqN": { "type": "string", "nullable": true }, "NextFulfillmentDate": { "type": "string", "format": "date-time", "nullable": true }, "DateFullyFulfilled": { "type": "string", "format": "date-time", "nullable": true }, "LastFulfillmentType": { "$ref": "#/components/schemas/SalesOrderFulfillmentType" }, "MappedFromItemSiteId": { "type": "integer", "format": "int32", "nullable": true }, "MappedFromItemCode": { "type": "string", "nullable": true }, "MappedFromSiteCode": { "type": "string", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "PrimarySupplierName": { "type": "string", "nullable": true }, "CustomerAbcClass": { "type": "string", "nullable": true }, "CustomerUsagePattern": { "type": "integer", "format": "int32", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "SalesOrderDetailFilters": { "type": "object", "properties": { "OrderNumbers": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these sales order numbers.", "nullable": true }, "CustomerShipToStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to customer ship-tos located in these state ids.", "nullable": true }, "StartDate": { "type": "string", "description": "Earliest date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "Latest date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "YearNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these calendar year numbers (e.g. 2026).", "nullable": true }, "QuarterNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these quarter numbers (1-4).", "nullable": true }, "MonthNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these month numbers (1-12).", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items whose supplier item code contains one of these values (substring match).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "CustomerShipToCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 1 ids.", "nullable": true }, "CustomerShipToCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 2 ids.", "nullable": true }, "CustomerShipToCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to category 3 ids.", "nullable": true }, "CustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ids.", "nullable": true }, "CustomerShipToIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these customer ship-to ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customers with these customer codes. Unknown codes fail the request with a 400.", "nullable": true }, "CustomerShipToCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to customer ship-tos with these ship-to codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false, "description": "Body for POST api/SalesOrderDetail/fetchby/salesOrderDetailFilters. Extends the date-range\r\nhierarchy filter set with the sales-order-specific dimensions the flat GET accepts." }, "SalesOrderDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "SalesOrderFulfillmentType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Values: 1 = OnHand; 2 = ExistingSupplyOrder; 3 = AlternateSiteOnHand; 4 = NewSupplyOrder.", "format": "int32" }, "SettingSource": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Values: 1 = SystemDefault; 2 = User; 4 = Import; 8 = AutoCreated.", "format": "int32" }, "SizeUnits": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Values: 1 = Inches; 2 = Feet; 3 = Yards; 4 = Millimeters; 5 = Centimeters; 6 = Meters.", "format": "int32" }, "StagingTableImportSettings": { "type": "object", "properties": { "IsCritical": { "type": "boolean" }, "StagingTableImportSettingsId": { "type": "integer", "format": "int32" }, "SchemaName": { "type": "string", "nullable": true }, "TableName": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "MaxDays": { "type": "integer", "format": "int32", "nullable": true }, "DateFilterProperty": { "type": "string", "nullable": true }, "Source": { "$ref": "#/components/schemas/SettingSource" }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "CreatedByUserId": { "type": "integer", "format": "int32" }, "UpdatedByUserId": { "type": "integer", "format": "int32" }, "Note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StatisticalSafetyStockSelectionMethod": { "enum": [ 1, 2, 4, 8, 16, 32, 64 ], "type": "integer", "description": "Values: 1 = Auto; 2 = Lowest; 4 = Highest; 8 = Standard; 16 = LargeRegularPull; 32 = SporadicItem; 64 = Retrospective.", "format": "int32" }, "StockOutsDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "NumberOfDaysHaveBeenOut": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfTimesHaveBeenOut": { "type": "integer", "format": "int32", "nullable": true }, "NextSupplyOrderNumber": { "type": "string", "nullable": true }, "NextSupplyDate": { "type": "string", "format": "date-time", "nullable": true }, "NextSupplyQuantity": { "type": "number", "format": "double", "nullable": true }, "DaysUntilNextSupply": { "type": "integer", "format": "int32", "nullable": true }, "NumberOfOpenSupplyOrders": { "type": "integer", "format": "int32", "nullable": true }, "ProjectedInStockDate": { "type": "string", "format": "date-time", "nullable": true }, "IsOutOfStockInSiteGroup": { "type": "boolean", "nullable": true, "readOnly": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "OutOfStockQuantity": { "type": "number", "format": "double" }, "StandardCostCurrency": { "type": "string", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteGroupName": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "ActiveSafetyStock": { "type": "number", "format": "double" }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "CurrentCost": { "type": "number", "format": "double" }, "StandardCost": { "type": "number", "format": "double" }, "StandardPrice": { "type": "number", "format": "double" }, "StandardPriceCurrency": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "TargetServiceLevel": { "type": "number", "format": "double", "nullable": true }, "LeadTime": { "type": "integer", "format": "int32", "nullable": true }, "LastDateInStock": { "type": "string", "format": "date-time", "nullable": true }, "LastDateAvailable": { "type": "string", "format": "date-time", "nullable": true }, "NumberOfOpenSupplies": { "type": "integer", "format": "int32", "nullable": true }, "NextErpOrderNumber": { "type": "string", "nullable": true }, "LastOrderedDate": { "type": "string", "format": "date-time", "nullable": true }, "LastReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "TotalOnHandQuantity": { "type": "number", "format": "double" }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalHistoricalDailyUsage": { "type": "number", "format": "double" }, "InventoryPosition": { "type": "integer", "format": "int32" }, "LostRevenuePerDay": { "type": "number", "format": "double", "nullable": true }, "TotalOnDemandOrderQuantity": { "type": "number", "format": "double" }, "TotalOnDemandValue": { "type": "number", "format": "double" }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "SiteGroupInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "SiteGroupUsagePattern": { "type": "integer", "format": "int32" }, "SiteGroupOnHandQuantity": { "type": "number", "format": "double" }, "SiteGroupAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "ReplacementFlags": { "type": "integer", "format": "int32" }, "IsOnHandCopied": { "type": "boolean" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "BoMPosition": { "type": "integer", "format": "int32", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "SubstituteAction": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Values: 0 = None; 1 = Substitute; 2 = Remove; 4 = Reduce.", "format": "int32" }, "SubstituteOrderLine": { "type": "object", "properties": { "SubstituteType": { "$ref": "#/components/schemas/SubstituteType" }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteId": { "type": "integer", "format": "int32" }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SiteName": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "QuantityFound": { "type": "number", "format": "double" }, "MultipleAdjustedQuantityFound": { "type": "number", "format": "double" }, "QuantityType": { "$ref": "#/components/schemas/AlternateOrderTargetQuantity" }, "SubstituteAction": { "$ref": "#/components/schemas/SubstituteAction" }, "IsComplete": { "type": "boolean" }, "IsVendorSubstituteWithNoOnHandData": { "type": "boolean" }, "IsRecommended": { "type": "boolean" }, "IsReturnToHub": { "type": "boolean" }, "TotalOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "CurrentExcessQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalDailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "InventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "ActiveSafetyStock": { "type": "number", "format": "double", "nullable": true }, "CurrentDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ItemSiteSupplierId": { "type": "integer", "format": "int32", "nullable": true }, "IntersiteLeadTimeId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierItemCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "ReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "OrderMultipleQuantity": { "type": "integer", "format": "int32", "nullable": true }, "SupplierCost": { "type": "number", "format": "double", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "SystemComment": { "type": "string", "nullable": true }, "ActiveSupplierLevel": { "type": "integer", "format": "int32", "nullable": true }, "ErpOrderNumber": { "type": "string", "nullable": true }, "OrderCreationDate": { "type": "string", "format": "date-time", "nullable": true }, "ReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubstituteType": { "enum": [ 0, 1, 2, 4, 8, 16, 32 ], "type": "integer", "description": "Values: 0 = None; 1 = Self; 2 = Site; 4 = Part; 8 = Replacement; 16 = Vendor; 32 = UnshippedOrder.", "format": "int32" }, "SupplierReceiptPerformanceOverview": { "type": "object", "properties": { "CalendarDaysReceiptDelay": { "type": "integer", "description": "", "format": "int32", "nullable": true, "readOnly": true }, "NumberOfPerfectLines": { "type": "integer", "format": "int32" }, "NumberOfPerfectOrders": { "type": "integer", "format": "int32" }, "LineServiceLevel": { "type": "number", "format": "double", "nullable": true }, "OrderServiceLevel": { "type": "number", "format": "double", "nullable": true }, "EarlyCount": { "type": "integer", "format": "int32" }, "OnTimeCount": { "type": "integer", "format": "int32" }, "LateCount": { "type": "integer", "format": "int32" }, "UnknownCount": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32", "readOnly": true }, "PercentEarly": { "type": "number", "format": "double", "readOnly": true }, "PercentOnTime": { "type": "number", "format": "double", "readOnly": true }, "PercentLate": { "type": "number", "format": "double", "readOnly": true }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "OrderCount": { "type": "integer", "format": "int32", "nullable": true }, "OrderLineCount": { "type": "integer", "format": "int32", "nullable": true }, "ReceiptCount": { "type": "integer", "format": "int32", "nullable": true }, "CompleteCount": { "type": "integer", "format": "int32", "nullable": true }, "UnderCount": { "type": "integer", "format": "int32", "nullable": true }, "OverCount": { "type": "integer", "format": "int32", "nullable": true }, "AdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "VendorLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysReleaseDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysShipDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysDeliveryDelay": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysShipDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysDeliveryDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true }, "CalendarDaysReceiptDelayVsOriginal": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SupplyOrderDateRangeItemSiteFilters": { "type": "object", "properties": { "StockIQOrderNumbers": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these StockIQ-assigned order numbers.", "nullable": true }, "ErpOrderNumbers": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ERP order numbers.", "nullable": true }, "SupplyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyType" }, "description": "Restrict to these supply types.", "nullable": true }, "ErpLineStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/LineStatus" }, "description": "Restrict to orders with at least one line in these ERP line statuses.", "nullable": true }, "StockIqStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineStatus" }, "description": "Restrict to orders with at least one line in these StockIQ line statuses.", "nullable": true }, "SyncStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyOrderSyncStatus" }, "description": "Restrict to orders in these ERP synchronization statuses.", "nullable": true }, "CreatedBySystem": { "type": "array", "items": { "type": "boolean" }, "description": "Restrict by origin: true for StockIQ-created orders, false for ERP-imported orders.", "nullable": true }, "StartDate": { "type": "string", "description": "Earliest date included, inclusive. Omit for no lower bound.", "format": "date-time", "nullable": true }, "EndDate": { "type": "string", "description": "Latest date included, inclusive. Omit for no upper bound.", "format": "date-time", "nullable": true }, "YearNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these calendar year numbers (e.g. 2026).", "nullable": true }, "QuarterNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these quarter numbers (1-4).", "nullable": true }, "MonthNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these month numbers (1-12).", "nullable": true }, "ItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item ids.", "nullable": true }, "SiteIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these site ids.", "nullable": true }, "PrimarySupplierIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to item-sites whose primary supplier is one of these supplier ids.", "nullable": true }, "BuyerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these buyer ids.", "nullable": true }, "AbcClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these ABC classes (e.g. A, B, C).", "nullable": true }, "XyzClasses": { "type": "array", "items": { "type": "string" }, "description": "Restrict to these XYZ classes.", "nullable": true }, "OrderPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "description": "Restrict to item-sites using these replenishment order policies.", "nullable": true }, "ItemStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatus" }, "description": "Restrict to items with these item statuses.", "nullable": true }, "ShipperIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these shipper (owning company) ids.", "nullable": true }, "BoMPositions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items at these bill-of-material positions.", "nullable": true }, "ItemTagIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to items carrying any of these item tag ids.", "nullable": true }, "SupplierItemCode": { "type": "array", "items": { "type": "string" }, "description": "Restrict by supplier item code (exact match). On item-site level endpoints this matches\r\nthe primary supplier's item code; on supplier-relationship level endpoints (receipts,\r\nlead times) it matches the code on the returned relationship.", "nullable": true }, "ItemSiteCategory1Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 1 ids.", "nullable": true }, "ItemSiteCategory2Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 2 ids.", "nullable": true }, "ItemSiteCategory3Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 3 ids.", "nullable": true }, "ItemSiteCategory4Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 4 ids.", "nullable": true }, "ItemSiteCategory5Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 5 ids.", "nullable": true }, "ItemSiteCategory6Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 6 ids.", "nullable": true }, "ItemSiteCategory7Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 7 ids.", "nullable": true }, "ItemSiteCategory8Ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Restrict to these item-site category 8 ids.", "nullable": true }, "ItemCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to items with these item codes. Codes are resolved server-side; any unknown code fails the request with a 400 listing it.", "nullable": true }, "SiteCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to sites with these site codes. Unknown codes fail the request with a 400.", "nullable": true }, "PrimarySupplierCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-sites whose primary supplier has one of these supplier codes. Unknown codes fail the request with a 400.", "nullable": true }, "BuyerCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to buyers with these buyer codes. Unknown codes fail the request with a 400.", "nullable": true }, "ShipperCodes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to shippers with these shipper codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory1Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 1 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory2Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 2 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory3Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 3 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory4Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 4 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory5Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 5 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory6Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 6 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory7Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 7 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true }, "ItemSiteCategory8Codes": { "type": "array", "items": { "type": "string" }, "description": "Restrict to item-site category 8 entries with these codes. Unknown codes fail the request with a 400.", "nullable": true } }, "additionalProperties": false }, "SupplyOrderDetail": { "type": "object", "properties": { "SupplyOrderId": { "type": "integer", "format": "int32" }, "SupplyOrderSetId": { "type": "integer", "format": "int32" }, "ErpOrderNumber": { "type": "string", "nullable": true }, "StockIqOrderNumber": { "type": "string", "nullable": true }, "SyncStatus": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "OriginalSupplierId": { "type": "integer", "format": "int32" }, "SupplyType": { "type": "integer", "format": "int32" }, "OrderCreationDate": { "type": "string", "format": "date-time", "nullable": true }, "ReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "InternalNote": { "type": "string", "nullable": true }, "ExternalNote": { "type": "string", "nullable": true }, "PaymentTermsId": { "type": "integer", "format": "int32", "nullable": true }, "ShippingMethodId": { "type": "integer", "format": "int32", "nullable": true }, "IsDropship": { "type": "boolean" }, "ReviewUserId": { "type": "integer", "format": "int32", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "IsStockIqOrder": { "type": "boolean" }, "SiteCode": { "type": "string", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "PaymentTermsCode": { "type": "string", "nullable": true }, "ShippingMethodCode": { "type": "string", "nullable": true }, "ShippingMethodName": { "type": "string", "nullable": true }, "LineCount": { "type": "integer", "format": "int32", "nullable": true }, "LinePurchaseCost": { "type": "number", "format": "double", "nullable": true }, "CreatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "CreatedByUserName": { "type": "string", "nullable": true }, "TotalSupplyOrderWeight": { "type": "number", "format": "double", "nullable": true }, "TotalSupplyOrderCubes": { "type": "number", "format": "double", "nullable": true }, "TotalSupplyOrderPallets": { "type": "number", "format": "double", "nullable": true }, "TotalSupplyOrderEquivalencyUnits": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SupplyOrderDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyOrderDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "SupplyOrderLineDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "PrimarySupplierName": { "type": "string", "nullable": true, "readOnly": true }, "Guid": { "type": "string", "nullable": true }, "ErrorMessages": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineErrorMessage" }, "nullable": true }, "SubstituteOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/SubstituteOrderLine" }, "nullable": true }, "BlanketPurchaseOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/BlanketPurchaseOrderLineDetail" }, "nullable": true }, "LeadTimeMessages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DaysUntilDue": { "type": "integer", "format": "int32" }, "SiteWorkDaysPerYear": { "type": "integer", "format": "int32" }, "ShipWindowDate": { "type": "string", "format": "date-time", "nullable": true }, "MergePlannedReceiptDateWindow": { "type": "string", "format": "date-time", "nullable": true }, "NumberByExpectedShipDateWindow": { "type": "string", "format": "date-time", "nullable": true }, "NumberByPlannedReceiptDateWindow": { "type": "string", "format": "date-time", "nullable": true }, "IsInOrder": { "type": "boolean" }, "IsFromSubstitute": { "type": "boolean" }, "IsEditingAllowed": { "type": "boolean" }, "HasHigherMultiples": { "type": "boolean" }, "IsUnderMinOrderQuantity": { "type": "boolean" }, "IsUnderMoqTarget": { "type": "boolean" }, "IsOverMaxOrderQuantity": { "type": "boolean", "readOnly": true }, "ViolatesOrderMultipleQuantity": { "type": "boolean", "readOnly": true }, "SubstitutesCount": { "type": "integer", "format": "int32", "readOnly": true }, "RecommendedSubstitutesCount": { "type": "integer", "format": "int32", "readOnly": true }, "IsOverWarehouseProjectedAvailableToTransfer": { "type": "boolean" }, "IsOverWarehouseAvailableToTransfer": { "type": "boolean" }, "IsOverWarehouseOnHandToTransfer": { "type": "boolean" }, "IsOverWarehouseExcessToTransfer": { "type": "boolean" }, "HasTransferQuantityProblem": { "type": "boolean" }, "HasSupplierQuantityProblem": { "type": "boolean" }, "IsUnderSupplierItemMinimum": { "type": "boolean", "nullable": true }, "IsShippingFromBlanketPurchaseOrderOnHand": { "type": "boolean" }, "OverWarehouseCapacityByOnHand": { "type": "boolean", "description": "if they order this much, will they be over capacity when comparing vs current on hand?", "readOnly": true }, "OverWarehouseCapacityByAvailableQuantity": { "type": "boolean", "description": "If they order this much, will they be over capacity when comparing vs current available?", "readOnly": true }, "OverWarehouseCapacityByProjectedAvailable": { "type": "boolean", "readOnly": true }, "HasWarehouseCapacityProblem": { "type": "boolean" }, "HasBlanketOrderQuantityProblem": { "type": "boolean" }, "IsPlanAtRisk": { "type": "boolean", "readOnly": true }, "HasPlannedReceiptDateProblem": { "type": "boolean", "readOnly": true }, "HasExpectedShipDateProblem": { "type": "boolean", "readOnly": true }, "IsCoverageBuy": { "type": "boolean", "readOnly": true }, "OrderedToday": { "type": "number", "format": "double" }, "AllWarehousesOnOrderQuantity": { "type": "number", "format": "double" }, "PurchaseQuantity": { "type": "number", "format": "double", "nullable": true }, "PurchaseQuantityCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PercentOfReleaseReceived": { "type": "number", "description": "How much of our originally released quantity have we received", "format": "double", "readOnly": true }, "OrderDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedDaysOfSupplyOnArrival": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedOnHandQuantity": { "type": "number", "description": "how many will we have when this arrives a lead time from today?", "format": "double", "nullable": true, "readOnly": true }, "ProjectedDaysCycleStockOnArrival": { "type": "number", "description": "Projected days of cycle stock on arrival INCLUDING the proposed release quantity", "format": "double", "nullable": true, "readOnly": true }, "ProjectedDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedDaysOfCycleStock": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ProjectedActualAvailableOnHandBalance": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ExpectedReceiptDate": { "type": "string", "format": "date-time" }, "LineSupplierCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LinePurchaseCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineWeight": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LinePallets": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineEquivalencyUnits": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "TotalOnDemandQuantity": { "type": "number", "format": "double", "readOnly": true }, "AtRiskQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "PlanState": { "$ref": "#/components/schemas/PlanState" }, "InventoryPositionAtLeadTime": { "$ref": "#/components/schemas/InventoryPosition" }, "UnitCubes": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LineUnits": { "type": "number", "format": "double" }, "ContainerPercentUsage": { "type": "number", "format": "double", "nullable": true }, "HistoricalMonthlyUsage": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "ForecastedMonthlyUsage": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "MonthlyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LastYearActuals": { "type": "number", "format": "double", "nullable": true }, "ThreeMonthsAgoActuals": { "type": "number", "format": "double", "nullable": true }, "TwoMonthsAgoActuals": { "type": "number", "format": "double", "nullable": true }, "LastMonthActuals": { "type": "number", "format": "double", "nullable": true }, "PeriodToDateActuals": { "type": "number", "format": "double", "nullable": true }, "CurrentPeriodForecastQuantity": { "type": "number", "format": "double", "nullable": true }, "PeriodToDatePercentOfForecast": { "type": "number", "format": "double", "nullable": true }, "NextExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "NextExpectedDockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextPlannedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "NextErpOrderNumber": { "type": "string", "nullable": true }, "WarehouseLocationId": { "type": "integer", "format": "int32", "nullable": true }, "WarehouseLocationCode": { "type": "string", "nullable": true }, "WarehouseZone": { "type": "string", "nullable": true }, "QuantityReceived": { "type": "number", "format": "double", "readOnly": true }, "InTransitQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "InTransitDollars": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnconsumedAvailableAndOrderQuantity": { "type": "number", "format": "double", "readOnly": true }, "UnconsumedDaysOfSupply": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "MoqRatio": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "MaxCapacity": { "type": "number", "format": "double", "nullable": true }, "MaxCapacityUnitOfMeasure": { "$ref": "#/components/schemas/InventoryMeasure" }, "ResolvedMaxCapacityInUnits": { "type": "number", "format": "double", "nullable": true }, "DaysUntilNextCostChange": { "type": "integer", "format": "int32", "nullable": true }, "NextSupplierCostChangePercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "RawFirmReleaseQuantity": { "type": "number", "format": "double" }, "RemainingBlanketPoQuantity": { "type": "number", "format": "double", "nullable": true }, "CurrentExcessThreshold": { "type": "number", "format": "double" }, "ProjectedAvailableAtLeadTimeWithoutOrderSuggestion": { "type": "number", "format": "double", "nullable": true }, "Margin": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnitFreightCost": { "type": "number", "format": "double", "nullable": true }, "LineFreightCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LandedCost": { "type": "number", "format": "double", "readOnly": true }, "LineLandedCost": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "LandedMargin": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "AdjustedMargin": { "type": "number", "format": "double", "nullable": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "CurrentZonePercentUsage": { "type": "number", "format": "double", "nullable": true }, "ProjectedZonePercentUsage": { "type": "number", "format": "double", "nullable": true }, "IntegrationConfigurationId": { "type": "integer", "format": "int32" }, "ErpOrderNumber": { "type": "string", "nullable": true }, "StockIqOrderNumber": { "type": "string", "nullable": true }, "SupplyType": { "$ref": "#/components/schemas/SupplyType" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "ItemId": { "type": "integer", "format": "int32" }, "SiteId": { "type": "integer", "format": "int32" }, "ItemSiteSupplierId": { "type": "integer", "format": "int32" }, "SupplierId": { "type": "integer", "format": "int32" }, "SupplierItemCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "SupplierLocationId": { "type": "integer", "format": "int32", "nullable": true }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ShipperCode": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "SupplierCode": { "type": "string", "nullable": true }, "BuyerCode": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "SupplierName": { "type": "string", "nullable": true }, "SupplierItemCategoryName": { "type": "string", "nullable": true }, "SupplierLocationName": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SupplierItemCode": { "type": "string", "nullable": true }, "SupplierOnHand": { "type": "number", "format": "double", "nullable": true }, "ActiveSupplierLevel": { "type": "integer", "format": "int32" }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "OldestUnfulfilledFirmDemandDate": { "type": "string", "format": "date-time", "nullable": true }, "LastUsedDate": { "type": "string", "format": "date-time", "nullable": true }, "LastDateInStock": { "type": "string", "format": "date-time", "nullable": true }, "ItemSiteNotes": { "type": "string", "nullable": true }, "DateNoteUpdated": { "type": "string", "format": "date-time", "nullable": true }, "HubCount": { "type": "integer", "format": "int32", "nullable": true }, "CreatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "IsStockIqOrder": { "type": "boolean" }, "DateCreated": { "type": "string", "format": "date-time" }, "SupplyOrderSetId": { "type": "integer", "format": "int32" }, "SupplyOrderLineId": { "type": "integer", "format": "int32" }, "SupplyOrderId": { "type": "integer", "format": "int32" }, "ContainerNumber": { "type": "string", "nullable": true }, "ReleaseNumber": { "type": "integer", "format": "int32", "nullable": true }, "StockIqLineNumber": { "type": "number", "format": "double", "nullable": true }, "ErpLineNumber": { "type": "number", "format": "double", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "StockIqStatus": { "$ref": "#/components/schemas/OrderLineStatus" }, "ErpLineStatus": { "$ref": "#/components/schemas/LineStatus" }, "ReleaseQuantity": { "type": "number", "format": "double" }, "RemainingReleaseQuantity": { "type": "number", "format": "double" }, "QuantityShipped": { "type": "number", "format": "double", "nullable": true }, "PurchaseCost": { "type": "number", "format": "double" }, "PurchaseCostCurrency": { "type": "string", "nullable": true }, "PurchaseCostExponent": { "type": "integer", "format": "int32", "nullable": true }, "ExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedDockDate": { "type": "string", "format": "date-time" }, "PlannedReceiptDate": { "type": "string", "format": "date-time" }, "InternalLineComment": { "type": "string", "nullable": true }, "ExternalLineComment": { "type": "string", "nullable": true }, "ReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "RemainingReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "SystemLineComment": { "type": "string", "nullable": true }, "StockIqSuggestedReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "RawReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "ReleaseQuantityBeforePricebreakModifications": { "type": "number", "format": "double", "nullable": true }, "CoverageDaysMode": { "$ref": "#/components/schemas/DaysCoverageMode" }, "CoverageDate": { "type": "string", "format": "date-time", "nullable": true }, "CoverageExtendToNextScheduleDate": { "type": "boolean", "nullable": true }, "SupplierCost": { "type": "number", "format": "double" }, "SupplierCostCurrency": { "type": "string", "nullable": true }, "StandardPrice": { "type": "number", "format": "double" }, "StandardPriceCurrency": { "type": "string", "nullable": true }, "ConfirmedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "ApprovedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "OriginalReleaseQuantity": { "type": "number", "format": "double", "nullable": true }, "OriginalReceiptQuantity": { "type": "number", "format": "double", "nullable": true }, "OriginalExpectedShipDate": { "type": "string", "format": "date-time", "nullable": true }, "OriginalExpectedDockDate": { "type": "string", "format": "date-time" }, "OriginalExpectedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "OriginalPlannedReceiptDate": { "type": "string", "format": "date-time", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "UnitOfMeasure": { "type": "string", "nullable": true }, "PurchaseUnitOfMeasure": { "type": "string", "nullable": true }, "StockingUnitsPerPurchaseUnits": { "type": "number", "format": "double", "nullable": true }, "MinimumOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "OrderMultipleQuantity": { "type": "integer", "format": "int32", "nullable": true }, "MaxOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "TotalOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "ReplacedOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalOnOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalInTransitQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalOnDemandOrderQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableQuantityAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "HistoricalDailyUsage": { "type": "number", "format": "double", "nullable": true }, "ForecastedDailyUsage": { "type": "number", "format": "double", "nullable": true }, "DailyUsageAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ProjectedActualAvailableAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "ProjectedFirmsOnlyAtLeadTime": { "type": "number", "format": "double", "nullable": true }, "Eoq": { "type": "number", "format": "double", "nullable": true }, "PercentHoldingCost": { "type": "number", "format": "double", "nullable": true }, "HoldingCost": { "type": "number", "format": "double", "nullable": true }, "EstimatedCostOfOrdering": { "type": "number", "format": "double", "nullable": true }, "EstimatedReceivingCost": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderCycle": { "type": "integer", "format": "int32", "nullable": true }, "ActivePanicPoint": { "type": "number", "format": "double", "nullable": true }, "ActiveSafetyStock": { "type": "number", "format": "double", "nullable": true }, "ActiveTargetStock": { "type": "number", "format": "double" }, "ActivePreferredMaxStock": { "type": "number", "format": "double", "nullable": true }, "ActiveMaxStock": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ActiveOrderPolicyFixedQuantity": { "type": "number", "format": "double", "nullable": true }, "ActiveOrderPolicyMinMaxTargetQuantity": { "type": "number", "format": "double", "nullable": true }, "ActiveKanbanBinCount": { "type": "integer", "format": "int32", "nullable": true }, "ActiveKanbanQuantityPerBin": { "type": "integer", "format": "int32", "nullable": true }, "SourceWarehouseOnHandToTransfer": { "type": "number", "format": "double", "nullable": true }, "SourceWarehouseAvailableToTransfer": { "type": "number", "format": "double", "nullable": true }, "SourceWarehouseProjectedAvailableToTransfer": { "type": "number", "format": "double", "nullable": true }, "SourceWarehouseExcessToTransfer": { "type": "number", "format": "double", "nullable": true }, "SourceWarehouseAvailableToBuild": { "type": "number", "format": "double", "nullable": true }, "SourceWarehouseAvailableToPromise": { "type": "number", "format": "double", "nullable": true }, "TotalOnHandToTransfer": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableToTransfer": { "type": "number", "format": "double", "nullable": true }, "TotalProjectedAvailableToTransfer": { "type": "number", "format": "double", "nullable": true }, "TotalExcessToTransfer": { "type": "number", "format": "double", "nullable": true }, "AvailableToBuild": { "type": "number", "format": "double", "nullable": true }, "TotalAvailableToPromise": { "type": "number", "format": "double", "nullable": true }, "AlternatesFlags": { "$ref": "#/components/schemas/SubstituteType" }, "ShelfLifeDays": { "type": "integer", "format": "int32", "nullable": true }, "CurrentExcess": { "type": "number", "format": "double", "nullable": true }, "InventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "YieldPercentage": { "type": "number", "format": "double", "nullable": true }, "NextSupplierCost": { "type": "number", "format": "double", "nullable": true }, "NextSupplierCostDate": { "type": "string", "format": "date-time", "nullable": true }, "ActivePlanningLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveAdminLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveManufacturingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActiveExpeditedShippingLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "ActivePutawayLeadTime": { "type": "integer", "format": "int32", "nullable": true }, "PlanningPadDays": { "type": "integer", "format": "int32", "nullable": true }, "SubtractPlanningPadFromErpDate": { "type": "boolean" }, "SubtractPutawayTimeFromErpDate": { "type": "boolean" }, "UserEditedReleaseQuantity": { "type": "boolean" }, "UserEditedReceiptDate": { "type": "boolean" }, "UserEditedShipDate": { "type": "boolean" }, "PurchaseCostStatus": { "$ref": "#/components/schemas/PurchaseCostStatus" }, "HasOrderSchedule": { "type": "boolean" }, "HasDeliverySchedule": { "type": "boolean" }, "HasShipmentSchedule": { "type": "boolean" }, "DateUpdated": { "type": "string", "format": "date-time" }, "MergedFromSupplyOrderLineId": { "type": "integer", "format": "int32", "nullable": true }, "MergedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "IsUsingExpeditedShippingLeadTime": { "type": "boolean" }, "IsShippingFromSupplierOnHand": { "type": "boolean" }, "OrderCreationDate": { "type": "string", "format": "date-time", "nullable": true }, "ReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "ExpectedReleaseDate": { "type": "string", "format": "date-time", "nullable": true }, "Upc": { "type": "string", "nullable": true }, "UnitWeight": { "type": "number", "format": "double", "nullable": true }, "WeightUnits": { "type": "integer", "format": "int32", "nullable": true }, "UnitLength": { "type": "number", "format": "double", "nullable": true }, "UnitWidth": { "type": "number", "format": "double", "nullable": true }, "UnitHeight": { "type": "number", "format": "double", "nullable": true }, "SizeUnits": { "$ref": "#/components/schemas/SizeUnits" }, "UnitsPerPallet": { "type": "number", "format": "double", "nullable": true }, "EquivalencyUnits": { "type": "number", "format": "double", "nullable": true }, "ItemErpNotes": { "type": "string", "nullable": true }, "DateObsolete": { "type": "string", "format": "date-time", "nullable": true }, "OutOfStockQuantity": { "type": "number", "format": "double" }, "ItemSiteErpNotes": { "type": "string", "nullable": true }, "WarehouseZoneId": { "type": "integer", "format": "int32", "nullable": true }, "WarehouseZoneCode": { "type": "string", "nullable": true }, "SalesOrderId": { "type": "integer", "format": "int32", "nullable": true }, "SalesOrderNumber": { "type": "string", "nullable": true }, "SalesOrderLineNumber": { "type": "number", "format": "double" }, "BlanketPurchaseOrderLineId": { "type": "integer", "format": "int32", "nullable": true }, "ErpBlanketOrderNumber": { "type": "string", "nullable": true }, "StockIqBlanketOrderNumber": { "type": "string", "nullable": true }, "ErpBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "StockIqBlanketOrderLineNumber": { "type": "number", "format": "double", "nullable": true }, "CreatedByUserName": { "type": "string", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "BoMPosition": { "$ref": "#/components/schemas/BoMPosition" }, "PriceTier": { "type": "integer", "format": "int32" }, "Removed": { "type": "boolean" }, "IsActive": { "type": "boolean" }, "ResolvedQuantityShipped": { "type": "number", "format": "double", "nullable": true }, "SiteGroupId": { "type": "integer", "format": "int32" }, "SiteGroupName": { "type": "string", "nullable": true }, "SiteGroupInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "SiteGroupOnHandQuantity": { "type": "number", "format": "double", "nullable": true }, "SiteGroupAvailableQuantity": { "type": "number", "format": "double", "nullable": true }, "CountryOfOrigin": { "type": "string", "nullable": true }, "ImportTaxPercent": { "type": "number", "format": "double", "nullable": true }, "ImportTaxCost": { "type": "number", "format": "double", "nullable": true }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true }, "CustomerShipToCategory1Value": { "type": "string", "description": "Virtual property to satisfy implementing IAlertDetail, specifically so that we can be able to tell the difference between item-site and item-site-CSC1 level alerts\r\nin alert tests in our tests.", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "SupplyOrderLineDetailPagedResult": { "required": [ "CurrentPage", "Data", "PageSize", "TotalPages", "TotalRecords" ], "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "NextPage": { "type": "integer", "description": "The page to request next, or null when StockIQ.Utils.Paging.PagedResult`1.CurrentPage is at (or past) the end.\r\nConsumers walk the data by re-sending the same request with `?page=NextPage` until null.", "format": "int32", "nullable": true }, "PreviousPage": { "type": "integer", "description": "The page before StockIQ.Utils.Paging.PagedResult`1.CurrentPage, or null from page 1 (or when there is no data).\r\nClamped to StockIQ.Utils.Paging.PagedResult`1.TotalPages so a request past the end points back at the last real page.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "TotalRecords": { "type": "integer", "format": "int32" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyOrderLineDetail" }, "nullable": true } }, "additionalProperties": false, "description": "The response envelope for a paged request: one page of data plus the navigation metadata a\r\nconsumer needs to walk the full result set." }, "SupplyOrderSyncStatus": { "enum": [ 1, 2, 4, 8, 16 ], "type": "integer", "description": "Values: 1 = NeedsInitialSync; 2 = Sent; 4 = Synced; 8 = NeedsReSync; 16 = NotApplicable.", "format": "int32" }, "SupplyType": { "enum": [ 0, 1, 4, 7, 8, 16, 32 ], "type": "integer", "description": "Values: 0 = None; 1 = ReplenishmentPO; 4 = DropShipPO; 7 = PO; 8 = TransferOrder; 16 = WorkOrder; 32 = Unbuild.", "format": "int32" }, "SystemStatus": { "type": "object", "properties": { "SystemStatusId": { "type": "integer", "format": "int32" }, "StatusFlag": { "$ref": "#/components/schemas/SystemStatusFlag" }, "CalculateStep": { "type": "string", "nullable": true }, "LastUpdated": { "type": "string", "format": "date-time" }, "LastUpdatedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SystemStatusFlag": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072 ], "type": "integer", "description": "Values: 0 = NewlyInstalled; 1 = Ready; 2 = RunningExtracts; 4 = ExtractsCompleted; 8 = RunningImports; 16 = ImportsCompleted; 32 = UpdatingDatabase; 64 = DatabaseUpdated; 128 = RunningCalculations; 256 = CalculationsComplete; 512 = RefreshPending; 1024 = CancelRefreshRequested; 2048 = RefreshCanceled; 4096 = ExtractError; 8192 = ImportError; 16384 = DatabaseUpdateError; 32768 = DataRefreshError; 65536 = SystemMaintenancePending; 131072 = SystemMaintenanceInProgress.", "format": "int32" }, "TimeInterval": { "enum": [ 0, 1, 2, 4, 8, 16, 32 ], "type": "integer", "description": "Values: 0 = None; 1 = Daily; 2 = Weekly; 4 = Monthly; 8 = Quarterly; 16 = SemiAnnually; 32 = Yearly.", "format": "int32" }, "TimeSeriesUnitOfMeasure": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Values: 1 = Units; 2 = Cogs; 4 = Revenue; 8 = Margin.", "format": "int32" }, "UnderforecastedPeriodDetail": { "type": "object", "properties": { "AlertKeyId": { "type": "integer", "format": "int64", "readOnly": true }, "AlertType": { "$ref": "#/components/schemas/AlertType" }, "PrimaryId": { "type": "integer", "format": "int32", "readOnly": true }, "PrimaryIdProperty": { "$ref": "#/components/schemas/AlertPrimaryIdProperty" }, "ForecastErrorPercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "StatisticalErrorPercent": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "UnderforecastRevenueVariance": { "type": "number", "format": "double", "readOnly": true }, "LevelName": { "type": "string", "nullable": true }, "ItemTagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagAssignmentDetail" }, "nullable": true }, "NodeLevel": { "type": "integer", "format": "int32" }, "HierarchyProperty": { "$ref": "#/components/schemas/HierarchyProperty" }, "ShipperId": { "type": "integer", "format": "int32", "nullable": true }, "SiteId": { "type": "integer", "format": "int32" }, "ItemId": { "type": "integer", "format": "int32" }, "BuyerId": { "type": "integer", "format": "int32", "nullable": true }, "PrimarySupplierId": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerShipToCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "CustomerId": { "type": "integer", "format": "int32" }, "CustomerShipToId": { "type": "integer", "format": "int32" }, "ItemSiteCategory1Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory2Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory3Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory4Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory5Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory6Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory7Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteCategory8Id": { "type": "integer", "format": "int32", "nullable": true }, "ItemSiteId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesName": { "type": "string", "nullable": true }, "NodeValue": { "type": "string", "nullable": true }, "HierarchyNodeId": { "type": "integer", "format": "int32" }, "DemandForecastSeriesId": { "type": "integer", "format": "int32" }, "PeriodDate": { "type": "string", "format": "date-time" }, "Interval": { "$ref": "#/components/schemas/TimeInterval" }, "ForecastQuantity": { "type": "number", "format": "double" }, "ToleranceUpperBound": { "type": "number", "format": "double" }, "StatisticalForecastQuantity": { "type": "number", "format": "double" }, "ForecastAverageQuantity": { "type": "number", "format": "double" }, "StatisticalAverageQuantity": { "type": "number", "format": "double" }, "ForecastRevenue": { "type": "number", "format": "double" }, "ForecastCogs": { "type": "number", "format": "double" }, "StatisticalForecastRevenue": { "type": "number", "format": "double" }, "AverageForecastErrorPercent": { "type": "number", "format": "double", "nullable": true }, "AverageStatisticalErrorPercent": { "type": "number", "format": "double", "nullable": true }, "AverageForecastErrorUnits": { "type": "number", "format": "double", "nullable": true }, "AverageStatisticalErrorUnits": { "type": "number", "format": "double", "nullable": true }, "PeriodTotalQuantitySold": { "type": "number", "format": "double" }, "PeriodTotalRevenue": { "type": "number", "format": "double" }, "PeriodTotalCogs": { "type": "number", "format": "double" }, "PercentThroughPeriod": { "type": "number", "format": "double" }, "PercentOfDemandExpected": { "type": "number", "format": "double" }, "ProjectedPeriodTotalQuantitySold": { "type": "number", "format": "double" }, "ProjectedPeriodTotalRevenue": { "type": "number", "format": "double" }, "ProjectedPeriodTotalCogs": { "type": "number", "format": "double" }, "ForecastErrorUnits": { "type": "number", "format": "double" }, "ForecastErrorDollars": { "type": "number", "format": "double" }, "StatisticalErrorUnits": { "type": "number", "format": "double" }, "StatisticalErrorDollars": { "type": "number", "format": "double" }, "UsagePattern": { "$ref": "#/components/schemas/UsagePattern" }, "IsAutoForecasted": { "type": "boolean" }, "ProjectedOutOfStockDate": { "type": "string", "format": "date-time", "nullable": true }, "NextOrderDockDate": { "type": "string", "format": "date-time", "nullable": true }, "ProjectedInventoryPosition": { "$ref": "#/components/schemas/InventoryPosition" }, "ShipperName": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "ItemDescription": { "type": "string", "nullable": true }, "SiteCode": { "type": "string", "nullable": true }, "CustomerShipToCategory1Value": { "type": "string", "nullable": true }, "CustomerShipToCategory2Value": { "type": "string", "nullable": true }, "CustomerShipToCategory3Value": { "type": "string", "nullable": true }, "CustomerName": { "type": "string", "nullable": true }, "CustomerShipToName": { "type": "string", "nullable": true }, "ItemSiteCategory1Name": { "type": "string", "nullable": true }, "ItemSiteCategory2Name": { "type": "string", "nullable": true }, "ItemSiteCategory3Name": { "type": "string", "nullable": true }, "ItemSiteCategory4Name": { "type": "string", "nullable": true }, "ItemSiteCategory5Name": { "type": "string", "nullable": true }, "ItemSiteCategory6Name": { "type": "string", "nullable": true }, "ItemSiteCategory7Name": { "type": "string", "nullable": true }, "ItemSiteCategory8Name": { "type": "string", "nullable": true }, "AbcClass": { "type": "string", "nullable": true }, "XyzClass": { "type": "string", "nullable": true }, "BuyerName": { "type": "string", "nullable": true }, "PrimarySupplierName": { "type": "string", "nullable": true }, "ActiveOrderPolicy": { "$ref": "#/components/schemas/ReplenishmentOrderPolicy" }, "ResolvedItemStatus": { "$ref": "#/components/schemas/ItemStatus" }, "AlertSummaryId": { "type": "integer", "format": "int32" }, "AMsg": { "type": "string", "nullable": true }, "DateCreated": { "type": "string", "format": "date-time" }, "DateUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "AssignedToUserId": { "type": "integer", "format": "int32", "nullable": true }, "ASt": { "$ref": "#/components/schemas/AlertState" }, "APri": { "$ref": "#/components/schemas/AlertPriority" }, "Rank": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "SuspendedByUserName": { "type": "string", "nullable": true }, "DateSuspended": { "type": "string", "format": "date-time", "nullable": true }, "ReactivationDate": { "type": "string", "format": "date-time", "nullable": true }, "IsReactivateEnabled": { "type": "boolean", "nullable": true }, "AlertNote": { "type": "string", "nullable": true }, "AlertTypeName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UsagePattern": { "enum": [ 0, 1, 2, 4, 8, 16 ], "type": "integer", "description": "Values: 0 = Unknown; 1 = New; 2 = Recurring; 4 = Sporadic; 8 = Slow; 16 = Dead.", "format": "int32" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT obtained from POST /api/authenticate (expires after 1 hour).", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ] }