{ "openapi": "3.0.4", "info": { "title": "IDS Public API", "description": "

\r\n Passing orders to the IDS API starts with a request/ship POST request. Once provided with an API Key, test requests\r\n can be made via the Specification below, or using a wonderful, free API\r\n exploration tool: Postman\r\n

\r\n\r\n

\r\n Our goal is to track whatever data you require. As such, the full data model available is quite extensive, but these\r\n examples reflect a minimum set needed to \"Get Started\".\r\n

\r\n\r\n

\r\n GET Requests: POST data is considered 'locked' by the IDS API. Updates to Shipments and Receipts\r\n are purposely blocked and duplicate reference numbers will be completely ignored. Since updates are\r\n blocked, a special behavior has been added GET requests. Basic GET requests (without queries) mark returned entries\r\n as 'sent', and 'sent' entries are filtered out of future GET requests. To bypass\r\n this 'sent' flag, a /preview path is available for shipments and receipts. It may also be bypassed by including a\r\n search query. (Reference Number and/or Date Range)\r\n

", "version": "v1" }, "paths": { "/request/InventoryReceipt": { "get": { "tags": [ "InventoryReceipt" ], "summary": "Returns all Inventory Receipt Confirmations that have not yet been sent", "description": "Returns all Inventory Receipt Confirmations that have not yet been sent", "parameters": [ { "name": "min_CreatedDateTime", "in": "query", "description": "IDS WMS Local (MT) Date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "max_CreatedDateTime", "in": "query", "description": "IDS WMS Local (MT) Date - Requires min_CreatedDateTime.", "schema": { "type": "string", "format": "date-time" } }, { "name": "CustomerReferenceNumbers", "in": "query", "description": "A comma separated list of reference numbers to search for", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ReceiptTypes", "in": "query", "description": "A comma separated list of receipt types to search for\r\n\"C\" for \"Customer Receipt\", \"R\" for \"Return\"", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "The number of records to retrieve. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "InventoryReceipt" ], "summary": "Processes Inventory Receipts", "description": "Processes an Inventory Receipt request", "parameters": [ { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "requestBody": { "description": "Inventory receipt details for the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } } } }, "responses": { "200": { "description": "Ok" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/request/InventoryReceipt/{customerReferenceNumber}": { "get": { "tags": [ "InventoryReceipt" ], "summary": "Returns all Inventory Receipt Confirmations for the given reference number", "description": "Returns all Inventory Receipt Confirmations for the given reference number", "parameters": [ { "name": "customerReferenceNumber", "in": "path", "description": "Customer reference number", "required": true, "schema": { "type": "string" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/InventoryReceipt/preview": { "get": { "tags": [ "InventoryReceipt" ], "summary": "Returns all Receipt Confirmations that have not yet been sent", "description": "Returns all Receipt Confirmations that have not yet been sent if no search queries are present. Doesn't mark them as 'sent'.", "parameters": [ { "name": "min_CreatedDateTime", "in": "query", "description": "IDS WMS Local (MT) Date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "max_CreatedDateTime", "in": "query", "description": "IDS WMS Local (MT) Date - Requires min_CreatedDateTime.", "schema": { "type": "string", "format": "date-time" } }, { "name": "CustomerReferenceNumbers", "in": "query", "description": "A comma separated list of reference numbers to search for", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ReceiptTypes", "in": "query", "description": "A comma separated list of receipt types to search for\r\n\"C\" for \"Customer Receipt\", \"R\" for \"Return\"", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "The number of records to retrieve. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceipt" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/Ship": { "get": { "tags": [ "Ship" ], "summary": "Returns all Shipment Confirmations that have not yet been sent", "description": "Returns all Shipment Confirmations that have not yet been sent if no search queries are present. Marks them as 'sent'", "parameters": [ { "name": "min_ShipDate", "in": "query", "description": "IDS WMS Local (MT) Date - Truncated to day precision. Default: Last 30 Days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "max_ShipDate", "in": "query", "description": "IDS WMS Local (MT) Date - Truncated to day precision. Requires min_ShipDate.", "schema": { "type": "string", "format": "date-time" } }, { "name": "OrderStatuses", "in": "query", "description": "This filter is only applied if CustomerOrderReferenceNumbers also has value(s) \r\n\r\nA comma separated list of order statuses to filter by. Defaults to ['SH']\r\n\r\nValid Options:\r\n
SH
Shipped
ZS
Zero Shipped
CA
Cancelled
", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IncludeOrphans", "in": "query", "description": "Flag to include shipments for orders not created by the API. Default: true", "schema": { "type": "boolean" } }, { "name": "CustomerOrderReferenceNumbers", "in": "query", "description": "A comma separated list of reference numbers to search for", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "The number of records to retrieve. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Ship" ], "summary": "Processes Request to Ship", "description": "Processes a list of orders in a Request to Ship", "parameters": [ { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "requestBody": { "description": "Order details for the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestToShip" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestToShip" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestToShip" } } } }, "responses": { "200": { "description": "Ok" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/request/Ship/{customerOrderReferenceNumber}": { "get": { "tags": [ "Ship" ], "summary": "Returns all Shipment Confirmations for the given order number", "description": "Returns all Shipment Confirmations for the given order number", "parameters": [ { "name": "customerOrderReferenceNumber", "in": "path", "description": "Customer order reference number", "required": true, "schema": { "type": "string" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/Ship/preview": { "get": { "tags": [ "Ship" ], "summary": "Returns all Shipment Confirmations that have not yet been sent", "description": "Returns all Shipment Confirmations that have not yet been sent if no search queries are present. Doesn't mark them as 'sent'.", "parameters": [ { "name": "min_ShipDate", "in": "query", "description": "IDS WMS Local (MT) Date - Truncated to day precision. Default: Last 30 Days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "max_ShipDate", "in": "query", "description": "IDS WMS Local (MT) Date - Truncated to day precision. Requires min_ShipDate.", "schema": { "type": "string", "format": "date-time" } }, { "name": "OrderStatuses", "in": "query", "description": "This filter is only applied if CustomerOrderReferenceNumbers also has value(s) \r\n\r\nA comma separated list of order statuses to filter by. Defaults to ['SH']\r\n\r\nValid Options:\r\n
SH
Shipped
ZS
Zero Shipped
CA
Cancelled
", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IncludeOrphans", "in": "query", "description": "Flag to include shipments for orders not created by the API. Default: true", "schema": { "type": "boolean" } }, { "name": "CustomerOrderReferenceNumbers", "in": "query", "description": "A comma separated list of reference numbers to search for", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "DefaultLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "The number of records to retrieve. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentConfirmation" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/Ship/reset": { "post": { "tags": [ "Ship" ], "summary": "Resets Shipment Confirmations into a State where they will be available to pull or Send Again.", "parameters": [ { "name": "CustomerOrderReferenceNumbers", "in": "query", "description": "Order Numbers of the Shipment Confirmations to Attempt to Reset", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Start", "in": "query", "description": "Start of the Window of Time to Search in.\r\nDefaults to the past 60 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "End", "in": "query", "description": "End of the Window of Time to Search in", "schema": { "type": "string", "format": "date-time" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResendShipmentConfirmationResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResendShipmentConfirmationResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResendShipmentConfirmationResult" } } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/request/adjustments": { "get": { "tags": [ "StockAdjustments" ], "summary": "Returns current stock adjustments and marks them as sent", "description": "Returns current stock adjustments and marks them as sent", "parameters": [ { "name": "StockAdjustmentIDs", "in": "query", "description": "Accepts comma separated lists.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Accepts comma separated lists." } }, { "name": "StatusCodeBlacklist", "in": "query", "description": "Accepts comma separated lists.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Accepts comma separated lists." } }, { "name": "Warehouse", "in": "query", "description": "SLC1, IND1, or IND2", "required": true, "schema": { "type": "string", "description": "SLC1, IND1, or IND2" } }, { "name": "CustomerNumber", "in": "query", "description": "Your customer number.", "required": true, "schema": { "type": "string", "description": "Your customer number." } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "StockAdjustments" ], "summary": "Change the status of an item lot in the WMS", "description": "Only supports lot-based adjustment push. Specifying the quantity is not possible.", "parameters": [ { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StockAdjustment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StockAdjustment" } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StockAdjustmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StockAdjustmentResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/request/adjustments/preview": { "get": { "tags": [ "StockAdjustments" ], "summary": "Returns current stock adjustments and doesn't mark them as sent", "description": "Returns current stock adjustments and doesn't mark them as sent", "parameters": [ { "name": "StockAdjustmentIDs", "in": "query", "description": "Accepts comma separated lists.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Accepts comma separated lists." } }, { "name": "StatusCodeBlacklist", "in": "query", "description": "Accepts comma separated lists.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Accepts comma separated lists." } }, { "name": "Warehouse", "in": "query", "description": "SLC1, IND1, or IND2", "required": true, "schema": { "type": "string", "description": "SLC1, IND1, or IND2" } }, { "name": "CustomerNumber", "in": "query", "description": "Your customer number.", "required": true, "schema": { "type": "string", "description": "Your customer number." } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/adjustments/{stockAdjustmentID}": { "get": { "tags": [ "StockAdjustments" ], "summary": "Returns a single stock adjustment", "description": "Returns a single stock adjustment", "parameters": [ { "name": "stockAdjustmentID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StockAdjustments" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/StorerInventory": { "get": { "tags": [ "StorerInventory" ], "summary": "Returns current Storer Inventory", "description": "Returns current Storer Inventory", "parameters": [ { "name": "IncludeDisabledZones", "in": "query", "description": "'Y' to include Disabled Zones \r\n \r\n'N' to ignore Disabled Zones \r\n \r\nIf left blank (or any other value than 'Y' will default to 'N')", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "description": "The number of records to include in the retrieved page. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "description": "The page to retrieve. Minimum: 1", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StorerInventory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StorerInventory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StorerInventory" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/items": { "get": { "tags": [ "WmsItems" ], "summary": "Returns Wms Items for a storer", "description": "Returns all Wms Items for a storer if no search queries are present.", "parameters": [ { "name": "ItemCodes", "in": "query", "description": "A comma separated list of item codes to search for.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MinCreatedAt", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "MaxCreatedAt", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SentToWms", "in": "query", "schema": { "type": "boolean" } }, { "name": "Limit", "in": "query", "description": "Obsolete, use PageSize", "schema": { "type": "integer", "format": "int32", "deprecated": true } }, { "name": "PageSize", "in": "query", "description": "The number of records to include in the retrieved page. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "description": "The page to retrieve. Minimum: 1", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "WmsItems" ], "summary": "Processes Wms Items to send to Irms", "description": "Processes a list of Wms items in a Request to send to Irms", "parameters": [ { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "requestBody": { "description": "Wms Items for the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WmsItemsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WmsItemsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WmsItemsRequest" } } } }, "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/request/items/{itemCode}": { "get": { "tags": [ "WmsItems" ], "summary": "Returns Wms Item for a storer", "description": "Returns Wms Item for a storer if present.", "parameters": [ { "name": "itemCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WmsItemsResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/request/WmsOrderStatus": { "get": { "tags": [ "WmsOrderStatus" ], "summary": "Returns orders by status", "description": "", "parameters": [ { "name": "OrderCodes", "in": "query", "description": "A comma separated list of order codes to get statuses for", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "OrderStatuses", "in": "query", "description": "A comma separated list of order statuses to filter by.\r\nValid options: Open, Distributed, Packed, Shipped, Cancelled, Order Received, Unknown\r\nLeave empty to get all statuses", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "MinCreatedAt", "in": "query", "description": "Start date to filter by (MT)", "schema": { "type": "string", "format": "date-time" } }, { "name": "MaxCreatedAt", "in": "query", "description": "End date to filter by (MT)", "schema": { "type": "string", "format": "date-time" } }, { "name": "DefaultLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "The number of records to retrieve. Default: 100. Max: 1000.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ApiKey", "in": "header", "description": "IDS API Key", "required": true } ], "responses": { "200": { "description": "Ok", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WmsOrderStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WmsOrderStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WmsOrderStatusResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "AddressClassification": { "enum": [ "U", "R", "C", "M" ], "type": "string", "description": "

Members:

" }, "InventoryReceipt": { "type": "object", "properties": { "Tallies": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTally" }, "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTally": { "type": "object", "properties": { "TallyConfirmationID": { "type": "string", "format": "uuid" }, "CustomerReferenceNumber": { "type": "string", "nullable": true }, "ReceiptDate": { "type": "string", "nullable": true }, "TallyInvoiceNumber": { "type": "string", "nullable": true }, "ReceivedfromCode": { "type": "string", "nullable": true }, "BillOfLadingNumber": { "type": "string", "nullable": true }, "MasterBillOfLading": { "type": "string", "nullable": true }, "BillToCustomerNumber": { "type": "string", "nullable": true }, "BillToCustomerNumberSuffix": { "type": "string", "nullable": true }, "BillToCustomerNumberSuffix2": { "type": "string", "nullable": true }, "ActualArrivalDate": { "type": "string", "nullable": true }, "ActualArrivalTime": { "type": "string", "nullable": true }, "ReceiptType": { "type": "string", "nullable": true }, "SpecialCharges": { "type": "string", "nullable": true }, "UnloadingStartTime": { "type": "string", "nullable": true }, "UnloadingStopTime": { "type": "string", "nullable": true }, "AppointmentContactName": { "type": "string", "nullable": true }, "AppointmentContactDate": { "type": "string", "nullable": true }, "AppointmentContactTime": { "type": "string", "nullable": true }, "NotificationContact": { "type": "string", "nullable": true }, "NotificationContactDate": { "type": "string", "nullable": true }, "NotificationContactTime": { "type": "string", "nullable": true }, "ProductReturned": { "type": "string", "nullable": true }, "ReturnAuthorizationNumber": { "type": "string", "nullable": true }, "LoadType": { "type": "string", "nullable": true }, "CarrierSCAC": { "type": "string", "nullable": true }, "SealNumber": { "type": "string", "nullable": true }, "SealBroken": { "type": "string", "nullable": true }, "SecondSealNumber": { "type": "string", "nullable": true }, "SecondSealBroken": { "type": "string", "nullable": true }, "CarrierNumber": { "type": "string", "nullable": true }, "ScheduledArrivalDate": { "type": "string", "nullable": true }, "ScheduledArrivalTime": { "type": "string", "nullable": true }, "ManualInvoiceNumber": { "type": "string", "nullable": true }, "InvoiceDate": { "type": "string", "nullable": true }, "ChargeType": { "type": "string", "nullable": true }, "CarrierIdentificationNumber": { "type": "string", "nullable": true }, "UnloadingEmployeeNumber": { "type": "string", "nullable": true }, "TotalWeight": { "type": "string", "nullable": true }, "ReceivingCompanyName": { "type": "string", "nullable": true }, "ReceivingCompanyAddressLine1": { "type": "string", "nullable": true }, "ReceivingCompanyAddressLine2": { "type": "string", "nullable": true }, "ReceivingCompanyAddressLine3": { "type": "string", "nullable": true }, "ReceivingCompanyAddressLine4": { "type": "string", "nullable": true }, "ReceivingCompanyAddressZip": { "type": "string", "nullable": true }, "ReceivingCompanyAddressZipSuffix": { "type": "string", "nullable": true }, "ReceivingCompanyAddressCity": { "type": "string", "nullable": true }, "ReceivingCompanyAddressState": { "type": "string", "nullable": true }, "ConsigneeLotMethod": { "type": "string", "nullable": true }, "TallyExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyExtraDataField" }, "nullable": true }, "TallyComments": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyComment" }, "nullable": true }, "TallySerials": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallySerial" }, "nullable": true }, "TallyDetails": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyDetail" }, "nullable": true }, "TallyLotDetails": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyLotDetail" }, "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyComment": { "type": "object", "properties": { "PrintSequence": { "type": "string", "nullable": true }, "CommentText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyDetail": { "type": "object", "properties": { "Sequence": { "type": "string", "nullable": true }, "ItemCode": { "type": "string", "nullable": true }, "LotCode1": { "type": "string", "nullable": true }, "LotCode2": { "type": "string", "nullable": true }, "LotCode3": { "type": "string", "nullable": true }, "WINSReasonCode": { "type": "string", "nullable": true }, "QuantityReceived": { "type": "string", "nullable": true }, "QuantityOver": { "type": "string", "nullable": true }, "QuantityShort": { "type": "string", "nullable": true }, "QuantityDamaged": { "type": "string", "nullable": true }, "QuantityHeld": { "type": "string", "nullable": true }, "QuantityAvailable": { "type": "string", "nullable": true }, "QuantityInTransit": { "type": "string", "nullable": true }, "QuantityBucket1": { "type": "string", "nullable": true }, "QuantityBucket2": { "type": "string", "nullable": true }, "QuantityBucket3": { "type": "string", "nullable": true }, "QuantityBucket4": { "type": "string", "nullable": true }, "UnitOfMeasure": { "type": "string", "nullable": true }, "WeightType": { "type": "string", "nullable": true }, "TotalNetWeight": { "type": "string", "nullable": true }, "TotalGrossWeight": { "type": "string", "nullable": true }, "TotalHandlingAmount": { "type": "string", "nullable": true }, "TotalStorageAmount": { "type": "string", "nullable": true }, "HandlingRateType": { "type": "string", "nullable": true }, "FloorWarehouseLocation": { "type": "string", "nullable": true }, "AisleWarehouseLocation": { "type": "string", "nullable": true }, "SlotWarehouseLocation": { "type": "string", "nullable": true }, "TallyDetailExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyDetailExtraDataField" }, "nullable": true }, "TallyDetailComments": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyDetailComment" }, "nullable": true }, "TallyDetailSerials": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptTallyDetailSerial" }, "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyDetailComment": { "type": "object", "properties": { "PrintSequence": { "type": "string", "nullable": true }, "CommentText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyDetailExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyDetailSerial": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true }, "OriginalSerialQuantity": { "type": "string", "nullable": true }, "SerialQuantity": { "type": "string", "nullable": true }, "UnitWeight": { "type": "string", "nullable": true }, "EachQuantity": { "type": "string", "nullable": true }, "EachWeight": { "type": "string", "nullable": true }, "SerialStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallyLotDetail": { "type": "object", "properties": { "ItemCode": { "type": "string", "nullable": true }, "LotCode1": { "type": "string", "nullable": true }, "LotCode2": { "type": "string", "nullable": true }, "LotCode3": { "type": "string", "nullable": true }, "LotUnitWeight": { "type": "string", "nullable": true }, "LotCodeLastShipped": { "type": "string", "nullable": true }, "LotCodeExpirationDate": { "type": "string", "nullable": true }, "LotCodeHeld": { "type": "string", "nullable": true }, "LotCodeReleased": { "type": "string", "nullable": true }, "LotCodeReceived": { "type": "string", "nullable": true }, "LotCodeStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryReceiptTallySerial": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true }, "SerialQuantityInTransit": { "type": "string", "nullable": true }, "SerialQuantityReceived": { "type": "string", "nullable": true }, "SerialReceivingWarehouseFloorLocation": { "type": "string", "nullable": true }, "SerialReceivingWarehouseAisleLocation": { "type": "string", "nullable": true }, "SerialReceivingWarehouseSlotLocation": { "type": "string", "nullable": true }, "SerialStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InventoryStatusCode": { "enum": [ "A", "BR", "CR", "DA", "DO", "EX", "H", "HD", "LK", "MP", "PG", "PK", "Q", "RC", "SA", "SH", "ST", "TH", "U", "W", "WD" ], "type": "string", "description": "IRMS Inventory Status Codes

Members:

" }, "RequestToShip": { "type": "object", "properties": { "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrder" }, "nullable": true } }, "additionalProperties": false }, "RequestToShipAddress": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Company": { "type": "string", "description": "Secondary Name - company/attn/contact. \"contact\" in IRMS.", "nullable": true }, "AddressLine1": { "type": "string", "nullable": true }, "AddressLine2": { "type": "string", "nullable": true }, "AddressLine3": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "State": { "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "CountryCode": { "type": "string", "nullable": true }, "Classification": { "$ref": "#/components/schemas/AddressClassification" }, "ExternalID": { "type": "string", "nullable": true }, "ExternalType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipEvent": { "type": "object", "properties": { "DataElementCode": { "type": "string", "nullable": true }, "StatusCode": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipOrder": { "type": "object", "properties": { "CustomerOrderReferenceNumber": { "type": "string", "nullable": true }, "ConsigneeCode": { "type": "string", "nullable": true }, "ConsigneePONumber": { "type": "string", "nullable": true }, "ZoneCode": { "type": "string", "nullable": true }, "CZone": { "type": "string", "nullable": true }, "ScheduledShipDate": { "type": "string", "nullable": true }, "ScheduledShipTime": { "type": "string", "nullable": true }, "ScheduledArrivalDate": { "type": "string", "nullable": true }, "CarrierCode": { "type": "string", "nullable": true }, "ShipType": { "type": "string", "nullable": true }, "BrokerName": { "type": "string", "nullable": true }, "FreightChargeCode": { "type": "string", "nullable": true }, "COD": { "type": "string", "nullable": true }, "ProNumber": { "type": "string", "nullable": true }, "F856": { "type": "string", "nullable": true }, "F128": { "type": "string", "nullable": true }, "ConsolidationLoadNumber": { "type": "string", "nullable": true }, "ConsolidationStopNumber": { "type": "string", "nullable": true }, "ThirdPartyAccount": { "type": "string", "nullable": true }, "PackingInstructions": { "type": "string", "nullable": true }, "POs": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipPO" }, "nullable": true }, "Events": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipEvent" }, "nullable": true }, "OrderExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrderExtraDataField" }, "nullable": true }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrderItem" }, "nullable": true }, "BillToAddress": { "$ref": "#/components/schemas/RequestToShipAddress" }, "ShipToAddress": { "$ref": "#/components/schemas/RequestToShipAddress" }, "ThreePAddress": { "$ref": "#/components/schemas/RequestToShipAddress" }, "ShipFromAddress": { "$ref": "#/components/schemas/RequestToShipAddress" }, "OrderComments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrderComment" }, "nullable": true }, "RetryCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RequestToShipOrderComment": { "type": "object", "properties": { "PrintSequence": { "type": "string", "nullable": true }, "EDISegmentID": { "type": "string", "nullable": true }, "Qual": { "type": "string", "nullable": true }, "CommentText": { "type": "string", "nullable": true }, "PrintLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipOrderExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipOrderItem": { "type": "object", "properties": { "LineNumber": { "type": "string", "nullable": true }, "WMSLineNumber": { "type": "integer", "format": "int32", "nullable": true }, "ShipFromBucket": { "type": "string", "nullable": true }, "QuantityOrdered": { "type": "integer", "format": "int32", "nullable": true }, "QuantityShipped": { "type": "integer", "format": "int32", "nullable": true }, "SKU": { "type": "string", "nullable": true }, "LotCode1": { "type": "string", "nullable": true }, "LotCode2": { "type": "string", "nullable": true }, "LotCode3": { "type": "string", "nullable": true }, "OrderItemComments": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrderItemComment" }, "nullable": true }, "OrderItemExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/RequestToShipOrderItemExtraDataField" }, "nullable": true } }, "additionalProperties": false }, "RequestToShipOrderItemComment": { "type": "object", "properties": { "PrintSequence": { "type": "string", "nullable": true }, "EDISegmentID": { "type": "string", "nullable": true }, "Qual": { "type": "string", "nullable": true }, "CommentText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipOrderItemExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequestToShipPO": { "type": "object", "properties": { "PONumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResendShipmentConfirmationResult": { "type": "object", "properties": { "CustomerOrderReferenceNumber": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmation": { "type": "object", "properties": { "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationOrder" }, "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationEvent": { "type": "object", "properties": { "DataElementCode": { "type": "string", "nullable": true }, "StatusCode": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationOrder": { "type": "object", "properties": { "OrderStatus": { "type": "string", "nullable": true }, "CustomerOrderReferenceNumber": { "type": "string", "nullable": true }, "WarehouseOrderReferenceNumber": { "type": "string", "nullable": true }, "WarehouseOrderSuffix": { "type": "string", "nullable": true }, "ShipDate": { "type": "string", "nullable": true }, "ShippedFrom": { "type": "string", "nullable": true }, "CarrierCode": { "type": "string", "nullable": true }, "CustomerCarrierCode": { "type": "string", "nullable": true }, "ShipType": { "type": "string", "nullable": true }, "BrokerName": { "type": "string", "nullable": true }, "FreightChargeCode": { "type": "string", "nullable": true }, "ProNumber": { "type": "string", "nullable": true }, "ConsolidationLoadNumber": { "type": "string", "nullable": true }, "ConsolidationStopNumber": { "type": "string", "nullable": true }, "GrossWeight": { "type": "number", "format": "double", "nullable": true }, "Volume": { "type": "number", "format": "double", "nullable": true }, "HazardousMaterials": { "type": "string", "nullable": true }, "TrailerNum": { "type": "string", "nullable": true }, "Seal1": { "type": "string", "nullable": true }, "Seal2": { "type": "string", "nullable": true }, "ManifestNum": { "type": "string", "nullable": true }, "MasterBillOfLading": { "type": "string", "nullable": true }, "MasterRefNum": { "type": "string", "nullable": true }, "LinkNum": { "type": "string", "nullable": true }, "POs": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationPO" }, "nullable": true }, "Events": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationEvent" }, "nullable": true }, "OrderExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationOrderExtraDataField" }, "nullable": true }, "OrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationOrderItem" }, "nullable": true }, "Packages": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationPackage" }, "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationOrderExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationOrderItem": { "type": "object", "properties": { "LineStatus": { "type": "string", "nullable": true }, "LineNumber": { "type": "string", "nullable": true }, "WMSLineNumber": { "type": "integer", "format": "int32", "nullable": true }, "ShipFromBucket": { "type": "string", "nullable": true }, "QuantityOrdered": { "type": "integer", "format": "int32", "nullable": true }, "QuantityShipped": { "type": "integer", "format": "int32", "nullable": true }, "SKU": { "type": "string", "nullable": true }, "LotCode1": { "type": "string", "nullable": true }, "LotCode2": { "type": "string", "nullable": true }, "LotCode3": { "type": "string", "nullable": true }, "HazardousMaterials": { "type": "string", "nullable": true }, "PackageNumber": { "type": "string", "nullable": true }, "UCC128": { "type": "string", "nullable": true }, "LPN": { "type": "string", "nullable": true }, "OrderItemExtraDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentConfirmationOrderItemExtraDataField" }, "nullable": true }, "ShipmentSKU": { "type": "string", "nullable": true }, "ShipmentQuantityOrdered": { "type": "integer", "format": "int32", "nullable": true }, "ShipmentUOM": { "type": "string", "nullable": true }, "GrossWeight": { "type": "number", "format": "double", "nullable": true }, "Volume": { "type": "number", "format": "double", "nullable": true }, "UPC": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Description2": { "type": "string", "nullable": true }, "CrossItemCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationOrderItemExtraDataField": { "type": "object", "properties": { "ExtraDataFieldLabel": { "type": "string", "nullable": true }, "ExtraDataFieldValue": { "type": "string", "nullable": true }, "ExtraDataFieldLength": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationPO": { "type": "object", "properties": { "PONumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentConfirmationPackage": { "type": "object", "properties": { "PackageNumber": { "type": "string", "nullable": true }, "Items": { "type": "integer", "format": "int32", "nullable": true }, "Quantity": { "type": "integer", "format": "int32", "nullable": true }, "Weight": { "type": "number", "format": "double", "nullable": true }, "Height": { "type": "number", "format": "double", "nullable": true }, "Width": { "type": "number", "format": "double", "nullable": true }, "Depth": { "type": "number", "format": "double", "nullable": true }, "FreightCharge": { "type": "number", "format": "double", "nullable": true }, "ShippingCost": { "type": "string", "nullable": true }, "TrackingUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StockAdjustment": { "required": [ "ItemCode", "LotCode", "Status" ], "type": "object", "properties": { "ItemCode": { "maxLength": 24, "minLength": 1, "type": "string", "description": "The SKU" }, "LotCode": { "maxLength": 24, "minLength": 1, "type": "string", "description": "The lot code" }, "Status": { "$ref": "#/components/schemas/InventoryStatusCode" } }, "additionalProperties": false, "description": "A lot-based WMS stock adjustment. Quantity not supported." }, "StockAdjustmentDto": { "type": "object", "properties": { "StockAdjustmentID": { "type": "string", "format": "uuid" }, "AdjustmentCode": { "type": "string", "nullable": true }, "AdjustmentCodeDescription": { "type": "string", "nullable": true }, "Company": { "type": "string", "nullable": true }, "CompanyLocationTypeDescription": { "type": "string", "nullable": true }, "Custom1": { "type": "string", "nullable": true }, "Custom2": { "type": "string", "nullable": true }, "Custom3": { "type": "string", "nullable": true }, "Custom4": { "type": "string", "nullable": true }, "Custom5": { "type": "string", "nullable": true }, "CustomerCode": { "type": "string", "nullable": true }, "DispCode": { "type": "string", "nullable": true }, "DispCodeDescription": { "type": "string", "nullable": true }, "Item": { "type": "string", "nullable": true }, "ItemType": { "type": "string", "nullable": true }, "ItemUpcNumber1": { "type": "string", "nullable": true }, "ItemUpcNumber2": { "type": "string", "nullable": true }, "Location": { "type": "string", "nullable": true }, "LotExpiration": { "type": "string", "format": "date-time", "nullable": true }, "Lot": { "type": "string", "nullable": true }, "ManufacturerDate": { "type": "string", "format": "date-time", "nullable": true }, "Memo": { "type": "string", "nullable": true }, "OrderCode": { "type": "string", "nullable": true }, "Pool": { "type": "string", "nullable": true }, "QuantityAfter": { "type": "integer", "format": "int32", "nullable": true }, "QuantityBefore": { "type": "integer", "format": "int32", "nullable": true }, "AdjustmentQuantity": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "RecId": { "type": "string", "nullable": true }, "ResultCode": { "type": "string", "nullable": true }, "ResultMessage": { "type": "string", "nullable": true }, "ResultMsg": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "StatusAfter": { "type": "string", "nullable": true }, "StatusBefore": { "type": "string", "nullable": true }, "TransId": { "type": "integer", "format": "int32", "nullable": true }, "Transmission": { "type": "integer", "format": "int32", "nullable": true }, "Uom": { "type": "string", "nullable": true }, "VendorCode": { "type": "string", "nullable": true }, "VendorItemCode": { "type": "string", "nullable": true }, "Version": { "type": "string", "nullable": true }, "Warehouse": { "type": "string", "nullable": true }, "WarehouseDescription": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "StockAdjustmentResponse": { "required": [ "ItemCode", "LotCode", "Status" ], "type": "object", "properties": { "ItemCode": { "maxLength": 24, "minLength": 1, "type": "string", "description": "The SKU" }, "LotCode": { "maxLength": 24, "minLength": 1, "type": "string", "description": "The lot code" }, "Status": { "$ref": "#/components/schemas/InventoryStatusCode" }, "SentToWmsStatus": { "type": "boolean", "description": "true/false - Was the adjustment successful", "nullable": true, "readOnly": true }, "Message": { "type": "string", "description": "\"Good Record\" on success, or the relevant error message", "nullable": true, "readOnly": true }, "Content": { "type": "string", "description": "HTTP Post Response Content", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "The original Stock Adjustment with the WMS response" }, "StockAdjustments": { "type": "object", "properties": { "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/StockAdjustmentDto" }, "nullable": true } }, "additionalProperties": false }, "StorerInventory": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/StorerInventoryItem" }, "nullable": true } }, "additionalProperties": false }, "StorerInventoryItem": { "type": "object", "properties": { "ItemCode": { "type": "string", "description": "The SKU associated with this Inventory Item", "nullable": true }, "ItemName": { "type": "string", "description": "Human Friendly name of this Inventory Item", "nullable": true }, "ItemDescription1": { "type": "string", "nullable": true }, "ItemDescription2": { "type": "string", "nullable": true }, "WeightDesignation": { "type": "string", "nullable": true }, "TotalGrossWeight": { "type": "string", "nullable": true }, "UnitCubicFeet": { "type": "string", "nullable": true }, "MaterialHandlingCode1": { "type": "string", "nullable": true }, "MaterialHandlingCode2": { "type": "string", "nullable": true }, "MaterialHandlingCode3": { "type": "string", "nullable": true }, "InventoryUnitofMeasure": { "type": "string", "nullable": true }, "ItemUPCCode": { "type": "string", "nullable": true }, "ItemUPCTailCode": { "type": "string", "nullable": true }, "ItemCrossItemCode": { "type": "string", "nullable": true }, "ItemDetails": { "type": "array", "items": { "$ref": "#/components/schemas/StorerInventoryItemDetail" }, "nullable": true } }, "additionalProperties": false }, "StorerInventoryItemDetail": { "type": "object", "properties": { "LotCode1": { "type": "string", "description": "Lot Code Inventory is assigned to", "nullable": true }, "LotCode2": { "type": "string", "description": "Field That exists from the WDLS System. Commonly used as an extra date field\r\n(Examples: Expiration Date, Shelf Date, Relevant Quarter)", "nullable": true }, "LotCode3": { "type": "string", "description": "Obsolete field carried over from WDLS", "nullable": true }, "QuantityOnHand": { "type": "string", "description": "Quantity in IRMS with a Status of \"Available\"", "nullable": true }, "QuantityHeld": { "type": "string", "description": "Quantity in IRMS with Statuses of:\r\n\"Donation\",\"Expired\",\"Hold\",\"Hold2\",\"Missing Parts\",\"QA Hold\",\"Recalled\",\"TABcomHold\",\"Unavailable\"", "nullable": true }, "QuantityCommitted": { "type": "string", "description": "Quantity in IRMS with Statuses of:\r\n\"Packed\",\"Picked\",\"SoftAllocated\",\"Shipped\",\"Staged\",\"Work In Process\"", "nullable": true }, "QuantityFutureAllocated": { "type": "string", "nullable": true }, "QuantityDamaged": { "type": "string", "description": "Quantity in IRMS with Statuses of:\r\n\"Broken Bottle\",\"Carrier Damage\",\"Damaged\",\"Leaking\",\"Warehouse Damage\"", "nullable": true }, "QuantityShipped": { "type": "string", "nullable": true }, "QuantityInTransit": { "type": "string", "nullable": true }, "QuantityUser1": { "type": "string", "nullable": true }, "QuantityUser2": { "type": "string", "nullable": true }, "QuantityUser3": { "type": "string", "nullable": true }, "QuantityUser4": { "type": "string", "nullable": true }, "Warehouse": { "type": "string", "nullable": true }, "ItemDetailSerials": { "type": "array", "items": { "$ref": "#/components/schemas/StorerInventoryItemDetailSerial" }, "nullable": true } }, "additionalProperties": false }, "StorerInventoryItemDetailSerial": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true }, "OriginalSerialQuantity": { "type": "string", "nullable": true }, "SerialQuantity": { "type": "string", "nullable": true }, "UnitWeight": { "type": "string", "nullable": true }, "EachQuantity": { "type": "string", "nullable": true }, "EachWeight": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WmsItemSummary": { "required": [ "Active", "Cartonize", "CustomerItem", "EcoFriendly", "ItemCode", "ItemDescription", "ItemTypeCode", "LotFlag", "TransactionType" ], "type": "object", "properties": { "DepartmentCode": { "maxLength": 4, "type": "string", "nullable": true }, "TransactionType": { "maxLength": 1, "minLength": 1, "type": "string", "description": "A|C|D" }, "ItemCode": { "maxLength": 24, "minLength": 1, "type": "string" }, "ItemDescription": { "maxLength": 30, "minLength": 1, "type": "string" }, "ItemGroupCode": { "maxLength": 4, "type": "string", "nullable": true }, "ItemGroupLineCode": { "maxLength": 4, "type": "string", "nullable": true }, "ItemGroupSubLineCode": { "maxLength": 4, "type": "string", "nullable": true }, "UpcNumber": { "maxLength": 24, "type": "string", "nullable": true }, "UomCode": { "maxLength": 4, "type": "string", "nullable": true }, "CaseQuantity": { "type": "integer", "format": "int32", "nullable": true }, "PalletQuantity": { "type": "integer", "format": "int32", "nullable": true }, "MaximumQuantity": { "type": "number", "description": "decimal(9,2)", "format": "double" }, "MiminumQuantity": { "type": "number", "description": "decimal(9,2)", "format": "double" }, "StratificationCode": { "maxLength": 1, "type": "string", "nullable": true }, "ItemTypeCode": { "maxLength": 1, "minLength": 1, "type": "string", "description": "S|N|C" }, "SerialFlag": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "SerialOutbound": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "SerialInbound": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "LotFlag": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Y|N" }, "KitFlag": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "ShelfLifeFlag": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "ShelfLife": { "type": "integer", "format": "int32", "nullable": true }, "ExpirationFrom": { "maxLength": 1, "type": "string", "description": "R|M", "nullable": true }, "RcvThreshold": { "type": "integer", "format": "int32", "nullable": true }, "ShpThreshold": { "type": "integer", "format": "int32", "nullable": true }, "UnavailableAt": { "maxLength": 1, "type": "string", "description": "E|S", "nullable": true }, "Length": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "Height": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "Width": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "decimal(9,2)", "format": "double", "nullable": true }, "Weight": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "ItemCost": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "SellPrice": { "type": "number", "description": "decimal(6,2)", "format": "double", "nullable": true }, "SelfShip": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "QualityInspection": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "FreightClass": { "maxLength": 10, "type": "string", "nullable": true }, "Active": { "maxLength": 1, "minLength": 1, "type": "string", "description": "A|I" }, "ItemLongDescription": { "maxLength": 200, "type": "string", "nullable": true }, "CountryCode": { "maxLength": 10, "type": "string", "nullable": true }, "SerialType": { "maxLength": 1, "type": "string", "description": "U|S", "nullable": true }, "MsrpValue": { "type": "number", "description": "decimal(11,2)", "format": "double", "nullable": true }, "HarmonizedCode": { "maxLength": 10, "type": "string", "nullable": true }, "GtinNumber": { "maxLength": 14, "type": "string", "nullable": true }, "Hazardous": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "DimensionalUom": { "maxLength": 50, "type": "string", "nullable": true }, "LongDescription": { "maxLength": 4000, "type": "string", "nullable": true }, "WeightUom": { "maxLength": 20, "type": "string", "nullable": true }, "BrandCode": { "maxLength": 100, "type": "string", "nullable": true }, "YearCode": { "type": "integer", "format": "int32", "nullable": true }, "ColorCodeCode": { "maxLength": 20, "type": "string", "nullable": true }, "ColorDescription": { "maxLength": 100, "type": "string", "nullable": true }, "StyleCode": { "maxLength": 20, "type": "string", "nullable": true }, "StyleDescription": { "maxLength": 100, "type": "string", "nullable": true }, "SizeDescription": { "maxLength": 100, "type": "string", "nullable": true }, "SeasonCode": { "maxLength": 20, "type": "string", "nullable": true }, "DivisionCode": { "maxLength": 20, "type": "string", "nullable": true }, "DivisionDescription": { "maxLength": 100, "type": "string", "nullable": true }, "BodyCode": { "maxLength": 20, "type": "string", "nullable": true }, "BodyDescription": { "maxLength": 100, "type": "string", "nullable": true }, "SizScale": { "maxLength": 20, "type": "string", "nullable": true }, "ContentDescription": { "maxLength": 100, "type": "string", "nullable": true }, "ItemVerification": { "maxLength": 1, "type": "string", "description": "Y|N", "nullable": true }, "EcoFriendly": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Y|N" }, "Cartonize": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Y|N" }, "EanCode": { "maxLength": 50, "type": "string", "nullable": true }, "EpcCode": { "maxLength": 50, "type": "string", "nullable": true }, "ManufacturerCode": { "maxLength": 50, "type": "string", "nullable": true }, "FinishCode": { "maxLength": 50, "type": "string", "nullable": true }, "ColorCode": { "maxLength": 50, "type": "string", "nullable": true }, "CustomerItem": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Y|N" }, "HazmatLabel": { "maxLength": 10, "type": "string", "nullable": true }, "HazmatClass": { "maxLength": 200, "type": "string", "nullable": true }, "HazmatDescription": { "maxLength": 100, "type": "string", "nullable": true }, "HazmatEmergencyContact": { "maxLength": 100, "type": "string", "nullable": true }, "HazmatEmergencyPhone": { "maxLength": 10, "type": "string", "nullable": true }, "HazmatId": { "maxLength": 10, "type": "string", "nullable": true }, "HazmatPacking": { "maxLength": 200, "type": "string", "nullable": true }, "HazmatPercentage": { "type": "number", "description": "decimal(6,3)", "format": "double", "nullable": true }, "HazmatQuantity": { "type": "number", "description": "decimal(9,3)", "format": "double", "nullable": true }, "HazmatUom": { "maxLength": 20, "type": "string", "nullable": true }, "ReceivedStatus": { "type": "boolean", "readOnly": true }, "SentToWmsStatus": { "type": "boolean", "readOnly": true }, "Message": { "type": "string", "nullable": true, "readOnly": true }, "ImageRef": { "type": "string", "nullable": true }, "ImageRefSent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "WmsItemsRequest": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/WmsItemSummary" }, "nullable": true } }, "additionalProperties": false }, "WmsItemsResponse": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/WmsItemSummary" }, "nullable": true } }, "additionalProperties": false }, "WmsOrderStatus": { "type": "object", "properties": { "CustomerCode": { "type": "string", "nullable": true }, "OrderCode": { "type": "string", "nullable": true }, "CustomerPo": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time", "nullable": true }, "OrderStatus": { "type": "string", "nullable": true }, "StatusAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WmsOrderStatusResponse": { "type": "object", "properties": { "WmsOrderStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/WmsOrderStatus" }, "nullable": true } }, "additionalProperties": false } } }, "tags": [ { "name": "InventoryReceipt" }, { "name": "Ship" }, { "name": "StockAdjustments" }, { "name": "StorerInventory" }, { "name": "WmsItems" }, { "name": "WmsOrderStatus" } ] }