{
"openapi": "3.0.1",
"info": {
"title": "Skublox API",
"version": "v1"
},
"servers": [
{
"url": "/lightwall"
}
],
"paths": {
"/amazon-transparency-code": {
"get": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "ListAmazonTransparencyCodes",
"parameters": [
{
"name": "transparencyCode",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "orderId",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "productId",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
}
}
}
}
},
"post": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "InsertAmazonTransparencyCode",
"parameters": [
{
"name": "preferredKitParentProductId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAmazonTransparencyCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAmazonTransparencyCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateAmazonTransparencyCodeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
}
}
}
}
},
"/amazon-transparency-code/orders/{orderId}": {
"get": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "ListAmazonTransparencyCodesForOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AmazonTransparencyCode"
}
}
}
}
}
}
},
"delete": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "DeleteAllAmazonTransparencyCodesForOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/amazon-transparency-code/orders/{orderId}/products/required/{sku}": {
"get": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "OrderProductRequiresAmazonTransparencyCode",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sku",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/amazon-transparency-code/orders/{orderId}/products/required": {
"get": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "ListProductsThatRequireAmazonTransparencyCodesForOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderForAmazonTransparencyCodeSummary"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderForAmazonTransparencyCodeSummary"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderForAmazonTransparencyCodeSummary"
}
}
}
}
}
}
}
},
"/amazon-transparency-code/orders/{orderId}/codes/{code}": {
"delete": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "DeleteAmazonTransparencyCodeForOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/amazon-transparency-code/orders/{orderId}/products/{sku}": {
"delete": {
"tags": [
"AmazonTransparencyCode"
],
"operationId": "DeleteAllAmazonTransparencyCodesForSkuInOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sku",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/audit-logs": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListAuditLogs",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "orderId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "crc",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "barcode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "errors",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
},
{
"name": "licensePlates",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/sort-boxes/{crc}": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListAuditLogsBySortBoxAndOrderSort",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orderSortId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "licensePlates",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/sort-boxes": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListSortBoxAuditLogs",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "sortBoxCrc",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "picklistId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "orderId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "orderSortId",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "licensePlates",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxAuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxAuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxAuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/sort-box-items": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListSortBoxItemAuditLogs",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "sortBoxCrc",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "picklistId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "orderId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "orderSortId",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "barcode",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItemAuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItemAuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItemAuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/sessions": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListUserSessionsAuditLogs",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "picklistId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSessionAuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSessionAuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSessionAuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/walls": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "ListWallAuditLogs",
"parameters": [
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallAuditLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallAuditLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallAuditLog"
}
}
}
}
}
}
}
},
"/audit-logs/initial-timestamp": {
"get": {
"tags": [
"AuditLog"
],
"operationId": "GetInitialWallAuditLogTimestamp",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "date"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date"
}
}
}
}
}
}
},
"/auto-login/{team}/skustack-web-portal": {
"get": {
"tags": [
"AutoLogin"
],
"operationId": "ConstructSkustackWebPortalAutoLoginLink",
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/auto-login/{team}/skublox-hub": {
"get": {
"tags": [
"AutoLogin"
],
"operationId": "ConstructSkubloxHubAutoLoginLink",
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/auto-login/{team}/skublox-sorter": {
"get": {
"tags": [
"AutoLogin"
],
"operationId": "ConstructSkubloxSorterAutoLoginLink",
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/auto-login/{team}/skustack-lens": {
"get": {
"tags": [
"AutoLogin"
],
"operationId": "ConstructSkustackLensAutoLoginLink",
"parameters": [
{
"name": "team",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/employees/{id}": {
"get": {
"tags": [
"Employees"
],
"operationId": "GetEmployee",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
}
},
"/employees/by-email/{email}": {
"get": {
"tags": [
"Employees"
],
"operationId": "GetEmployeeByEmail",
"parameters": [
{
"name": "email",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
}
},
"/employees/me": {
"get": {
"tags": [
"Employees"
],
"operationId": "GetAuthenticatedEmployee",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
}
},
"/list-sortbox-displays": {
"get": {
"tags": [
"FlowDirection"
],
"operationId": "ListSortBoxDisplays",
"parameters": [
{
"name": "sortBoxes",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "segmentRows",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "segmentColumns",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "flowDirection",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/FlowDirection"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxDisplay"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxDisplay"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxDisplay"
}
}
}
}
}
}
}
},
"/geo/by-ip": {
"get": {
"tags": [
"Geo"
],
"operationId": "GetLocationByIp",
"parameters": [
{
"name": "ip",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
}
}
}
}
}
},
"/geo/by-ip/implicit": {
"get": {
"tags": [
"Geo"
],
"operationId": "GetLocationByImplicitIp",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
}
}
}
}
}
},
"/geo/by-wall-id": {
"get": {
"tags": [
"Geo"
],
"operationId": "GetLocationByWallId",
"parameters": [
{
"name": "wallId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GeoLocation"
}
}
}
}
}
}
},
"/insights/stats": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetSortingStatistics",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "products",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortingStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortingStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortingStats"
}
}
}
}
}
}
},
"/insights/daily/orders": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetDailyOrderSortingStats",
"parameters": [
{
"name": "date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
}
}
}
}
}
},
"/insights/daily/units": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetDailyUnitSortingStats",
"parameters": [
{
"name": "date",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DailySortingStats"
}
}
}
}
}
}
},
"/insights/orders/sorted": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetOrderSortingStatsForDateRange",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
}
}
}
}
}
},
"/insights/units/sorted": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetUnitSortingStatsForDateRange",
"parameters": [
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "userId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "wallId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeSortingStats"
}
}
}
}
}
}
},
"/insights/walls/{id}/scanned": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetWallBarcodeScanningStatsForDateRange",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStats"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStats"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStats"
}
}
}
}
}
}
},
"/insights/walls/{id}/per-slot/confirmed": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetWallBarcodeConfirmationStatsPerSlotForDateRange",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeConfirmationStatsPerSlot"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeConfirmationStatsPerSlot"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeConfirmationStatsPerSlot"
}
}
}
}
}
}
},
"/insights/walls/{id}/per-slot/scanned": {
"get": {
"tags": [
"Insights"
],
"operationId": "GetWallBarcodeScanningStatsPerSlotForDateRange",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "from",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStatsPerSlot"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStatsPerSlot"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallBarcodeScanningStatsPerSlot"
}
}
}
}
}
}
},
"/license-plates/{crc}/zpl": {
"post": {
"tags": [
"LicensePlates"
],
"operationId": "GenerateZplLicensePlateForCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/license-plates/{crc}/pdf": {
"post": {
"tags": [
"LicensePlates"
],
"operationId": "GeneratePdfLicensePlateForCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/license-plates/orders/{id}/zpl": {
"post": {
"tags": [
"LicensePlates"
],
"operationId": "GenerateZplLicensePlateForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/license-plates/orders/{id}/pdf": {
"post": {
"tags": [
"LicensePlates"
],
"operationId": "GeneratePdfLicensePlateForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/orders/unshipped": {
"get": {
"tags": [
"Orders"
],
"operationId": "ListUnshippedOrders",
"parameters": [
{
"name": "bins",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "empty",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "allowDropShip",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
},
{
"name": "workflow",
"in": "query",
"schema": {
"$ref": "#/components/schemas/WallWorkflow"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
}
},
"/orders/unshipped/ids": {
"get": {
"tags": [
"Orders"
],
"operationId": "ListUnshippedOrderIds",
"parameters": [
{
"name": "bins",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "empty",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "allowDropShip",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
},
{
"name": "workflow",
"in": "query",
"schema": {
"$ref": "#/components/schemas/WallWorkflow"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
},
"/orders/unshipped/products": {
"get": {
"tags": [
"Orders"
],
"operationId": "ListUnshippedOrdersProductsSummary",
"parameters": [
{
"name": "bins",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "empty",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "allowDropShip",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
},
{
"name": "workflow",
"in": "query",
"schema": {
"$ref": "#/components/schemas/WallWorkflow"
}
},
{
"name": "breakdown",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "inventory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
}
}
}
}
}
},
"/orders/by-license-plate/{barcode}": {
"get": {
"tags": [
"Orders"
],
"operationId": "GetOrderByLicensePlateBarcode",
"parameters": [
{
"name": "barcode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
},
"/orders/{id}": {
"get": {
"tags": [
"Orders"
],
"operationId": "GetOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
},
"/orders/{id}/products": {
"get": {
"tags": [
"Orders"
],
"operationId": "GetProductsSummaryForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrderProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrderProductsSummary"
}
}
}
}
}
}
},
"/orders/{id}/sort-box": {
"get": {
"tags": [
"Orders"
],
"operationId": "GetSortBoxForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
},
"/orders/{id}/serials": {
"get": {
"tags": [
"Orders"
],
"operationId": "ListSerialNumbersForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumbers"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumbers"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumbers"
}
}
}
}
}
},
"delete": {
"tags": [
"Orders"
],
"operationId": "DeleteSerialNumberForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/orders/{id}/serials/{serial}": {
"delete": {
"tags": [
"Orders"
],
"operationId": "DeleteSerialNumberForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"patch": {
"tags": [
"Orders"
],
"operationId": "InsertSerialNumberForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "productId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumber"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumber"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrderRelatedSerialNumber"
}
}
}
}
}
}
},
"/orders/{id}/serials/summary": {
"get": {
"tags": [
"Orders"
],
"operationId": "GetProductsInOrderSummary",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderSummary"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderSummary"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductsInOrderSummary"
}
}
}
}
}
}
}
},
"/orders/{id}/license-plate-label-printed": {
"get": {
"tags": [
"Orders"
],
"operationId": "IsLicensePlateLabelPrintedForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"patch": {
"tags": [
"Orders"
],
"operationId": "PatchLicensePlateLabelPrintedForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "printed",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Orders"
],
"operationId": "MarkLicensePlateLabelAsNotPrintedForOrder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/avery/full-color": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "GenerateAvery2x8LabelsFullColor",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/avery/qr": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "GenerateAvery2x8LabelsQrOnly",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/twenty-per-page/full-color": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "Generate2x10LabelsFullColor",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/twenty-per-page/qr": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "Generate2x10LabelsQrOnly",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/twenty-per-page/1d": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "Generate2x10LabelsSimple",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/thermal/qr": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "Generate3x1ThermalLabelsQrOnly",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/pdf-barcodes/thermal/1d": {
"post": {
"tags": [
"PdfBarcodes"
],
"operationId": "Generate3x1ThermalLabelsSimple",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/permissions/employees/me/multi-sort": {
"get": {
"tags": [
"Permissions"
],
"operationId": "DoesCurrentEmployeeHavePermissionToMultiSort",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/permissions/employees/multi-sort": {
"get": {
"tags": [
"Permissions"
],
"operationId": "ListEmployeesWithMultiSortPermission",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
}
}
},
"/permissions/employees/{id}/multi-sort": {
"put": {
"tags": [
"Permissions"
],
"operationId": "AddMultiSortPermissionToEmployee",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
},
"delete": {
"tags": [
"Permissions"
],
"operationId": "RemoveMultiSortPermissionFromEmployee",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/permissions/employees/me/access": {
"get": {
"tags": [
"Permissions"
],
"operationId": "DoesEmployeeHaveAccessPermission",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/permissions/employees/access": {
"get": {
"tags": [
"Permissions"
],
"operationId": "ListEmployeesWithAccessPermission",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
}
}
},
"/permissions/employees/{id}/access": {
"put": {
"tags": [
"Permissions"
],
"operationId": "AddAccessPermissionToEmployee",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeWithRoles"
}
}
}
}
}
},
"delete": {
"tags": [
"Permissions"
],
"operationId": "RemoveAccessPermissionFromEmployee",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/picklists": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklists",
"parameters": [
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistStatus"
}
},
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistType"
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "skus",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "picklists",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "orders",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "pickedStatuses",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PickedStatus"
}
}
},
{
"name": "sortField",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortField"
}
},
{
"name": "sortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
}
}
}
}
}
},
"/picklists/open": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListOpenPicklists",
"parameters": [
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "skus",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "picklists",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "orders",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "pickedStatuses",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PickedStatus"
}
}
},
{
"name": "sortField",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortField"
}
},
{
"name": "sortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
}
}
}
}
}
},
"/picklists/open/{id}": {
"get": {
"tags": [
"Picklists"
],
"operationId": "GetOpenPicklist",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
}
}
}
}
}
},
"/picklists/closed": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListClosedPicklists",
"parameters": [
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "warehouseId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
{
"name": "skus",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "picklists",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "orders",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "pickedStatuses",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PickedStatus"
}
}
},
{
"name": "sortField",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortField"
}
},
{
"name": "sortOrder",
"in": "query",
"schema": {
"$ref": "#/components/schemas/PicklistSortOrder"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Picklist"
}
}
}
}
}
}
}
},
"/picklists/{id}": {
"get": {
"tags": [
"Picklists"
],
"operationId": "GetPicklist",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PicklistWithOrders"
}
}
}
}
}
}
},
"/picklists/{id}/summary": {
"get": {
"tags": [
"Picklists"
],
"operationId": "GetPicklistSummary",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeDigitalProducts",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PicklistSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PicklistSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PicklistSummary"
}
}
}
}
}
}
},
"/picklists/{id}/orders": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklistOrders",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
}
}
}
}
}
},
"/picklists/{id}/orders/filtered": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklistOrdersWithFilters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "barcode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "pickingStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPickingStatus"
}
},
{
"name": "dropShipStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/DropShipStatus"
}
},
{
"name": "shippingStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderShippingStatus"
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
}
}
}
}
}
},
"/picklists/{id}/orders/by-barcode/{barcode}": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklistOrdersByBarcodeWithFilters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "barcode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pickingStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPickingStatus"
}
},
{
"name": "dropShipStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/DropShipStatus"
}
},
{
"name": "shippingStatus",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderShippingStatus"
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
}
}
}
}
}
}
}
},
"/picklists/{id}/products": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklistProducts",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeDigitalProducts",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
}
}
}
}
}
},
"/picklists/{id}/products/{sku}": {
"get": {
"tags": [
"Picklists"
],
"operationId": "GetPicklistProductBySku",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sku",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
}
}
}
}
},
"/picklists/{id}/products/by-barcode/{barcode}": {
"get": {
"tags": [
"Picklists"
],
"operationId": "ListPicklistProductsByBarcode",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "barcode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
}
}
}
}
}
}
}
},
"/products/list": {
"post": {
"tags": [
"Products"
],
"operationId": "ListProducts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListProductsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ListProductsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ListProductsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Product"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Product"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Product"
}
}
}
}
}
}
}
},
"/products/list/names": {
"post": {
"tags": [
"Products"
],
"operationId": "ListProductNames",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListProductNamesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ListProductNamesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ListProductNamesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
},
"/products/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProduct",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Product"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
}
}
}
},
"/products/by-barcode/{barcode}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProductsByBarcode",
"parameters": [
{
"name": "barcode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "extended",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductByBarcodeMatch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductByBarcodeMatch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductByBarcodeMatch"
}
}
}
}
}
}
}
},
"/products/{id}/image": {
"get": {
"tags": [
"Products"
],
"operationId": "DeprecatedGetProductImage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"deprecated": true
}
},
"/products/{id}/thumbnail": {
"get": {
"tags": [
"Products"
],
"operationId": "DeprecatedGetProductImageThumbnail",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"schema": {
"maximum": 800,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 150
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"deprecated": true
}
},
"/products/image/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProductImage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/products/thumbnail/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProductImageThumbnail",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"schema": {
"maximum": 800,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 150
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/products/replacements/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "ListReplacementProducts",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
}
}
}
}
},
"/products/serials/all/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "ListProductSerialNumbers",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inStock",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
}
}
}
}
}
},
"/products/serials/all/count/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProductSerialNumbersCount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inStock",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/products/serials/{serial}/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "GetProductSerialNumber",
"parameters": [
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
}
}
}
}
},
"/products/serials/{serial}/acceptable/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "IsRelaxedProductSerialNumberAcceptable",
"parameters": [
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orderId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/products/serials/{serial}/history/{id}": {
"get": {
"tags": [
"Products"
],
"operationId": "ListSerialNumberHistoryDetailsForProduct",
"parameters": [
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
}
}
}
}
}
},
"/remote-control/sort-boxes/{id}/flash": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "FlashSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/sort-boxes/{id}/sorter/light": {
"patch": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOnSortBoxSorterLight",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "color",
"in": "query",
"schema": {
"$ref": "#/components/schemas/UserColor"
}
},
{
"name": "seconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOffSortBoxSorterLight",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/sort-boxes/{id}/shipper/light": {
"patch": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOnSortBoxShipperLight",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "seconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOffSortBoxShipperLight",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/sort-boxes/by-crc/{crc}/flash": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "FlashSortBoxByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/sort-boxes/by-crc/{crc}/sorter/light": {
"patch": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOnSortBoxSorterLightByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "color",
"in": "query",
"schema": {
"$ref": "#/components/schemas/UserColor"
}
},
{
"name": "seconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOffSortBoxSorterLightByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/sort-boxes/by-crc/{crc}/shipper/light": {
"patch": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOnSortBoxShipperLightByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "seconds",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOffSortBoxShipperLightByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/lights": {
"delete": {
"tags": [
"RemoteControl"
],
"operationId": "TurnOffAllSortBoxLightsOnWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/brightness": {
"patch": {
"tags": [
"RemoteControl"
],
"operationId": "AdjustBrightness",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "value",
"in": "query",
"schema": {
"maximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/refresh": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "RefreshSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/test/stress/start": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "StartStressTest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/test/stress/stop": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "StopStressTest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/test/flash/start": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "StartFlashTest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/sort-boxes/test/flash/stop": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "StopFlashTest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/restart": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "RestartHub",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/remote-control/walls/{id}/shutdown": {
"post": {
"tags": [
"RemoteControl"
],
"operationId": "ShutdownHub",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/security/pin/required": {
"get": {
"tags": [
"Security"
],
"operationId": "IsSecurityPinRequired",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/security/pin/length": {
"get": {
"tags": [
"Security"
],
"operationId": "HintPinLength",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/security/pin/validate": {
"post": {
"tags": [
"Security"
],
"operationId": "ValidatePin",
"parameters": [
{
"name": "pin",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/serials/product/{serial}": {
"get": {
"tags": [
"SerialNumbers"
],
"operationId": "ListMatchingProductSerialNumbers",
"parameters": [
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inStock",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
}
}
}
}
}
}
},
"/serials/order/{serial}": {
"get": {
"tags": [
"SerialNumbers"
],
"operationId": "ListMatchingOrderSerialNumbers",
"parameters": [
{
"name": "serial",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderSerialNumber"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderSerialNumber"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderSerialNumber"
}
}
}
}
}
}
}
},
"/serials/history": {
"get": {
"tags": [
"SerialNumbers"
],
"operationId": "ListSerialNumberHistoryDetails",
"parameters": [
{
"name": "since",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
{
"name": "count",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "sku",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "serialNumber",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumberHistoryDetail"
}
}
}
}
}
}
}
},
"/server/dbvs": {
"get": {
"tags": [
"Server"
],
"operationId": "GetDbvsVersion",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/server/features/pick-to-light": {
"get": {
"tags": [
"Server"
],
"operationId": "IsPickToLightFeatureSupported",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
},
"deprecated": true
}
},
"/server/features/ad-hoc-workflow": {
"get": {
"tags": [
"Server"
],
"operationId": "IsAdHocWorkflowFeatureSupported",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
},
"deprecated": true
}
},
"/sessions": {
"get": {
"tags": [
"Sessions"
],
"operationId": "ListSessionsForAllWalls",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
}
},
"post": {
"tags": [
"Sessions"
],
"operationId": "StartSession",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StartSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/StartSessionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
}
},
"/sessions/{token}": {
"put": {
"tags": [
"Sessions"
],
"operationId": "RenewSession",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
},
"post": {
"tags": [
"Sessions"
],
"operationId": "PatchSession",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "color",
"in": "query",
"schema": {
"$ref": "#/components/schemas/UserColor"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
},
"deprecated": true
},
"get": {
"tags": [
"Sessions"
],
"operationId": "GetSession",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
},
"delete": {
"tags": [
"Sessions"
],
"operationId": "StopSession",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sessions/{token}/user-color": {
"post": {
"tags": [
"Sessions"
],
"operationId": "PatchSessionUserColor",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "color",
"in": "query",
"schema": {
"$ref": "#/components/schemas/UserColor"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
}
},
"/sessions/{token}/picklist": {
"post": {
"tags": [
"Sessions"
],
"operationId": "PatchSessionPicklist",
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "picklistId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
}
},
"/settings/subscriptions/skustack-enterprise": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsUsingSkustackEnterprise",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/picking/required/by-wall/{id}": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPickingRequiredForWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/picking/required/by-warehouse/{id}": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPickingRequiredForWarehouse",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/license-plate-label-size": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetLicensePlateLabelSize",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelSize"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelSize"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelSize"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetLicensePlateLabelSize",
"parameters": [
{
"name": "labelSize",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelSize"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetLicensePlateLabelSize",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/license-plate-label-resolution": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetLicensePlateLabelResolution",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelResolution"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelResolution"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelResolution"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetLicensePlateLabelResolution",
"parameters": [
{
"name": "labelResolution",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/LicensePlateLabelResolution"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetLicensePlateLabelResolution",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/license-plate-file-format": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetLicensePlateFileFormat",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LicensePlateFileFormat"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateFileFormat"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateFileFormat"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetLicensePlateFileFormat",
"parameters": [
{
"name": "fileFormat",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/LicensePlateFileFormat"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetLicensePlateFileFormat",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/license-plate-barcode-kind": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetLicensePlateBarcodeKind",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LicensePlateBarcodeKind"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateBarcodeKind"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LicensePlateBarcodeKind"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetLicensePlateBarcodeKind",
"parameters": [
{
"name": "barcode",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/LicensePlateBarcodeKind"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetLicensePlateBarcodeKind",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/pin/required": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsSecurityPinRequired",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/pin/length": {
"get": {
"tags": [
"Settings"
],
"operationId": "HintPinLength",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
},
"/settings/products/replacements/one-way": {
"get": {
"tags": [
"Settings"
],
"operationId": "AreProductReplacementsOneWay",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/products/replacements/allow-for-picking-bins": {
"get": {
"tags": [
"Settings"
],
"operationId": "AreProductReplacementsAllowedForPickingBins",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/sort-multiple-units": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsSortMultipleUnitsAllowed",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetSortMultipleUnitsAllowed",
"parameters": [
{
"name": "allowed",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetSortMultipleUnitsAllowed",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/sort-multiple-units/limited": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsSortMultipleUnitsLimitedByEmployee",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetSortMultipleUnitsLimitedByEmployee",
"parameters": [
{
"name": "limited",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetSortMultipleUnitsLimitedByEmployee",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/seconds-reserve-slots": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetSecondsToReserveSlotsAfterEmptying",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetSecondsToReserveSlotsAfterEmptying",
"parameters": [
{
"name": "seconds",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetSecondsToReserveSlotsAfterEmptying",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/blink-shipper-reserved-slots": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsBlinkingShipperEnabledWhileSlotIsStillReserved",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetBlinkingShipperEnabledWhileSlotIsStillReserved",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetBlinkingShipperEnabledWhileSlotIsStillReserved",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/minutes-consider-shipper-ready-awhile": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetMinutesToConsiderShipperReadyToShipAwhile",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetMinutesToConsiderShipperReadyToShipAwhile",
"parameters": [
{
"name": "minutes",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetMinutesToConsiderShipperReadyToShipAwhile",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/pulsate-shipper-ready-awhile": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPulsateShipperWhenReadyToShipAwhile",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetPulsateShipperWhenReadyToShipAwhile",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetPulsateShipperWhenReadyToShipAwhile",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/timer-for-sorted-items": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsTimerForSortedItems",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetTimerForSortedItems",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetTimerForSortedItems",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/hours-after-which-timer-is-shown": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetHoursAfterWhichTimerIsVisible",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetHoursAfterWhichTimerIsVisible",
"parameters": [
{
"name": "hours",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetHoursAfterWhichTimerIsVisible",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/volume-support": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsVolumeSupportEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetVolumeSupportEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetVolumeSupportEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/ad-hoc-wall-workflow": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsAdHocWallWorkflowSupportEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetAdHocWallWorkflowSupportEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetAdHocWallWorkflowSupportEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/serial-number-validation-enabled-in-sellercloud": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsSerialNumberValidationEnabledInSellerCloud",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/serial-numbers": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsSerialNumberSupportEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetSerialNumberSupportEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetSerialNumberSupportEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/amazon-transparency-code": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsAmazonTransparencyCodeSupportEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetAmazonTransparencyCodeEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetAmazonTransparencyCodeEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/only-allow-sorting-with-picklist": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsOnlyAllowSortingWithPicklistEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetOnlyAllowSortingWithPicklistEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetOnlyAllowSortingWithPicklistEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/volume-prefer-item-dimensions": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsVolumePreferItemDimensionsEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetVolumePreferItemDimensionsEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetVolumePreferItemDimensionsEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/blink-sorter-when-slot-ready-to-ship": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsBlinkSorterWhenSlotReadyToShipEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetBlinkSorterWhenSlotReadyToShipEnabled",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetBlinkSorterWhenSlotReadyToShipEnabled",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/employee-specific-colors": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsUsingEmployeeSpecificColorsWhenPossible",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetUsingEmployeeSpecificColorsWhenPossible",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetUsingEmployeeSpecificColorsWhenPossible",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/partially-picked-orders-sorting": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPartiallyPickedOrdersSortingAllowed",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetAllowPartiallyPickedOrdersSorting",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetAllowPartiallyPickedOrdersSorting",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/sort-box-assignment-algorithm": {
"get": {
"tags": [
"Settings"
],
"operationId": "GetSortBoxAssignmentAlgorithm",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxAssignmentAlgorithm"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxAssignmentAlgorithm"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxAssignmentAlgorithm"
}
}
}
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetSortBoxAssignmentAlgorithm",
"parameters": [
{
"name": "algorithm",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/SortBoxAssignmentAlgorithm"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetSortBoxAssignmentAlgorithm",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/pick-list-generate-by-warehouse": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPicklistGenerationByWarehouseEnabled",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/settings/check-other-walls-for-recipient-sort-box": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsCheckOtherWallsForRecipientSortBox",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetCheckOtherWallsForRecipientSortBox",
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetCheckOtherWallsForRecipientSortBox",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/use-rtc-for-license-plates": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsUsingRtcForLicensePlates",
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetIsUsingRtcForLicensePlates",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetIsUsingRtcForLicensePlates",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/settings/auto-print-license-plates-on-fully-sorted-order": {
"get": {
"tags": [
"Settings"
],
"operationId": "IsPrintingLicensePlateAutomaticallyWhenOrderIsFullySorted",
"responses": {
"200": {
"description": "Success"
}
}
},
"put": {
"tags": [
"Settings"
],
"operationId": "SetPrintingLicensePlateAutomaticallyWhenOrderIsFullySorted",
"parameters": [
{
"name": "enabled",
"in": "query",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Settings"
],
"operationId": "ResetPrintingLicensePlateAutomaticallyWhenOrderIsFullySorted",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-boxes": {
"post": {
"tags": [
"SortBoxes"
],
"operationId": "CreateSortBox",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"/sort-boxes/{id}": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxes"
],
"operationId": "DeleteSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-boxes/{id}/items": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetSortBoxItems",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
}
}
}
}
}
},
"/sort-boxes/{id}/order": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetOrderForSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
},
"/sort-boxes/{id}/products": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetProductsSummaryForSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxProductsSummary"
}
}
}
}
}
}
},
"/sort-boxes/{id}/empty": {
"patch": {
"tags": [
"SortBoxes"
],
"operationId": "EmptySortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-boxes/{id}/empty/license-plate": {
"patch": {
"tags": [
"SortBoxes"
],
"operationId": "EmptySortBoxDueToLicensePlate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-boxes/by-barcode/{barcode}": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "ListSortBoxesWithItemsByProductBarcode",
"parameters": [
{
"name": "barcode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
}
},
"/sort-boxes/by-crc/{crc}": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetSortBoxByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
},
"/sort-boxes/by-crc/{crc}/order": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetOrderForSortBoxByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
},
"/sort-boxes/by-crc/{crc}/empty": {
"patch": {
"tags": [
"SortBoxes"
],
"operationId": "EmptySortBoxByCrc",
"parameters": [
{
"name": "crc",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-boxes/by-hardware-id/{hardwareId}": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetSortBoxByHardwareId",
"parameters": [
{
"name": "hardwareId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
},
"/sort-boxes/by-order-id/{orderId}": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "GetSortBoxByOrderId",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
},
"/sort-boxes/{id}/capacity": {
"patch": {
"tags": [
"SortBoxes"
],
"operationId": "AssignCapacityToSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "capacityId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxes"
],
"operationId": "RemoveCapacityFromSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"/sort-boxes/capacity": {
"patch": {
"tags": [
"SortBoxes"
],
"operationId": "AssignCapacityToSortBoxes",
"parameters": [
{
"name": "capacityId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxes"
],
"operationId": "RemoveCapacitiesFromSortBoxes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"/sort-boxes/{sortBoxName}/name": {
"get": {
"tags": [
"SortBoxes"
],
"operationId": "ListSortBoxesByName",
"parameters": [
{
"name": "sortBoxName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
}
},
"/sort-boxes/{hardwareId}/name": {
"post": {
"tags": [
"SortBoxes"
],
"operationId": "UpdateName",
"parameters": [
{
"name": "hardwareId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"maxLength": 10,
"type": "string"
}
},
"text/json": {
"schema": {
"maxLength": 10,
"type": "string"
}
},
"application/*+json": {
"schema": {
"maxLength": 10,
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxes"
],
"operationId": "DeleteName",
"parameters": [
{
"name": "hardwareId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"/sort-box-capacity": {
"get": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "ListSortBoxCapacities",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
}
}
}
}
},
"post": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "AddSortBoxCapacity",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxCapacityRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxCapacityRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSortBoxCapacityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
}
}
}
}
},
"/sort-box-capacity/{id}": {
"get": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "GetSortBoxCapacity",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
}
}
}
},
"patch": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "PatchSortBoxCapacity",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchSortBoxCapacityRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PatchSortBoxCapacityRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PatchSortBoxCapacityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxCapacity"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "DeleteSortBoxCapacity",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-box-capacity/{id}/sort-boxes": {
"get": {
"tags": [
"SortBoxesCapacity"
],
"operationId": "ListAssociatedSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
}
},
"/sort-box-items": {
"post": {
"tags": [
"SortBoxItems"
],
"operationId": "ScanBarcode",
"parameters": [
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanBarcodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScanBarcodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ScanBarcodeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
}
}
}
}
},
"/sort-box-items/{id}": {
"get": {
"tags": [
"SortBoxItems"
],
"operationId": "GetScannedItem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
}
}
}
},
"delete": {
"tags": [
"SortBoxItems"
],
"operationId": "DeleteScannedItem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-box-items/{id}/confirm": {
"patch": {
"tags": [
"SortBoxItems"
],
"operationId": "ConfirmScannedItem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "units",
"in": "query",
"schema": {
"maximum": 9999,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"/sort-box-items/{id}/cancel": {
"patch": {
"tags": [
"SortBoxItems"
],
"operationId": "CancelScannedItem",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/sort-box-items/{id}/sort-box/swap/by-barcode": {
"patch": {
"tags": [
"SortBoxItems"
],
"operationId": "SwapRelatedSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwapSortBoxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SwapSortBoxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SwapSortBoxRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxItem"
}
}
}
}
}
}
},
"/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "ListSubscriptionNames",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/subscriptions/sellercloud": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "ClientHasSellerCloudSubscription",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/subscriptions/skublox": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "ClientHasSkubloxSubscription",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
},
"post": {
"tags": [
"Subscriptions"
],
"operationId": "AddSkubloxClientSubscription",
"responses": {
"200": {
"description": "Success"
}
}
},
"delete": {
"tags": [
"Subscriptions"
],
"operationId": "RemoveSkubloxClientSubscription",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/subscriptions/skustack-enterprise": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "ClientHasSkustackEnterpriseSubscription",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
},
"deprecated": true
}
},
"/subscriptions/skustack": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "ClientHasSkustackSubscription",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/volume/orders/{id}": {
"get": {
"tags": [
"Volume"
],
"operationId": "CalculateOrderVolume",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Volume"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Volume"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Volume"
}
}
}
}
}
}
},
"/volume/orders/{id}/partial": {
"get": {
"tags": [
"Volume"
],
"operationId": "CalculateAnyPartOfOrderVolume",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PartialVolume"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialVolume"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PartialVolume"
}
}
}
}
}
}
},
"/volume/products/{id}": {
"get": {
"tags": [
"Volume"
],
"operationId": "CalculateProductVolume",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "quantity",
"in": "query",
"schema": {
"maximum": 100000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProductVolume"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVolume"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProductVolume"
}
}
}
}
}
}
},
"/volume/can-sortbox-fit-order": {
"get": {
"tags": [
"Volume"
],
"operationId": "CanSortBoxFitOrder",
"parameters": [
{
"name": "sortBoxId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderId",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxOrderFit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxOrderFit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxOrderFit"
}
}
}
}
}
}
},
"/walls": {
"get": {
"tags": [
"Walls"
],
"operationId": "ListWalls",
"parameters": [
{
"name": "workflow",
"in": "query",
"schema": {
"$ref": "#/components/schemas/WallWorkflow"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
}
}
}
}
},
"post": {
"tags": [
"Walls"
],
"operationId": "CreateWall",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWallRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateWallRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateWallRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
}
}
}
}
}
},
"/walls/{id}": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallWithSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallWithSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
}
}
}
},
"patch": {
"tags": [
"Walls"
],
"operationId": "PatchWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchWallRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PatchWallRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PatchWallRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Wall"
}
}
}
}
}
},
"delete": {
"tags": [
"Walls"
],
"operationId": "DeleteWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/system-telemetry": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetWallSystemTelemetry",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SystemTelemetry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemTelemetry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SystemTelemetry"
}
}
}
}
}
}
},
"/walls/{id}/sessions": {
"get": {
"tags": [
"Walls"
],
"operationId": "ListSessions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
}
},
"post": {
"tags": [
"Walls"
],
"operationId": "StartSession",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartWallSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/StartWallSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/StartWallSessionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
},
"delete": {
"tags": [
"Walls"
],
"operationId": "StopSessions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/sessions/{token}": {
"put": {
"tags": [
"Walls"
],
"operationId": "RenewSession",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserSession"
}
}
}
}
}
},
"delete": {
"tags": [
"Walls"
],
"operationId": "StopSession",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/sort-boxes": {
"get": {
"tags": [
"Walls"
],
"operationId": "ListSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxWithItems"
}
}
}
}
}
}
},
"post": {
"tags": [
"Walls"
],
"operationId": "CreateSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWallSortBoxesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateWallSortBoxesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateWallSortBoxesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"put": {
"tags": [
"Walls"
],
"operationId": "SyncSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncWallSortBoxesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SyncWallSortBoxesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SyncWallSortBoxesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBox"
}
}
}
}
}
}
},
"delete": {
"tags": [
"Walls"
],
"operationId": "DeleteSortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/sort-boxes/products": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetProductsSummaryForSortBox",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "breakdown",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "inventory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
}
}
}
}
}
},
"/walls/{id}/sort-boxes/summary": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetSortBoxesSummary",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SortBoxesSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxesSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SortBoxesSummary"
}
}
}
}
}
}
},
"/walls/{id}/sort-boxes/empty": {
"patch": {
"tags": [
"Walls"
],
"operationId": "EmptySortBoxes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/sort-boxes/capacity": {
"delete": {
"tags": [
"Walls"
],
"operationId": "ResetSortBoxCapacities",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/suggestions": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetProductSuggestionsForOrders",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sorting",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "allowDropShip",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
},
{
"name": "breakdown",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "inventory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
}
}
}
}
}
},
"/walls/{id}/suggestions/picklists/{picklistId}": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetProductSuggestionsForPicklistOrders",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "picklistId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sorting",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "recent",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "allowDropShip",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "priority",
"in": "query",
"schema": {
"$ref": "#/components/schemas/OrderPriority"
}
},
{
"name": "breakdown",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "inventory",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrdersProductsSummary"
}
}
}
}
}
}
},
"/walls/{id}/warehouse": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetRelatedWarehouse",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
}
},
"/walls/{id}/display-order": {
"patch": {
"tags": [
"Walls"
],
"operationId": "PatchDisplayOrderForWall",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "desiredOrder",
"in": "query",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/display-order": {
"patch": {
"tags": [
"Walls"
],
"operationId": "PatchDisplayOrderForAllWalls",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/walls/{id}/real-time-connect-settings": {
"get": {
"tags": [
"Walls"
],
"operationId": "GetWallRealTimeConnectSettings",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
}
}
}
}
},
"post": {
"tags": [
"Walls"
],
"operationId": "UpdateWallRealTimeConnectSettings",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettingsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettingsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
}
}
}
}
},
"delete": {
"tags": [
"Walls"
],
"operationId": "DeleteWallRealTimeConnectSettings",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/warehouses": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "ListWarehouses",
"parameters": [
{
"name": "binEnabled",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
}
}
},
"/warehouses/walls": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "ListWarehousesWithWalls",
"parameters": [
{
"name": "binEnabled",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarehouseWithWalls"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarehouseWithWalls"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarehouseWithWalls"
}
}
}
}
}
}
}
},
"/warehouses/{id}": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "GetWarehouse",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
}
},
"/warehouses/default": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "GetDefaultWarehouse",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
}
}
}
},
"/warehouses/{id}/walls": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "ListWallsByWarehouse",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "workflow",
"in": "query",
"schema": {
"$ref": "#/components/schemas/WallWorkflow"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallWithSummary"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AmazonTransparencyCode": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"productId": {
"type": "string",
"nullable": true
},
"transparencyCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Application": {
"type": "object",
"properties": {
"version": {
"type": "string",
"nullable": true
},
"apiUser": {
"type": "string",
"nullable": true
},
"computerUsername": {
"type": "string",
"nullable": true
},
"userDomainName": {
"type": "string",
"nullable": true
},
"workgroup": {
"type": "string",
"nullable": true
},
"activeDirectory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AuditLog": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"wall": {
"$ref": "#/components/schemas/WallAuditLogWithDetails"
},
"userSession": {
"$ref": "#/components/schemas/UserSessionAuditLog"
},
"sortBox": {
"$ref": "#/components/schemas/SortBoxAuditLog"
},
"sortBoxItem": {
"$ref": "#/components/schemas/SortBoxItemAuditLog"
}
},
"additionalProperties": false
},
"BarcodeConfirmationStats": {
"type": "object",
"properties": {
"confirmations": {
"type": "integer",
"format": "int32"
},
"unitsSorted": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"BarcodeInputMethod": {
"enum": [
"Unknown",
"Scanned",
"TypedIn",
"KeyedIn",
"KeyedInViaSuggestions"
],
"type": "string",
"nullable": true
},
"BarcodeKind": {
"enum": [
"Unknown",
"Sku",
"Upc",
"Alias",
"FbaSku",
"ITF14",
"MasterSku",
"ManufacturerSku",
"Ean",
"Gtin",
"Asin"
],
"type": "string",
"nullable": true
},
"BundleItem": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"qty": {
"type": "integer",
"format": "int32"
},
"replacement": {
"$ref": "#/components/schemas/BundleItemReplacement"
}
},
"additionalProperties": false
},
"BundleItemReplacement": {
"type": "object",
"properties": {
"originalProductId": {
"type": "string",
"nullable": true
},
"productId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ClientDeviceVersions": {
"enum": [
"Unknown",
"Prototype",
"Q32020"
],
"type": "string"
},
"Connectivity": {
"type": "object",
"properties": {
"localIpAddress": {
"type": "string",
"nullable": true
},
"remoteIpAddress": {
"type": "string",
"nullable": true
},
"networks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InternetConnection"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateAmazonTransparencyCodeRequest": {
"required": [
"orderId",
"productId",
"transparencyCode"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"productId": {
"minLength": 1,
"type": "string"
},
"transparencyCode": {
"minLength": 7,
"type": "string"
}
},
"additionalProperties": false
},
"CreateSortBoxCapacityRequest": {
"required": [
"displayName",
"volume",
"volumeUnit"
],
"type": "object",
"properties": {
"displayName": {
"minLength": 1,
"type": "string"
},
"volume": {
"maximum": 1000000,
"minimum": 0.01,
"type": "number",
"format": "double"
},
"volumeUnit": {
"$ref": "#/components/schemas/VolumeUnits"
}
},
"additionalProperties": false
},
"CreateSortBoxRequest": {
"required": [
"hardwareId",
"wallId"
],
"type": "object",
"properties": {
"wallId": {
"type": "integer",
"format": "int32"
},
"hardwareId": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"CreateWallRequest": {
"required": [
"maxUserSessions",
"name",
"segmentShape",
"version",
"warehouseId"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"version": {
"$ref": "#/components/schemas/SkubloxVersions"
},
"isActive": {
"type": "boolean"
},
"maxUserSessions": {
"maximum": 6,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"segmentShape": {
"$ref": "#/components/schemas/CreateWallSegmentShapeRequest"
},
"warehouseId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
}
},
"additionalProperties": false
},
"CreateWallSegmentShapeRequest": {
"type": "object",
"properties": {
"columns": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"rows": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"flowDirection": {
"$ref": "#/components/schemas/FlowDirection"
}
},
"additionalProperties": false
},
"CreateWallSortBoxesRequest": {
"required": [
"hardwareIds"
],
"type": "object",
"properties": {
"hardwareIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"DailySortingStats": {
"type": "object",
"properties": {
"byHourUtc": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"DateRangeSortingStats": {
"type": "object",
"properties": {
"byHourUtc": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"DropShipStatus": {
"enum": [
"None",
"Pending",
"Requested",
"Acknowledged",
"Processed",
"PartialProcessed",
"Cancelled",
"Invalid"
],
"type": "string"
},
"EmployeeSortingStats": {
"type": "object",
"properties": {
"unitsSorted": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"EmployeeWithRoles": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"FlowDirection": {
"enum": [
"Unknown",
"ZSnake",
"SSnake",
"WSnake",
"MSnake",
"UpwardZSnake",
"UpwardSSnake",
"BackwardWSnake",
"BackwardMSnake",
"ColumnsDownwardLeftToRight",
"ColumnsDownwardRightToLeft",
"RowsLeftToRightDownward",
"RowsRightToLeftDownward",
"ColumnsUpwardLeftToRight",
"ColumnsUpwardRightToLeft",
"RowsLeftToRightUpward",
"RowsRightToLeftUpward"
],
"type": "string"
},
"GeoAddress": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GeoCoordinates": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"GeoLocation": {
"type": "object",
"properties": {
"coordinates": {
"$ref": "#/components/schemas/GeoCoordinates"
},
"address": {
"$ref": "#/components/schemas/GeoAddress"
},
"ipAddress": {
"type": "string",
"nullable": true
},
"timestampUtc": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"InternetConnection": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/InternetConnectionType"
},
"ipVersion": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"speed": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"InternetConnectionType": {
"enum": [
"Unknown",
"Ethernet",
"Wireless"
],
"type": "string",
"nullable": true
},
"KitMeta": {
"type": "object",
"properties": {
"kitParentProductId": {
"type": "string",
"nullable": true
},
"unitsOfKit": {
"type": "integer",
"format": "int32"
},
"unitsPerKit": {
"type": "integer",
"format": "int32"
},
"codesSoFar": {
"type": "integer",
"format": "int32"
},
"codesRemaining": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"KnownBrowser": {
"enum": [
"Unknown",
"Default",
"Safari",
"Chrome",
"Firefox",
"Edge"
],
"type": "string",
"nullable": true
},
"KnownDevice": {
"enum": [
"Unknown",
"ModernAndroid",
"SamsungGalaxyNote10",
"OnePlus7Pro",
"Redmi",
"iPhone",
"iPad",
"ChainwayC7",
"ZebraTC20",
"ZebraTC51",
"ZebraTC56",
"MotorolaMC40",
"Desktop",
"MobileScanner",
"ZebraTC21",
"ZebraTC25",
"ZebraTC26",
"OutdatedAndroid",
"ZebraTC57",
"ZebraTC58",
"ZebraTC52",
"ZebraTC52x",
"KcositM790",
"UrovoI6310",
"UrovoDT40",
"HoneywellCT60"
],
"type": "string",
"nullable": true
},
"LicensePlateBarcodeKind": {
"enum": [
"Unknown",
"ConfirmationCode",
"OrderId",
"ExternalOrderId"
],
"type": "string"
},
"LicensePlateFileFormat": {
"enum": [
"Unknown",
"Pdf",
"Zpl"
],
"type": "string"
},
"LicensePlateLabelResolution": {
"enum": [
"Unknown",
"Dpi203",
"Dpi300"
],
"type": "string"
},
"LicensePlateLabelSize": {
"enum": [
"Unknown",
"Small3x1",
"Large4x6"
],
"type": "string"
},
"ListProductNamesRequest": {
"required": [
"productIds"
],
"type": "object",
"properties": {
"productIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"ListProductsRequest": {
"required": [
"productIds"
],
"type": "object",
"properties": {
"productIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"OperatingSystemName": {
"enum": [
"Unknown",
"Windows",
"Linux",
"MacOS"
],
"type": "string",
"nullable": true
},
"Order": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"timeOfOrder": {
"type": "string",
"format": "date-time"
},
"statusCode": {
"$ref": "#/components/schemas/OrderStatusCode"
},
"channel": {
"$ref": "#/components/schemas/OrderSource"
},
"channelOrderId": {
"type": "string",
"nullable": true
},
"dropShipStatus": {
"$ref": "#/components/schemas/DropShipStatus"
},
"shippingStatus": {
"$ref": "#/components/schemas/OrderShippingStatus"
},
"pickingStatus": {
"$ref": "#/components/schemas/OrderPickingStatus"
},
"isLicensePlateLabelPrinted": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"nullable": true
},
"shippedOn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shippedBy": {
"type": "integer",
"format": "int32",
"nullable": true
},
"trackingNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OrderItem": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
},
"qty": {
"type": "integer",
"format": "int32"
},
"qtyPicked": {
"type": "integer",
"format": "int32"
},
"requiresAmazonTransparencyCode": {
"type": "boolean"
},
"bundleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleItem"
},
"nullable": true
},
"replacement": {
"$ref": "#/components/schemas/OrderItemReplacement"
}
},
"additionalProperties": false
},
"OrderItemReplacement": {
"type": "object",
"properties": {
"originalProductId": {
"type": "string",
"nullable": true
},
"productId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"OrderPickingStatus": {
"enum": [
"None",
"PartiallyPicked",
"FullyPicked",
"OverPicked"
],
"type": "string"
},
"OrderPriority": {
"enum": [
"MultipleUnits",
"SingleUnit",
"Oldest",
"MostRecent"
],
"type": "string"
},
"OrderProductsSummary": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"products": {
"type": "integer",
"format": "int32"
},
"units": {
"type": "integer",
"format": "int32"
},
"required": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sorted": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"remaining": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"locationNotes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderRelatedSerialNumber": {
"type": "object",
"properties": {
"orderSerial": {
"$ref": "#/components/schemas/OrderSerialNumber"
},
"productSerial": {
"$ref": "#/components/schemas/ProductSerialNumber"
}
},
"additionalProperties": false
},
"OrderRelatedSerialNumbers": {
"type": "object",
"properties": {
"orderSerials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderSerialNumber"
},
"nullable": true
},
"productSerials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSerialNumber"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderSerialNumber": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"productId": {
"type": "string",
"nullable": true
},
"serialNumber": {
"type": "string",
"nullable": true
},
"orderItemId": {
"type": "integer",
"format": "int32"
},
"orderItemBundleItemId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OrderShippingStatus": {
"enum": [
"Unknown",
"Unshipped",
"PartiallyShipped",
"FullyShipped",
"ReadyForPickup"
],
"type": "string"
},
"OrderSortingStats": {
"type": "object",
"properties": {
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"shippingStatus": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/OrderShippingStatus"
},
"nullable": true
},
"byTotalUnits": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"OrderSource": {
"enum": [
"Local_Store",
"eBayOrder",
"eBaySingleItem",
"Yahoo",
"Amazon",
"PriceGrabber",
"Website",
"Buy",
"NewEggMall",
"Magento",
"QuickBooks",
"RMS",
"Cart32",
"Sears",
"FBA",
"Wholesale",
"Overstock",
"NewEggdotcom",
"Etsy",
"Bonanza",
"PriceFalls",
"Wayfair",
"UnbeatableSale",
"VendorCentral",
"Hayneedle",
"SmartBargains",
"uBid",
"ATGStores",
"StacksAndStacks",
"Sharkstores",
"BestBuy",
"Kohls",
"Staples",
"OneStopPlus",
"Meijer",
"Sonsi",
"Walmart",
"HSN",
"NewEgg_Business",
"KMart",
"Wish",
"SPRichards",
"FingerHut",
"Groupon",
"Walmart_Marketplace",
"Evine",
"PriceMinister",
"GS",
"DrugStore",
"MercadoLibre",
"JET",
"ElevenMain",
"SearsVendor",
"Choxi",
"TradeMe",
"Tanga",
"Target",
"GrouponMarketplace",
"Reverb",
"BedBathAndBeyond",
"DropshipCentral",
"DSW",
"Houzz",
"Gilt",
"BestBuyDS",
"TopHatter",
"HomeDepot",
"MassGenie",
"GoogleExpress",
"Target_Plus",
"WFS"
],
"type": "string"
},
"OrderStatusCode": {
"enum": [
"ShoppingCart",
"InProcess",
"Completed",
"ProblemOrder",
"OnHold",
"Quote",
"Void",
"Canceled"
],
"type": "string"
},
"OrdersProductsSummary": {
"type": "object",
"properties": {
"orders": {
"type": "integer",
"format": "int32"
},
"products": {
"type": "integer",
"format": "int32"
},
"units": {
"type": "integer",
"format": "int32"
},
"required": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sorted": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"remaining": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"perOrder": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SortBoxProductsSummary"
},
"nullable": true
},
"unitsPerProduct": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProductUnitsInWarehouse"
},
"nullable": true
},
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"locationNotes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"PartialVolume": {
"type": "object",
"properties": {
"volume": {
"$ref": "#/components/schemas/Volume"
},
"isPartial": {
"type": "boolean"
}
},
"additionalProperties": false
},
"PatchSortBoxCapacityRequest": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"volumeUnit": {
"$ref": "#/components/schemas/VolumeUnits"
}
},
"additionalProperties": false
},
"PatchWallRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"version": {
"$ref": "#/components/schemas/SkubloxVersions"
},
"isActive": {
"type": "boolean",
"nullable": true
},
"maxUserSessions": {
"maximum": 6,
"minimum": 1,
"type": "integer",
"format": "int32",
"nullable": true
},
"segmentShape": {
"$ref": "#/components/schemas/PatchWallSegmentShapeRequest"
},
"warehouseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
}
},
"additionalProperties": false
},
"PatchWallSegmentShapeRequest": {
"type": "object",
"properties": {
"columns": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"nullable": true
},
"rows": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"nullable": true
},
"flowDirection": {
"$ref": "#/components/schemas/FlowDirection"
}
},
"additionalProperties": false
},
"Performance": {
"type": "object",
"properties": {
"totalCpuUsage": {
"type": "integer",
"format": "int32",
"nullable": true
},
"availableRam": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"PickedStatus": {
"enum": [
"ZeroPicked",
"PartiallyPicked",
"FullyPicked"
],
"type": "string"
},
"Picklist": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"generatedOn": {
"type": "string",
"format": "date-time"
},
"generatedBy": {
"$ref": "#/components/schemas/User"
},
"status": {
"$ref": "#/components/schemas/PicklistStatus"
},
"type": {
"$ref": "#/components/schemas/PicklistType"
},
"cachedUnits": {
"type": "integer",
"format": "int32"
},
"units": {
"type": "integer",
"format": "int32"
},
"unitsPicked": {
"type": "integer",
"format": "int32"
},
"missingOrders": {
"type": "integer",
"format": "int32"
},
"warehouseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"singleItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"multiItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"ordersByShippingStatus": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Unshipped": {
"type": "integer",
"format": "int32"
},
"PartiallyShipped": {
"type": "integer",
"format": "int32"
},
"FullyShipped": {
"type": "integer",
"format": "int32"
},
"ReadyForPickup": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false,
"nullable": true
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"PicklistOrder": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"timeOfOrder": {
"type": "string",
"format": "date-time",
"nullable": true
},
"statusCode": {
"$ref": "#/components/schemas/OrderStatusCode"
},
"shippingStatus": {
"$ref": "#/components/schemas/OrderShippingStatus"
},
"pickingStatus": {
"$ref": "#/components/schemas/OrderPickingStatus"
},
"totalUnits": {
"type": "integer",
"format": "int32"
},
"totalUnitsPicked": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PicklistProductOrder": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"timeOfOrder": {
"type": "string",
"format": "date-time",
"nullable": true
},
"statusCode": {
"$ref": "#/components/schemas/OrderStatusCode"
},
"dropShipStatus": {
"$ref": "#/components/schemas/DropShipStatus"
},
"shippingStatus": {
"$ref": "#/components/schemas/OrderShippingStatus"
},
"pickingStatus": {
"$ref": "#/components/schemas/OrderPickingStatus"
},
"isLicensePlateLabelPrinted": {
"type": "boolean"
},
"productUnits": {
"type": "integer",
"format": "int32"
},
"productUnitsPicked": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PicklistProductWithOrders": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"units": {
"type": "integer",
"format": "int32"
},
"unitsPicked": {
"type": "integer",
"format": "int32"
},
"upc": {
"type": "string",
"nullable": true
},
"purchaser": {
"type": "string",
"nullable": true
},
"inventoryAvailableQty": {
"type": "integer",
"format": "int32"
},
"singleItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"multiItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductOrder"
},
"nullable": true
}
},
"additionalProperties": false
},
"PicklistSortField": {
"enum": [
"Id",
"TotalUnits",
"PercentagePicked"
],
"type": "string"
},
"PicklistSortOrder": {
"enum": [
"Ascending",
"Descending"
],
"type": "string"
},
"PicklistStatus": {
"enum": [
"Open",
"Closed"
],
"type": "string",
"nullable": true
},
"PicklistSummary": {
"type": "object",
"properties": {
"picklistId": {
"type": "integer",
"format": "int32"
},
"orders": {
"type": "integer",
"format": "int32"
},
"products": {
"type": "integer",
"format": "int32"
},
"units": {
"type": "integer",
"format": "int32"
},
"unitsPicked": {
"type": "integer",
"format": "int32"
},
"required": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"picked": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"remaining": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"PicklistType": {
"enum": [
"Standard",
"ProductBased",
"OrderBased",
"KitBased",
"CartBased"
],
"type": "string",
"nullable": true
},
"PicklistWithOrders": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"generatedOn": {
"type": "string",
"format": "date-time"
},
"generatedBy": {
"$ref": "#/components/schemas/User"
},
"status": {
"$ref": "#/components/schemas/PicklistStatus"
},
"type": {
"$ref": "#/components/schemas/PicklistType"
},
"cachedUnits": {
"type": "integer",
"format": "int32"
},
"units": {
"type": "integer",
"format": "int32"
},
"unitsPicked": {
"type": "integer",
"format": "int32"
},
"missingOrders": {
"type": "integer",
"format": "int32"
},
"warehouseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"singleItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"multiItemOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistOrder"
},
"nullable": true
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PicklistProductWithOrders"
},
"nullable": true
}
},
"additionalProperties": false
},
"Product": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"parentSku": {
"type": "string",
"nullable": true
},
"isShadow": {
"type": "boolean"
},
"upc": {
"type": "string",
"nullable": true
},
"ean": {
"type": "string",
"nullable": true
},
"gtin": {
"type": "string",
"nullable": true
},
"asin": {
"type": "string",
"nullable": true
},
"fbaSku": {
"type": "string",
"nullable": true
},
"masterSku": {
"type": "string",
"nullable": true
},
"manufacturerSku": {
"type": "string",
"nullable": true
},
"itF14s": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductITF14"
},
"nullable": true
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"shadows": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"defaultImageUrl": {
"type": "string",
"nullable": true
},
"locationNotes": {
"type": "string",
"nullable": true
},
"requiresSerialNumber": {
"type": "boolean"
},
"isDigital": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ProductByBarcodeMatch": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"parentSku": {
"type": "string",
"nullable": true
},
"isShadow": {
"type": "boolean"
},
"upc": {
"type": "string",
"nullable": true
},
"ean": {
"type": "string",
"nullable": true
},
"gtin": {
"type": "string",
"nullable": true
},
"asin": {
"type": "string",
"nullable": true
},
"fbaSku": {
"type": "string",
"nullable": true
},
"masterSku": {
"type": "string",
"nullable": true
},
"manufacturerSku": {
"type": "string",
"nullable": true
},
"itF14s": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductITF14"
},
"nullable": true
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"shadows": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"defaultImageUrl": {
"type": "string",
"nullable": true
},
"locationNotes": {
"type": "string",
"nullable": true
},
"requiresSerialNumber": {
"type": "boolean"
},
"isDigital": {
"type": "boolean"
},
"barcodeKind": {
"$ref": "#/components/schemas/BarcodeKind"
},
"productUnits": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProductITF14": {
"type": "object",
"properties": {
"itf14": {
"type": "string",
"nullable": true
},
"upc": {
"type": "string",
"nullable": true
},
"qty": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProductSerialNumber": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"serialNumber": {
"type": "string",
"nullable": true
},
"inStock": {
"type": "boolean"
},
"purchaseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rmaId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"creditMemoId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"warehouseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"locationBinId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"creditMemoReason": {
"type": "string",
"nullable": true
},
"fbaShipmentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"warehouseTransferRequestId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ProductSerialNumberHistoryDetail": {
"type": "object",
"properties": {
"historyId": {
"type": "integer",
"format": "int64"
},
"productId": {
"type": "string",
"nullable": true
},
"serialNumber": {
"type": "string",
"nullable": true
},
"purchaseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rmaId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"creditMemoId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"warehouseId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"locationBinId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"creditMemoReason": {
"type": "string",
"nullable": true
},
"fbaShipmentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"warehouseTransferRequestId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ProductSortingStats": {
"type": "object",
"properties": {
"units": {
"type": "integer",
"format": "int32"
},
"products": {
"type": "integer",
"format": "int32"
},
"mostSorted": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProductUnitsInWarehouse": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"format": "int32"
},
"physical": {
"type": "integer",
"format": "int32"
},
"reserved": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProductVolume": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"net": {
"$ref": "#/components/schemas/Volume"
},
"shipping": {
"$ref": "#/components/schemas/Volume"
}
},
"additionalProperties": false
},
"ProductsInOrderForAmazonTransparencyCodeSummary": {
"type": "object",
"properties": {
"totalUnits": {
"type": "integer",
"format": "int32"
},
"codes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"codesSoFar": {
"type": "integer",
"format": "int32"
},
"codesRemaining": {
"type": "integer",
"format": "int32"
},
"kits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KitMeta"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProductsInOrderSummary": {
"type": "object",
"properties": {
"totalUnits": {
"type": "integer",
"format": "int32"
},
"serials": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"serialsSoFar": {
"type": "integer",
"format": "int32"
},
"serialsRemaining": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ScanBarcodeRequest": {
"required": [
"barcode",
"sessionToken"
],
"type": "object",
"properties": {
"sessionToken": {
"minLength": 1,
"type": "string"
},
"barcode": {
"minLength": 1,
"type": "string"
},
"barcodeInputMethod": {
"$ref": "#/components/schemas/BarcodeInputMethod"
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"allowDropShipRequestedStatus": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SkubloxVersions": {
"enum": [
"Unknown",
"Prototype"
],
"type": "string"
},
"SortBox": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"ordinalNumber": {
"type": "integer",
"format": "int32"
},
"hardwareId": {
"type": "string",
"nullable": true
},
"crc": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SortBoxStatus"
},
"assignedOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedOrderSortId": {
"type": "string",
"format": "date-time",
"nullable": true
},
"relatedPicklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"capacity": {
"$ref": "#/components/schemas/SortBoxCapacity"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxAssignmentAlgorithm": {
"enum": [
"Unknown",
"Sequential",
"SortingZones"
],
"type": "string"
},
"SortBoxAuditLog": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/SortBoxAuditLogKind"
},
"userId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
},
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortBoxCrc": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderSortId": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxAuditLogKind": {
"enum": [
"Unknown",
"AssignedToOrder",
"ContentsReadyToShip",
"Emptied",
"OrderLoadedForShipping",
"OrderCouldNotBeLoadedForShipping",
"OrderShipped",
"OrderCouldNotBeShipped",
"EmptiedDueToLicensePlate"
],
"type": "string"
},
"SortBoxCapacity": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string",
"nullable": true
},
"volume": {
"type": "number",
"format": "double"
},
"volumeUnit": {
"$ref": "#/components/schemas/VolumeUnits"
}
},
"additionalProperties": false
},
"SortBoxDisplay": {
"type": "object",
"properties": {
"ordinalNumber": {
"type": "integer",
"format": "int32"
},
"rowPosition": {
"type": "integer",
"format": "int32"
},
"colPosition": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SortBoxItem": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"sortBoxId": {
"type": "integer",
"format": "int32"
},
"sortBoxCrc": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SortBoxItemStatus"
},
"scannedBarcode": {
"type": "string",
"nullable": true
},
"scannedBarcodeKind": {
"$ref": "#/components/schemas/BarcodeKind"
},
"scannedBarcodeInputMethod": {
"$ref": "#/components/schemas/BarcodeInputMethod"
},
"relatedProductId": {
"type": "string",
"nullable": true
},
"relatedOrderId": {
"type": "integer",
"format": "int32"
},
"sortedOn": {
"type": "string",
"format": "date-time"
},
"sortedBy": {
"type": "integer",
"format": "int32"
},
"qtySorted": {
"type": "integer",
"format": "int32"
},
"serialNumberConfirmed": {
"type": "boolean",
"nullable": true
},
"amazonTransparencyCodeConfirmed": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxItemAuditLog": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/SortBoxItemAuditLogKind"
},
"userId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"userAgentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"device": {
"$ref": "#/components/schemas/KnownDevice"
},
"browser": {
"$ref": "#/components/schemas/KnownBrowser"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
},
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortBoxCrc": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderSortId": {
"type": "string",
"format": "date-time",
"nullable": true
},
"barcode": {
"type": "string",
"nullable": true
},
"barcodeInputMethod": {
"$ref": "#/components/schemas/BarcodeInputMethod"
},
"barcodeKind": {
"$ref": "#/components/schemas/BarcodeKind"
},
"relatedProductId": {
"type": "string",
"nullable": true
},
"qtySorted": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxItemAuditLogKind": {
"enum": [
"Unknown",
"Canceled",
"PendingConfirmation",
"Confirmed",
"InvalidBarcodeScanned",
"NoOrderFoundForBarcode",
"ExistingBoxGotAnotherProductMeanwhile",
"ExistingPendingScan",
"ExistingBoxOnAnotherWall",
"ExistingBoxContainsPendingItems",
"NoBoxAvailableForOrder",
"NoMatchingITF14Found"
],
"type": "string"
},
"SortBoxItemStatus": {
"enum": [
"Unknown",
"Canceled",
"PendingConfirmation",
"Confirmed"
],
"type": "string"
},
"SortBoxOrderFit": {
"type": "object",
"properties": {
"sortBoxCapacity": {
"$ref": "#/components/schemas/Volume"
},
"orderVolume": {
"$ref": "#/components/schemas/Volume"
},
"partialOrderVolume": {
"$ref": "#/components/schemas/Volume"
},
"reserved": {
"$ref": "#/components/schemas/Volume"
},
"remaining": {
"$ref": "#/components/schemas/Volume"
},
"shortage": {
"$ref": "#/components/schemas/Volume"
},
"canFit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SortBoxProductsSummary": {
"type": "object",
"properties": {
"required": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"sorted": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"remaining": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxStatus": {
"enum": [
"Unassigned",
"SortingInProgress",
"ContentsReadyToShip"
],
"type": "string"
},
"SortBoxWithItems": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"ordinalNumber": {
"type": "integer",
"format": "int32"
},
"hardwareId": {
"type": "string",
"nullable": true
},
"crc": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/SortBoxStatus"
},
"assignedOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedOrderSortId": {
"type": "string",
"format": "date-time",
"nullable": true
},
"relatedPicklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SortBoxItem"
},
"nullable": true
},
"capacity": {
"$ref": "#/components/schemas/SortBoxCapacity"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SortBoxesSummary": {
"type": "object",
"properties": {
"all": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"readyToShip": {
"type": "integer",
"format": "int32"
},
"beingSorted": {
"type": "integer",
"format": "int32"
},
"inUse": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"empty": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SortingStats": {
"type": "object",
"properties": {
"orders": {
"$ref": "#/components/schemas/OrderSortingStats"
},
"products": {
"$ref": "#/components/schemas/ProductSortingStats"
},
"employees": {
"$ref": "#/components/schemas/EmployeeSortingStats"
}
},
"additionalProperties": false
},
"StartSessionRequest": {
"required": [
"clientDeviceVersion",
"wallId"
],
"type": "object",
"properties": {
"wallId": {
"type": "integer",
"format": "int32"
},
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clientDeviceVersion": {
"$ref": "#/components/schemas/ClientDeviceVersions"
},
"preferredColor": {
"$ref": "#/components/schemas/UserColor"
}
},
"additionalProperties": false
},
"StartWallSessionRequest": {
"required": [
"clientDeviceVersion"
],
"type": "object",
"properties": {
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clientDeviceVersion": {
"$ref": "#/components/schemas/ClientDeviceVersions"
},
"preferredColor": {
"$ref": "#/components/schemas/UserColor"
}
},
"additionalProperties": false
},
"SwapSortBoxRequest": {
"required": [
"sessionToken",
"targetSortBoxBarcode"
],
"type": "object",
"properties": {
"sessionToken": {
"minLength": 1,
"type": "string"
},
"targetSortBoxBarcode": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"SyncWallSortBoxesRequest": {
"required": [
"hardwareIds"
],
"type": "object",
"properties": {
"hardwareIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"SystemMetrics": {
"type": "object",
"properties": {
"machineName": {
"type": "string",
"nullable": true
},
"operatingSystemName": {
"$ref": "#/components/schemas/OperatingSystemName"
},
"operatingSystemVersion": {
"type": "string",
"nullable": true
},
"processor": {
"type": "string",
"nullable": true
},
"processorCores": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comPorts": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SystemTelemetry": {
"type": "object",
"properties": {
"application": {
"$ref": "#/components/schemas/Application"
},
"systemMetrics": {
"$ref": "#/components/schemas/SystemMetrics"
},
"performance": {
"$ref": "#/components/schemas/Performance"
},
"connectivity": {
"$ref": "#/components/schemas/Connectivity"
}
},
"additionalProperties": false
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserColor": {
"enum": [
"Unknown",
"Red",
"Blue",
"Yellow",
"Green",
"Cyan",
"Magenta"
],
"type": "string",
"nullable": true
},
"UserSession": {
"type": "object",
"properties": {
"wallId": {
"type": "integer",
"format": "int32"
},
"userId": {
"type": "integer",
"format": "int32"
},
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clientDeviceVersion": {
"$ref": "#/components/schemas/ClientDeviceVersions"
},
"startedOn": {
"type": "string",
"format": "date-time"
},
"sessionToken": {
"type": "string",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"user": {
"$ref": "#/components/schemas/User"
}
},
"additionalProperties": false
},
"UserSessionAuditLog": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/UserSessionAuditLogKind"
},
"userId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"userAgentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"device": {
"$ref": "#/components/schemas/KnownDevice"
},
"browser": {
"$ref": "#/components/schemas/KnownBrowser"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
},
"picklistId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"clientDeviceVersion": {
"$ref": "#/components/schemas/ClientDeviceVersions"
},
"sessionToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserSessionAuditLogKind": {
"enum": [
"Unknown",
"Stopped",
"Started"
],
"type": "string"
},
"Volume": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double"
},
"unit": {
"$ref": "#/components/schemas/VolumeUnits"
}
},
"additionalProperties": false
},
"VolumeUnits": {
"enum": [
"CubicCentimeters",
"CubicInches",
"Liters",
"CubicFeet"
],
"type": "string"
},
"Wall": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"version": {
"$ref": "#/components/schemas/SkubloxVersions"
},
"isActive": {
"type": "boolean"
},
"maxUserSessions": {
"type": "integer",
"format": "int32"
},
"displayOrder": {
"type": "integer",
"format": "int32"
},
"segmentShape": {
"$ref": "#/components/schemas/WallSegmentShape"
},
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
},
"hubDevice": {
"$ref": "#/components/schemas/WallHubDevice"
},
"realTimeConnectSettings": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"additionalProperties": false
},
"WallAuditLog": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/WallAuditLogKind"
},
"userId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"wallId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"WallAuditLogDetail": {
"type": "object",
"properties": {
"detail": {
"type": "string",
"nullable": true
},
"original": {
"type": "string",
"nullable": true
},
"changed": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WallAuditLogKind": {
"enum": [
"Unknown",
"Created",
"Changed",
"SortBoxesSynced",
"Deleted"
],
"type": "string"
},
"WallAuditLogWithDetails": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/WallAuditLogKind"
},
"userId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userColor": {
"$ref": "#/components/schemas/UserColor"
},
"wallId": {
"type": "integer",
"format": "int32"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WallAuditLogDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"WallBarcodeConfirmationStatsPerSlot": {
"type": "object",
"properties": {
"bySlotByUserColor": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Red": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Blue": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Yellow": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Green": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Cyan": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
},
"Magenta": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"additionalProperties": false
},
"nullable": true
},
"byUserColorBySlot": {
"type": "object",
"properties": {
"Unknown": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Red": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Blue": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Yellow": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Green": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Cyan": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
},
"Magenta": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BarcodeConfirmationStats"
}
}
},
"additionalProperties": false,
"nullable": true
}
},
"additionalProperties": false
},
"WallBarcodeScanningStats": {
"type": "object",
"properties": {
"byKind": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false,
"nullable": true
},
"confirmations": {
"type": "integer",
"format": "int32"
},
"unitsSorted": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"WallBarcodeScanningStatsPerSlot": {
"type": "object",
"properties": {
"bySlotByUserColor": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Red": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Blue": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Yellow": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Green": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Cyan": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Magenta": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"nullable": true
},
"byUserColorBySlot": {
"type": "object",
"properties": {
"Unknown": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Red": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Blue": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Yellow": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Green": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Cyan": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"Magenta": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Unknown": {
"type": "integer",
"format": "int32"
},
"Canceled": {
"type": "integer",
"format": "int32"
},
"PendingConfirmation": {
"type": "integer",
"format": "int32"
},
"Confirmed": {
"type": "integer",
"format": "int32"
},
"InvalidBarcodeScanned": {
"type": "integer",
"format": "int32"
},
"NoOrderFoundForBarcode": {
"type": "integer",
"format": "int32"
},
"ExistingBoxGotAnotherProductMeanwhile": {
"type": "integer",
"format": "int32"
},
"ExistingPendingScan": {
"type": "integer",
"format": "int32"
},
"ExistingBoxOnAnotherWall": {
"type": "integer",
"format": "int32"
},
"ExistingBoxContainsPendingItems": {
"type": "integer",
"format": "int32"
},
"NoBoxAvailableForOrder": {
"type": "integer",
"format": "int32"
},
"NoMatchingITF14Found": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"nullable": true
}
},
"additionalProperties": false
},
"WallHubDevice": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/WallHubDeviceStatus"
},
"brightness": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"WallHubDeviceStatus": {
"enum": [
"Unknown",
"Online",
"Offline",
"Error",
"NotConfigured"
],
"type": "string"
},
"WallRealTimeConnectSettings": {
"type": "object",
"properties": {
"shipBridgeMarkerId": {
"type": "string",
"nullable": true
},
"printerName": {
"type": "string",
"nullable": true
},
"printerIsThermal": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"WallRealTimeConnectSettingsRequest": {
"type": "object",
"properties": {
"shipBridgeMarkerId": {
"type": "string",
"nullable": true
},
"printerName": {
"type": "string",
"nullable": true
},
"printerIsThermal": {
"type": "boolean"
}
},
"additionalProperties": false
},
"WallSegmentShape": {
"type": "object",
"properties": {
"columns": {
"type": "integer",
"format": "int32"
},
"rows": {
"type": "integer",
"format": "int32"
},
"flowDirection": {
"$ref": "#/components/schemas/FlowDirection"
}
},
"additionalProperties": false
},
"WallWithSummary": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"version": {
"$ref": "#/components/schemas/SkubloxVersions"
},
"isActive": {
"type": "boolean"
},
"maxUserSessions": {
"type": "integer",
"format": "int32"
},
"displayOrder": {
"type": "integer",
"format": "int32"
},
"sortBoxes": {
"type": "integer",
"format": "int32",
"nullable": true
},
"segmentShape": {
"$ref": "#/components/schemas/WallSegmentShape"
},
"warehouse": {
"$ref": "#/components/schemas/Warehouse"
},
"workflow": {
"$ref": "#/components/schemas/WallWorkflow"
},
"hubDevice": {
"$ref": "#/components/schemas/WallHubDevice"
},
"realTimeConnectSettings": {
"$ref": "#/components/schemas/WallRealTimeConnectSettings"
}
},
"additionalProperties": false
},
"WallWorkflow": {
"enum": [
"PutToLight",
"PickToLight",
"AdHoc"
],
"type": "string"
},
"Warehouse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/WarehouseType"
},
"isDefault": {
"type": "boolean"
},
"isBinEnabled": {
"type": "boolean"
},
"isSellable": {
"type": "boolean"
},
"isDisabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"WarehouseType": {
"enum": [
"Normal",
"Fba",
"Untested",
"Interim",
"DropShip",
"NewEgg",
"Cdiscount",
"Wfs"
],
"type": "string"
},
"WarehouseWithWalls": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/WarehouseType"
},
"isDefault": {
"type": "boolean"
},
"isBinEnabled": {
"type": "boolean"
},
"isSellable": {
"type": "boolean"
},
"isDisabled": {
"type": "boolean"
},
"walls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Wall"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}